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 ACTIVE status.
• The card must be in an ACTIVE or LOCKED state.

The following controls are returned (subject to implementation of the core banking system) indicating if the control is enabled or disabled:

• DOMESTIC_ONLINE_PURCHASES: This value allows a party to enable or disable domestic online purchases with the nominated card.
• INTERNATIONAL_ONLINE_PURCHASES: This value allows a party to enable or disable international online purchases with the nominated card.
• DOMESTIC_MOBILE_WALLET_PURCHASES: This value allows a 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: This value allows a party to enable or disable international mobile wallet purchases with the nominated card (Apple or Google depending on the core implementation).
• DOMESTIC_ATM_WITHDRAWAL: This value allows a party to enable or disable domestic ATM cash withdrawals with the nominated card.
• INTERNATIONAL_ATM_WITHDRAWAL: This value allows a party to enable or disable international ATM cash withdrawals with the nominated card.
• DOMESTIC_PHYSICAL_PURCHASES: This value allows a party to enable or disable domestic physical purchases with the nominated card.
• INTERNATIONAL_PHYSICAL_PURCHASES: This value allows a party to enable or disable international physical purchases with the nominated card.
• DOMESTIC_TAP_GO: This value allows a party to enable or disable domestic tap and go (NFC chip) purchases with the nominated card.
• INTERNATIONAL_TAP_GO: This value allows a 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

Successfully retrieved card transaction settings for the specified card

400

Schema validation failed (GEN000000)

401

Missing or invalid authentication token (GEN001002)

403

Forbidden (CAR003003)

404

Party not found (PAR004001) or Card not found (CAR004001)

500

Internal server error (GEN100000) or Service error (GEN100001)