secureTokens

Retrieve secure token

Changed on

Use this method to retrieve information about a secure token.

To retrieve a secure token, you need its secureTokenID, which you sent in the request of the Create Secure Token method.

Note: If you don't have the secureTokenId, use our List Secure Tokens method to search for the secure token.

Our gateway returns the following information about the secure token:

  • Payment details that the secure token represents.
  • Customer details, including shipping and billing addresses.
  • Secure token that you can use to carry out transactions.
get/processing-terminals/{processingTerminalId}/secure-tokens/{secureTokenId}

Request

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

Path parameters

processingTerminalIdstring required

Unique identifier that we assigned to the terminal.

secureTokenIdstring required

Unique identifier that the merchant assigned to the secure token.

Response

Successful request. Returns the secure token and its related 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

  • 9fc1e1d5b4a8Revision changes
    • warning

      deleted the header request parameter Authorization

    • info

      the endpoint scheme security Bearer was added to the API