Retrieve Card Transaction Control Settings
GET/v1/cards/:cardId/transaction-settings
This operation retrieves the transaction controls applied to the nominated card instance.
Pre-requisites:
- The party must have an
ACTIVEstatus. - The card must be in an
ACTIVEorLOCKEDstate.
The following controls are returned (subject to implementation of the core banking system) indicating if the control is enabled or disabled:
DOMESTIC_ONLINE_PURCHASES: Allows the party to enable or disable domestic online purchases with the nominated card.INTERNATIONAL_ONLINE_PURCHASES: Allows the party to enable or disable international online purchases with the nominated card.DOMESTIC_MOBILE_WALLET_PURCHASES: Allows the party to enable or disable domestic mobile wallet purchases with the nominated card (Apple or Google depending on the core implementation).INTERNATIONAL_MOBILE_WALLET_PURCHASES: Allows the party to enable or disable international mobile wallet purchases with the nominated card (Apple or Google depending on the core implementation).DOMESTIC_ATM_WITHDRAWAL: Allows the party to enable or disable domestic ATM cash withdrawals with the nominated card.INTERNATIONAL_ATM_WITHDRAWAL: Allows the party to enable or disable international ATM cash withdrawals with the nominated card.DOMESTIC_PHYSICAL_PURCHASES: Allows the party to enable or disable domestic physical purchases with the nominated card.INTERNATIONAL_PHYSICAL_PURCHASES: Allows the party to enable or disable international physical purchases with the nominated card.DOMESTIC_TAP_GO: Allows the party to enable or disable domestic tap and go (NFC chip) purchases with the nominated card.INTERNATIONAL_TAP_GO: Allows the party to enable or disable international tap and go (NFC chip) purchases with the nominated card.
The response structure should contain an array of controls with the feature and enabled flag. As few or all controls can be toggled as required in a singular request.
Request
Responses
- 200
- 400
- 401
- 403
- 404
- 500
- 503
Successfully retrieved card transaction settings for the specified card
Schema validation failed (GEN000000) or Invalid card control (CAR000004) or Duplicated card control (CAR000005) or Invalid tap and go settings (CAR000006)
Missing or invalid authentication token (GEN001002) or Role unauthorized (GEN001006) or Tenant context could not be resolved (AUT001001)
External application access denied (AUT003001) or Party not in required status (PAR003001)
No open binding for the card (CRT004005) or Card not found (CAR004001) or Account not found (CAR004004)
Internal server error (CAR100001) or Core banking error (CAR100002) or General internal server error (GEN100000) or Service error (GEN100001)
All connector targets are currently unhealthy (CRT103001)