Step 2 of Pay with Points - Complete transaction
POST /loyalty/v2/paywithpoints/redemption will complete the Pay with Points transaction. To complete the transaction, you will supply:
- Points Selection: Specifying the number of the Points selected by the Card Member as payment.
- Amount Information: Providing amount for selected points.
Critical Note: To ensure the best experience to Card Members, the expected behavior of the system for all scenarios in which a 500, timeout (or other non-specified error) is received when submitting the POST /loyalty/v2/paywithpoints/redemption update, is for the Card Member to receive a message indicating a successful completion of Pay with Points. The error condition must then be resolved asynchronously to any remaining purchase process.
Example: The current basket’s checkout process should complete as though everything was successful, while a retry to Pay with Points is made in the background.
If Pay with Points is unable to be completed, a notification will be sent by the American Express to the Card Member.
Authentication
OAuth 2.0 client credentials. Exchange your API key and secret for a bearer token, then send it as Authorization: Bearer <token>.
Headers
A unique Consumer Developer key for Enterprise Web Proxy authentication. Please see the API key, https://developer.americanexpress.com/documentation#api-key
The OAuth2 Bearer token that the API Consumer use to gain access to the American Express API. The value provided here is the response of the Access Token API.
Merchant Identification Code: This is a unique ID assigned to each Merchant when onboarding to the Pay with Points program.
Note: You will be able to access the client_id from your Application Keys when moving to both the Sandbox and Production environments. A standard Sandbox key is available within the Test Data section below.
A unique ID generated by the Merchant for each /loyalty/v2/paywithpoints/eligibility. The scope of uniqueness is limited to the Merchant.
The same message_id should never be re-used across different transactions.
The numeric geographical code (geocode) to represent country and dependent areas
The channel from which the redemption transaction originated. Used for reporting and analytics purposes only.
Request
The consumer can use any of the following types of identification methods for this API.
A generic object for any amount that is related to a specific transaction.
Note: It is mandatory in case of Single-step scenario.
The number of Points the Card Member has approved to be used toward the purchase.
The message_id header value received in the request.
A unique transaction identifier for the Card charge.
The type of the transaction for the Card charge.
A generic object for any amount that is related to a specific transaction.
Note: It is mandatory in case of Single-step scenario.
The points conversion rate.
The Merchant Store Number if applicable.
Note: This field is applicable only for non-USA market partners. The partners can choose to send this field, but it is not required.
This field is non-applicable for USA market partners.
The Merchant Name if applicable.
Note: This field is applicable only for non-USA market partners. The partners can choose to send this field, but it is not required.
This field is non-applicable for USA market partners.
The Merchant pricing code passed in request. This is configured by the American Express and shared to the Partner at the time of onboarding.
Note: This field is mandatory only for non-USA market partners.
This field is non-mandatory for USA market partners.
Depending on the terms of your agreement in participating with Pay with Points, the cid, exp_month, and exp_year properties may also be required.
Response
The internal transaction ID generated for the processing request.
The message_id header value received in the request.
The consumer can use any of the following types of identification methods for this API.
A unique transaction identifier for the Card charge.
The type of the transaction for the Card charge.
A generic object for any amount that is related to a specific transaction.
Note: It is mandatory in case of Single-step scenario.
The number of Points the Card Member has approved to be used toward the purchase.
The points conversion rate.
The Merchant Store Number if applicable.
Note: This field is applicable only for non-USA market partners. The partners can choose to send this field, but it is not required.
This field is non-applicable for USA market partners.
The Merchant Name if applicable.
Note: This field is applicable only for non-USA market partners. The partners can choose to send this field, but it is not required.
This field is non-applicable for USA market partners.
The Merchant pricing code passed in request. This is configured by the American Express and shared to the Partner at the time of onboarding.
Note: This field is mandatory only for non-USA market partners.
This field is non-mandatory for USA market partners.
This object embeds the reward program account information like current balance, tier code, reward unit, minimum and maximum dollar amount limits per transaction.