SchemaPaymentsSingle Use Tokens

Create single use token

Create a single-use token. The token expires after 30 minutes.

Path parameters

processingTerminalIdstringRequired>=4 characters<=50 characters

Unique identifier that our gateway assigned to the terminal.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Idempotency-KeystringRequired

Unique identifier that you generate for each request. You must use the UUID v4 format for the identifier. For more information about the idempotency key, go to Idempotency.

Request

This endpoint expects an object.
channelenumRequired

Channel that the merchant used to receive the payment details.

Allowed values:
sourceobjectRequired

Object that contains information about the payment method to tokenize.

operatorstringOptional>=1 character<=50 characters

Operator who initiated the request.

Response

Successful request. We created the single-use token.

processingTerminalIdstring>=4 characters<=50 characters

Unique identifier that we assigned to the terminal.

tokenstring=128 characters

Unique identifier that our gateway assigned to the payment details.
Note: Merchants can use the token with other terminals linked to their account.

expiresAtstringformat: "date-time"

Date and time that the token expires. We return this value in the ISO 8601 format.

sourceobject

Object that contains information about the payment method that we tokenized.

operatorstringOptional>=0 characters<=50 characters

Operator who initiated the request.

paymentMethodobjectOptional

Object that contains information about the customer’s payment details.