Skip to navigation

The outbound token state change notification.

This endpoint is an extension of the /notifications endpoint that alerts the Token Requester when the state of the Token is changed by American Express. The request schema provided here is meant to indicate the format of an outbound request sent by American Express. These outbound requests are sent by American Express to the Token Requester who provisioned the token.

Authentication

Authorizationstring

HMAC (one-way TLS). A MAC authorization header signed with your client secret. See https://developer.americanexpress.com/documentation/api-security/hmac

Request

This endpoint expects an object.
token_ref_idstringOptional<=64 characters

The unique reference identifier for a token.

NOTE: This data needs to be stored by the Token Requester for the life cycle API calls, such as /notifications, /status, and /metadata.

notification_typestringOptional<=128 characters

The desired end state of the token specified by the token_ref_id field in the request.

The allowed value for outbound notifications are resume, suspend, delete, and metadataupdate.

metadataupdateobjectOptional

Applicable only when American Express calls the Token Requester. The object is present if the notification_type field is set to metadataupdate.

Response

The outbound notification was successfully received and processed by the Token Requester. The contents of the response headers and body are at the discretion of the Token Requester that receives the outbound request.