Create a Card | American Express Developers

curl -X POST https://api.qasb2s.americanexpress.com/commercial/v1/card_on_demand/cards \
     -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",
      "minimumAuthorizationAmount": "300.00",
      "autoExpirePercent": "20",
      "autoExpireAmount": "2.00"
    }
  },
  "cardDetails": {
    "formFactor": "VIRTUAL",
    "cardReferenceId": "PO12345-AB7890",
    "digitalWalletProvisionable": false
  },
  "deliveryMethod": "API_RESPONSE",
  "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"
    }
  },
  "cardUserId": "123456",
  "reloadable": false,
  "reconciliationField": {
    "userDefinedFields": [
      {
        "index": "1",
        "value": "test"
      }
    ],
    "accountingFields": [
      {
        "index": "1",
        "value": "test"
      }
    ]
  }
}'

{
  "cardId": "CAEQd4zBEYrPi56",
  "status": "IN_PROGRESS",
  "card": {
    "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",
        "minimumAuthorizationAmount": "300.00",
        "autoExpirePercent": "20",
        "autoExpireAmount": "2.00"
      }
    },
    "cardDetails": {
      "formFactor": "VIRTUAL",
      "cardReferenceId": "PO12345-AB7890",
      "digitalWalletProvisionable": false
    },
    "deliveryMethod": "API_RESPONSE",
    "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"
      }
    },
    "cardUserId": "123456",
    "reloadable": false,
    "reconciliationField": {
      "userDefinedFields": [
        {
          "index": "1",
          "value": "test"
        }
      ],
      "accountingFields": [
        {
          "index": "1",
          "value": "test"
        }
      ]
    }
  }
}

An on-demand Card is generated from the funding Account enrolled in Card on-demand. A Card can be used by the Account owner of the funding Account, by a Card User, or sent to a supplier for a business payment. Each Card has an expiration date that is automatically set for five years from the date the Card is created. This expiration date is different from the validToDate that is defined in the spendControls object of a Card.

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.

accountIdstringRequired<=15 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. If OPTIONAL fields are unpopulated in a POST /cards call, their value will be defaulted to those defined during the initial configuration set up.

cardDetailsobjectRequired

The details of the Card being created.

deliveryMethodenumRequired

The method of delivery that is used for the response.

Allowed values:

userDetailsobjectRequired

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

cardUserIdstringOptional<=38 characters

The ID of the Card User associated with the Card. The Card User must be in an ACTIVATED status.

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

cardIdstring<=19 characters

A unique ID that is created for the Card.

statusenum

The status of the Card. For all Card creation requests, this will always be IN_PROGRESS.

Allowed values:

cardobject

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