Sign in

v1

latestOpenAPI 3.0.32026-07-2455445.8 KB
Checkout Session

Complete Session

This API closes the Merchant and consumer sessions (where applicable) and provides a payment identifier and, if requested, the card details required to successfully process the Payment transaction.If both Merchant and consumer sessions have timed out without receiving a valid input, Complete should not be invoked. If it is invoked, Merchants will receive a 422 Not Found error.The Merchant must incorporate a card-on-file consent check into their own digital property if they intend to use that functionality in Complete. Card networks handle card-on-file functionality in different ways. Refer to individual card networks' documentation for clarification and the most up-to-date guidance. Visa allows Merchants or their payment service providers to perform a token-for-token swap with a previous payment token. This means that, if the transaction type is BOTH, the dynamic data for CARD_ON_FILE will be identical to the dynamic data for PURCHASE. Mastercard has separate tokenization protocols for purchases and cards-on-file. This means that, if the transaction type is BOTH, the dynamic data will vary and need to be handled differently between PURCHASE and CARD_ON_FILE use cases. Discover does not support card-on-file functionality. Only PURCHASE is supported for Discover cards.

post/v1/checkout/sessions/complete

Request body

clientContextstring

Customer-defined transaction identifier, reflected in response. Referred to as “sessionId” in web integration. Session reference identifier generated by the Merchant. If present here, it will be returned in the Checkout response. This is recommended to be identical across the Checkout request and the /wallets/sessions/checkout/complete request.

Response

Successfully received complete call for transaction

clientContextstring
ewSIDstring required

Globally unique identifier generated by Early Warning. Returned in the response message in response to the initial request. This identifier ties all information about the session together and should be easily accessible by customer staff submitting support requests to Early Warning. Character set a-f, 0-9, -.

timestampISO8601string date-time required

Timestamp of message in ISO8601 extended combined format. Format: {YYYY}-{MM|-{DD}T{HH}:{MM}:{SS}Z Example: 2015-12-31T17:18Z Time stamp when response is sent by the Service Operator Services.