Get Expected Spend Amount

get/api/accounts/{cardholderId}/expected-spend-amount

Get the expected spend amount for the given cardholder.

Request

Path Parameters

cardholderIdstringrequired
The ID of the cardholder.

Response

Successful operation.

Body application/json

cardholderIdstring
The ID of the cardholder.
expectedSpendAmountstring
The expected spend amount for the cardholder in USD cents.

User is not allowed to perform the action with the reason stated in the errorCode.

FORBIDDEN Insufficient permissions to perform the action.

Example

Example Request

ServerAuthentication

curl 'https://api.immersve.com/api/accounts/{cardholderId}/expected-spend-amount' \
  --header 'Authorization: Bearer <access-token>'

curl 'https://api.immersve.com/api/accounts/{cardholderId}/expected-spend-amount' \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-Api-Secret: <api-secret>' \
  --header 'X-Account-Id: <target-account>'

curl 'https://test.immersve.com/api/accounts/{cardholderId}/expected-spend-amount' \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-Api-Secret: <api-secret>' \
  --header 'X-Account-Id: <target-account>'

Example Response

{
  "cardholderId": "057aa15913a57f50577234c8426534c0",
  "expectedSpendAmount": "200000"
}