Skip to main content

Update Card Transaction Settings

PATCH 
/v1/cards/:cardId/transaction-settings

This operation updates the transaction controls applied to the nominated card instance.

Pre-requisutes:

  • The party must have an ACTIVE status.
  • The card must be in an ACTIVE or LOCKED state.

The following controls are available (subject to implementation of the core banking system) and can be toggled on or off:

  • 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 request 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. The response will return a 204 status code if the operation is successful.

Business Rule: Duplicate feature keys in the controls array are rejected.

A subsequent call to getCardTransactionSettings will return the current set of toggle values applied. Where a value is not present, the default value of false will be applied.

Request​

Responses​

Successfully updated card transaction settings

Last updated on