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 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.

Body Params

Request Body

string
length ≤ 64

Customer-defined transaction identifier, reflected in the response and referred to as “sessionId” in web integration.

The session reference identifier is generated by the Merchant. If present here, it is returned in the Checkout response. It is recommended to be identical across the Checkout request.

data
object
required

Payload containing all fields that can be passed to this API.

Responses

Language
Credentials
OAuth2
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Terms / Privacy ©2025 Early Warning Services, LLC. All rights reserved.