GET/api/v2/cards/{cardId}/auto-topup

Get all auto top-up settings and current UTC-month usage for a user's card.

Authentication

Send your API key in the x-api-key header on every request.

Parameters

Request parameters
FieldTypeRequiredDescription
cardId (path)integer (int32)Yes
userId (query)unknownYes

Responses

200 — OK

Response 200 fields
FieldTypeRequiredDescription
SuccessbooleanNo
MessagestringNo
CardIdunknownNo
LowBalanceEnabledbooleanNo
WatermarkunknownNo
TargetBalanceunknownNo
LowBalanceMonthlyLimitunknownNo
LowBalanceDisclaimerAcceptedbooleanNo
LowBalanceDisclaimerAcceptedAtstring (date-time)No
FailedTxEnabledbooleanNo
FailedTxMaxAmountunknownNo
FailedTxMonthlyLimitunknownNo
FailedTxDisclaimerAcceptedbooleanNo
FailedTxDisclaimerAcceptedAtstring (date-time)No
DepositEnabledbooleanNo
DepositSettingsarray of PublicDepositAutoTopUpSettingResponseNo
AssignedDepositCurrenciesarray of PublicDepositCurrencyAssignmentNo
LowBalanceUsedThisMonthunknownNo
FailedTxUsedThisMonthunknownNo

400 — Bad Request

Response 400 fields
FieldTypeRequiredDescription
MessagestringNo
CodestringNo
StatusunknownNo
ValidationErrorsobjectNo
DetailsstringNo

401 — Unauthorized

Response 401 fields
FieldTypeRequiredDescription
MessagestringNo
CodestringNo
StatusunknownNo
ValidationErrorsobjectNo
DetailsstringNo

403 — Forbidden

Response 403 fields
FieldTypeRequiredDescription
typestringNo
titlestringNo
statusunknownNo
detailstringNo
instancestringNo

404 — Not Found

Response 404 fields
FieldTypeRequiredDescription
MessagestringNo
CodestringNo
StatusunknownNo
ValidationErrorsobjectNo
DetailsstringNo

500 — Internal Server Error

Response 500 fields
FieldTypeRequiredDescription
MessagestringNo
CodestringNo
StatusunknownNo
ValidationErrorsobjectNo
DetailsstringNo

Example request

curl -X GET "https://{base_url}/api/v2/cards/{cardId}/auto-topup" \
  -H "x-api-key: YOUR_API_KEY"

This page is generated from the live OpenAPI specification and always matches the current API.