Retrieve a Card | American Express Developers

{
  "cardId": "CAEQd4zBEYrPi56",
  "accountId": "CR6gVOF5QgCqunZ",
  "spendControls": {
    "currentAmount": "200.00",
    "validFromDate": "2024-01-01",
    "validToDate": "2024-06-01",
    "spendType": "SINGLE_USE",
    "originalAmount": "300.00",
    "cardCurrency": "USD",
    "timeZone": "MST",
    "allowedMerchantIndustries": [
      "4121",
      "4722"
    ],
    "allowedMerchant": [
      "1042721514",
      "1043439983"
    ],
    "chargeAmountVariance": {
      "varianceType": "PERCENTAGE",
      "varianceLowerBound": "100",
      "varianceUpperBound": "100",
      "minimumAuthorizationAmount": "300.00",
      "autoExpirePercent": "20",
      "autoExpireAmount": "2.00"
    }
  },
  "cardDetails": {
    "cardLastFive": "56789",
    "expiryDate": "02-22",
    "formFactor": "VIRTUAL",
    "cardReferenceId": "PO12345-AB7890",
    "cardCreationDate": "2016-12-13",
    "status": "ACTIVE",
    "cardModifiedDate": "2016-12-13",
    "digitalWalletProvisionable": false,
    "digitalWalletProvisioned": [
      "Apple Pay",
      "Google Pay"
    ]
  },
  "deliveryMethod": "API_RESPONSE",
  "cardUserId": "123456",
  "reloadable": false,
  "reconciliationField": {
    "userDefinedFields": [
      {
        "index": "1",
        "value": "test"
      }
    ],
    "accountingFields": [
      {
        "index": "1",
        "value": "test"
      }
    ]
  }
}

Return the details of a specific Card. If the Card status is IN_PROGRESS, only the cardId, the accountId, and the status fields will be returned.

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.

Response headers

Content-TypestringOptional

application/json

Request-IdstringOptional

The unique ID for the API request.

Response

Successful operation

cardIdstring<=19 characters

A unique ID that is created for the Card.

accountIdstring<=36 characters

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

spendControlsobject

The Spend Control object determines how, when, and where on-demand cards can be authorized.

cardDetailsobject

The details of the Card being retrieved.

deliveryMethodenum

The method of delivery that is used for the response.

Allowed values:

cardUserIdstringOptional<=38 characters

The ID of the Card User associated with the Card.

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.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error

503

Service Unavailable Error