Card Control Overrides

The Card Control override APIs enable you to view and update the controls for a card. These controls set the rules on what a card can and cannot do.

There are five controls you can set for a card:

  • Allow Contactless, if true, enables contactless transactions on the card
  • Allow ATM Withdrawals, if true, enables withdrawals from an ATM machine on the card
  • All eCommerce where the card is not present, if true, enables the card to have a blank CVV2 for online commerce
  • All recurring payments where the card is not present, if true, enable the card to have a blank CVV2 for recurring payments
  • All use outside of the country, if true, enables the card to be used outside the country of issue

Get Card Control Overrides

The Get Card Control Overrides endpoint allows you to list all of the overrides for a card. You can retrieve the card control overrides list by making a GET request to the allow merchant endpoint. For example:

{{base-url}}/cards/{{publicToken}}/controloverrides

A successful response will return a HTTP 200 response code with the current override status for the card's control overrides. Below is an example response:

{
    "allowContactless": true,
    "allowAtmWithdrawals": null,
    "allowECommerceWhereCardNotPresent": null,
    "allowRecurringPaymentWhereCardNotPresent": null,
    "allowUseOutsideCountry": null
}

👍

API Explorer

See the Get the Card Control Overrides endpoint.

Update Card Control Overrides

The Update Card Control Overrides endpoint allows you to update one or many card control overrides in one request. You can do this by making a PUT request to the Update Card Control Overrides endpoint. For example:

{{base-url}}/cards/{{publicToken}}/controloverrides

The body should contain the overrides that you want to update as part of the request. If the override isn't included in the the body then it will keep the same value it had previously. An example body can be found below.

{
     "usageControls": {
          "allowContactless": true
     }
}

This example will return the following HTTP 200 response:

{
    "allowContactless": true,
    "allowAtmWithdrawals": null,
    "allowECommerceWhereCardNotPresent": null,
    "allowRecurringPaymentWhereCardNotPresent": null,
    "allowUseOutsideCountry": null
}

👍

API Explorer

See the Update the Card Control Overrides endpoint.

Get Card Control Overrides or Defaults

The Get Card Control Overrides or Defaults endpoint enables you to compare a card's control override settings with the default values. This allows you to directly compare the card's endpoints with the default values to see how they differ.

You can get a card's control overrides by making a GET request to the endpoint. For example:

https://cardsapi-uat-pub.globalprocessing.net/api/v1/cards/{publicToken}/controls

If successful, a 200 response is returned with each of the different overrides with details on the card's current override value and whether the card value has been overridden. For example:

{
  "usageControls": {
    "allowContactless": {
        "value": true,
        "isOverridden": false
    },
    "allowAtmWithdrawals": {
        "value": true,
        "isOverridden": true
    },
    "allowECommerceWhereCardNotPresent": {
        "value": true,
        "isOverridden": false
    },
    "allowRecurringPaymentWhereCardNotPresent": {
        "value": false,
        "isOverridden": false
    },
    "allowUseOutsideCountry": {
        "value": true,
        "isOverridden": false
    },
  }
}

👍

API Explorer

See the Get Card Control Overrides or Defaults endpoint.