SchemaPaymentsSingle Use Tokens

Create single use token

Use this method to create a single-use token that represents a customer’s payment details. A single-use token expires after 30 minutes and merchants can use them only once. **Note:** To create a reusable permanent token, go to [Create Secure Token](https://docs.payroc.com/api/schema/payments/secure-tokens/create). In the request, send the customer’s payment details. If the request is successful, our gateway returns a token that you can use in a follow-on action, for example, [run a sale](https://docs.payroc.com/api/schema/payments/create).

Authentication

AuthorizationBearer

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

Path parameters

processingTerminalIdstringRequired>=4 characters<=50 characters
Unique identifier that our gateway assigned to the terminal.

Headers

Idempotency-KeystringRequiredformat: "uuid"
Unique identifier that you generate for each request. You must use the [UUID v4 format](https://www.rfc-editor.org/rfc/rfc4122) for the identifier. For more information about the idempotency key, go to [Idempotency](https://docs.payroc.com/api/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.

expiresAtdatetime
Date and time that the token expires. We return this value in the [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
sourceobject
Object that contains information about the payment method that we tokenized.

Errors