Retrieve Card Users' details | American Express Developers

{
  "notificationId": "NT1569277026178N9OPfrrqQ7F5HGmX0xFRE",
  "timeOfNotification": "2022-12-05T18:10:10+00:00",
  "notificationType": "CARD_USERS_PROCESSED",
  "referenceId": "4c695-25c6-480b-ab62-8720b4c9f",
  "cardUsers": {
    "createdRecords": [
      {
        "cardUserId": "123456",
        "status": "ACTIVATED",
        "emailAddress": "someone@example.com"
      }
    ],
    "failedRecords": [
      {
        "emailAddress": "someone@example.com",
        "failureReason": "An error occurred while creating a User."
      }
    ]
  }
}

Returns the details of a Card Users’ status updated notification.

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

notificationIdstringRequired

The unique ID for the notificationId.

Response headers

Content-TypestringOptional

application/json

Request-IdstringOptional

The unique ID for the API request.

Response

Successful operation

notificationIdstring

The ID of the notification.

timeOfNotificationstring

The timestamp of the notification in ISO 8601. The format is: yyyy-MM-ddThh:mm:ss+00:00.

notificationTypeenum

The type of the Card Users' notification.

Allowed values:

referenceIdstring<=50 characters

A unique identifier for each request to create Card Users in bulk (i.e., when the request has more than one Card User object). This ID is included in the API response for the POST request to help match the webhook notification with the API request.

cardUsersobject