singleUseTokens

Create single use token

Changed on

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.

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.

post/processing-terminals/{processingTerminalId}/single-use-tokens

Request

  • Base URL
    https://api.payroc.com/v1
  • URL
    https://api.payroc.com/v1/processing-terminals/{processingTerminalId}/single-use-tokens
  • Auth
    HTTP bearer

Path parameters

processingTerminalIdstring required

Unique identifier that our gateway assigned to the terminal.

Headers

Idempotency-Keystring uuid required

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 body

channel'pos' | 'web' | 'moto' required

Channel that the merchant used to receive the payment details.

operatorstring

Operator who initiated the request.

Response

Successful request. We created the single-use token.

processingTerminalIdstring required

Unique identifier that we assigned to the terminal.

operatorstring

Operator who initiated the request.

tokenstring required

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

expiresAtstring date-time required

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

Changes