SchemaPaymentsSecure Tokens

Retrieve secure token

Return a secure token and its related payment details.

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.

secureTokenIdstring>=0 characters<=200 characters

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

processingTerminalIdstring>=4 characters<=50 characters

Unique identifier that we assigned to the terminal.

sourceobject

Object that contains information about the payment method that we tokenized.

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.
statusenum

Status of the customer’s bank account. The processor performs a security check on the customer’s bank account and returns the status of the account.
Note: Depending on the merchant’s account settings, this feature may be unavailable.

mitAgreementenumOptional

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:
customerobjectOptional

Customer contact and address details.

customFieldslist of objectsOptional

Array of customField objects.