Retrieve secure token
Return a secure token and its related payment details.
Path parameters
processingTerminalId
Unique identifier that we assigned to the terminal.
secureTokenId
Unique identifier that the merchant assigned to the secure token.
Headers
Authorization
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.
secureTokenId
Unique identifier that the merchant created for the secure token that represents the customer's payment details.
processingTerminalId
Unique identifier that we assigned to the terminal.
source
Object that contains information about the payment method that we tokenized.
token
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
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.
mitAgreement
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:
customer
Object that contains the customer's contact details and address information.
customFields
Array of customField objects.