secureTokens

Create secure token

Changed on

Use this method to create a secure token that represents a customer's payment details.

When you create a secure token, you need to generate and provide a secureTokenId that you use to run follow-on actions:

Note: If you don't generate a secureTokenId to identify the token, our gateway generates a unique identifier and returns it in the response.

If the request is successful, our gateway returns a token that the merchant can use in transactions instead of the customer's sensitive payment details, for example, when they run a sale.

post/processing-terminals/{processingTerminalId}/secure-tokens

Request

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

Path parameters

processingTerminalIdstring required

Unique identifier that we 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

secureTokenIdstring

Unique identifier that you create for the secure token that represents the customer’s payment details.
Note: If you don't send a value for the secureTokenId, our gateway generates a unique identifier for the token.

operatorstring

Operator who saved the customer's payment details.

mitAgreement'unscheduled' | 'recurring' | 'installment'

Indicates how the merchant can use the customer's card details, as agreed by the customer:

  • unscheduled - Transactions for a fixed or variable amount that are run at a certain pre-defined event.
  • recurring - Transactions for a fixed amount that are run at regular intervals, for example, monthly. Recurring transactions don't have a fixed duration and run until the customer cancels the agreement.
  • installment - Transactions for a fixed amount that are run at regular intervals, for example, monthly. Installment transactions have a fixed duration.

Response

Successful request. We created a secure token that represents your customer's payment details.

secureTokenIdstring required

Unique identifier that the merchant created for the secure token that represents the customer's payment details.

processingTerminalIdstring required

Unique identifier that we assigned to the terminal.

mitAgreement'unscheduled' | 'recurring' | 'installment'

Indicates how the merchant can use the customer's card details, as agreed by the customer:

  • unscheduled - Transactions for a fixed or variable amount that are run at a certain pre-defined event.
  • recurring - Transactions for a fixed amount that are run at regular intervals, for example, monthly. Recurring transactions don't have a fixed duration and run until the customer cancels the agreement.
  • installment - Transactions for a fixed amount that are run at regular intervals, for example, monthly. Installment transactions have a fixed duration.
tokenstring required

Token that the merchant can use in future transactions to represent the customer's payment details. The token:

  • Begins with the six-digit identification number 296753.
  • Contains up to 12 digits.
  • Contains a single check digit that we calculate using the Luhn algorithm.
status'notValidated' | 'cvvValidated' | 'validationFailed' | 'issueNumberValidated' | 'cardNumberValidated' | 'bankAccountValidated' required

Outcome of a security check on the status of the customer's payment card or bank account.

Note: Depending on the merchant's account settings, this feature may be unavailable.

Changes

  • 817f57a896f3Revision changes
    • breaking

      the // response property's maxLength was increased from 100 to 255 for the response status

    • info

      the // request property's maxLength was increased from 100 to 255

  • 9fc1e1d5b4a8Revision changes
    • warning

      deleted the header request parameter Authorization

    • info

      the endpoint scheme security Bearer was added to the API