SchemaPaymentsSecure Tokens

Retrieve secure token

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.

Path parameters

processingTerminalIdstringRequired>=4 characters<=50 characters
Unique identifier that we assigned to the terminal.
secureTokenIdstringRequired>=1 character<=200 characters
Unique identifier that the merchant assigned to the secure token.

Headers

AuthorizationstringRequired

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

Response

Successful request. Returns the secure token and its related payment details.
processingTerminalIdstring>=4 characters<=50 characters
Unique identifier that we assigned to the terminal.
secureTokenIdstring>=0 characters<=200 characters
Unique identifier that the merchant created for the secure token that represents the customer's payment details.
statusenum

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.

tokenstring>=12 characters<=19 characters

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.
customFieldslist of objects or null
Array of customField objects.
customerobject or null
Object that contains the customer's contact details and address information.
mitAgreementenum or null

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.
Allowed values:
sourceobject or null
Object that contains information about the payment method that we tokenized.

Errors