Modify a Card | American Express Developers

curl -X PUT https://api.qasb2s.americanexpress.com/commercial/v1/card_on_demand/cards/CAEQd4zBEYrPi56 \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "accountId": "CR6gVOF5QgCqunZ",
  "spendControls": {
    "currentAmount": "200.00",
    "validFromDate": "2024-01-01",
    "validToDate": "2024-06-01",
    "spendType": "SINGLE_USE",
    "timeZone": "MST",
    "allowedMerchantIndustries": [
      "4121",
      "4722"
    ],
    "allowedMerchant": [
      "1042721514",
      "1043439983"
    ],
    "chargeAmountVariance": {
      "varianceType": "PERCENTAGE",
      "varianceLowerBound": "100",
      "varianceUpperBound": "100",
      "autoExpirePercent": "20",
      "autoExpireAmount": "2.00",
      "minmumAuthorizationAmount": "300.00"
    }
  },
  "userDetails": {
    "userId": "12345",
    "name": {
      "first": "John",
      "last": "Smith",
      "prefix": "Mr",
      "middle": "M"
    },
    "email": "someone@example.com",
    "phone": {
      "number": "5555551111",
      "extension": "01",
      "type": "MOBILE"
    },
    "ipAddress": "10.235.11.11",
    "deviceId": "D23232323",
    "sessionId": "lit3py55t21z5v55vlm25s55",
    "userAgent": {
      "webActionPath": "Mozilla/5.0 (Windows NT 6.1; WOW64; rv:12.0) Gecko/20100101 Firefox/12.0",
      "browserType": "FireFox",
      "browserVersion": "112.0.5615.49"
    }
  },
  "reloadable": false,
  "reconciliationField": {
    "userDefinedFields": [
      {
        "index": "1",
        "value": "test"
      }
    ],
    "accountingFields": [
      {
        "index": "1",
        "value": "test"
      }
    ]
  }
}'

{
  "status": "ACTIVE",
  "cardDetails": {
    "cardLastFive": "56789",
    "expiryDate": "02-22"
  },
  "card": {
    "spendControls": {
      "currentAmount": "200.00",
      "validFromDate": "2024-01-01",
      "validToDate": "2024-06-01",
      "spendType": "SINGLE_USE",
      "timeZone": "MST",
      "allowedMerchantIndustries": [
        "4121",
        "4722"
      ],
      "allowedMerchant": [
        "1042721514",
        "1043439983"
      ],
      "chargeAmountVariance": {
        "varianceType": "PERCENTAGE",
        "varianceLowerBound": "100",
        "varianceUpperBound": "100",
        "minimumAuthorizationAmount": "300.00",
        "autoExpirePercent": "20",
        "autoExpireAmount": "2.00"
      }
    },
    "userDetails": {
      "userId": "12345",
      "name": {
        "first": "John",
        "last": "Smith",
        "prefix": "Mr",
        "middle": "M"
      },
      "email": "someone@example.com",
      "phone": {
        "number": "5555551111",
        "extension": "01",
        "type": "MOBILE"
      },
      "ipAddress": "10.235.11.11",
      "deviceId": "D23232323",
      "sessionId": "lit3py55t21z5v55vlm25s55",
      "userAgent": {
        "webActionPath": "Mozilla/5.0 (Windows NT 6.1; WOW64; rv:12.0) Gecko/20100101 Firefox/12.0",
        "browserType": "FireFox",
        "browserVersion": "112.0.5615.49"
      }
    },
    "accountId": "CR6gVOF5QgCqunZ",
    "reloadable": false,
    "reconciliationField": {
      "userDefinedFields": [
        {
          "index": "1",
          "value": "test"
        }
      ],
      "accountingFields": [
        {
          "index": "1",
          "value": "test"
        }
      ]
    }
  }
}

Updates the details of an existing Card, including adding new Spend Controls after the original Spend Controls expire.

Authentication

AuthorizationBearer

OAuth 2.0 client credentials. Exchange your API key and secret for a bearer token, then send it as Authorization: Bearer <token>.

Path parameters

cardIdstringRequired<=19 characters

A unique ID that is created for the Card.

Request

This endpoint expects an object.

accountIdstringRequired<=36 characters

The ID of the Account being used to fund the Card.

spendControlsobjectRequired

The Spend Control object determines how, when, and where on-demand cards can be authorized. The cards in INACTIVE status do not have an existing Spend Control object. So, if OPTIONAL fields are unpopulated in a PUT /cards call for an INACTIVE Card, their value will be defaulted to those defined during the initial configuration set up.

userDetailsobjectRequired

This object is for the details of the user who is logged into your app when the request for modifying an on-demand Card is made. This information will support customer service and fraud mitigation by American Express.

reloadablebooleanOptional

Indicates whether the Card can be reloaded with a new Spend Control object after the original Spend Control either expires or is fully utilized.

reconciliationFieldobjectOptional

The information collected for reconciliation.

Response headers

Content-TypestringOptional

application/json

Request-IdstringOptional

The unique ID for the API request.

Response

Successful operation

statusenum

The status of the Card.

Allowed values:

cardDetailsobject

The details of the Card being updated.

cardobjectOptional

The Card request being returned.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error

503

Service Unavailable Error