Capture the outcome of the payment authorization for which the payment credentials were used

curl -X POST https://apisandboxm.americanexpress.com/payments/digital/v1/agentic-commerce/paymentcredentials/complete \
     -H "Authorization: Bearer <token>" \
     -H "agentId: agentId" \
     -H "trackingId: trackingId" \
     -H "Content-Type: application/json" \
     -d '{
  "authIdentifier": "string",
  "authStatus": "APPROVED",
  "tokenNumber": "string",
  "orderContext": {
    "allowPartialOrder": "YES",
    "currency": "string",
    "items": [
      {
        "brand": "string",
        "category": "string",
        "condition": "string",
        "currency": "string",
        "imageLink": "string",
        "isGiftCard": "YES",
        "isRecurBill": "YES",
        "isRefundable": "YES",
        "itemId": "string",
        "merchantId": 0,
        "metadata": {
          "property1": "string",
          "property2": "string"
        },
        "name": "string",
        "purchaseCriteria": {
          "0": {
            "currency": "string",
            "dependentItems": {
              "0": {
                "dependentItemId": "string"
              }
            },
            "fromDate": "2019-08-24T14:15:22Z",
            "isShippingIncluded": "YES",
            "maxAmount": "string",
            "minAmount": "string",
            "pricePreference": "MINIMUM_PRICE",
            "toDate": "2019-08-24T14:15:22Z",
            "type": "PRICE"
          }
        },
        "quantity": 0,
        "unitAmount": "string"
      }
    ],
    "merchants": [
      {
        "categoryName": "string",
        "merchantId": 0,
        "metadata": {
          "property1": "string",
          "property2": "string"
        },
        "name": "string",
        "policies": {
          "returnPolicy": "string",
          "returnWindow": "string",
          "termsOfService": "string"
        },
        "seNumber": "string",
        "sellerId": "string",
        "url": "string"
      }
    ],
    "orderId": "string",
    "totalAmount": "string",
    "type": "INTENT"
  }
}'

Provides acknowledgement from the Partner when the payment authorization is decisioned.

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

A request to provide the outcome of a payment authorization. The request payload is JWE-encrypted on the wire.

authIdentifierstringRequired

A unique identifier for the authorization request.

authStatusenumRequired

The authorization outcome for the request.

Allowed values:

tokenNumberstringRequiredformat: "^[0-9]{15}$"

The tokenized account number used for the transaction.

orderContextobjectOptional

The order details associated with the authorization. Required when input is tokenNumber.

Response

Successful response

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error

422

Unprocessable Entity Error

500

Internal Server Error

Authentication

Headers

Request

Response

Errors