Tokenize payment method

Saves a payment method for reuse. This call exchanges sensitive payment information for a token that can be used to process future transactions. The ReferenceId value in the response is the storedMethodId to use with transactions.

Headers

requestTokenstringRequired
idempotencyKeystringOptional

Optional but recommended A unique ID that you can include to prevent duplicating objects or transactions in the case that a request is sent more than once. This key is not generated in Payabli, you must generate it yourself.

Query parameters

achValidationbooleanOptional

When true, enables real-time validation of ACH account and routing numbers. This is an add-on feature, contact Payabli for more information.

createAnonymousbooleanOptional

When true, creates a saved method with no associated customer information. The token will be associated with customer information the first time it’s used to make a payment. Defaults to false.

forceCustomerCreationbooleanOptional

When true, the request creates a new customer record, regardless of whether customer identifiers match an existing customer. Defaults to false.

temporarybooleanOptional

Creates a temporary, one-time-use token for the payment method that expires in 12 hours. Defaults to false.

Request

This endpoint expects an object.
customerDataobjectOptional

Object describing the Customer/Payor owner of payment method. Required for POST requests. Which fields are required depends on the paypoint’s custom identifier settings. See PayorData Object Model for a complete reference.

entryPointstringOptional<=50 characters

Entrypoint identifier. Required for POST requests.

fallbackAuthbooleanOptionalDefaults to false

When true, if tokenization fails, Payabli will attempt an authorization transaction to request a permanent token for the card. If the authorization is successful, the card will be tokenized and the authorization will be voided automatically.

fallbackAuthAmountintegerOptionalDefaults to 100

The amount for the fallbackAuth transaction. Defaults to one dollar (100).

methodDescriptionstringOptional

Custom description for stored payment method.

paymentMethodobjectOptional

Information about the payment method for the transaction.

sourcestringOptional<=100 characters

Custom identifier to indicate the source for the request

subdomainstringOptional<=50 characters

Refers to the payment page identifier. If provided, then the transaction is linked to the payment page.

Response

Success

isSuccessbooleanOptional

Boolean indicating whether the operation was successful. A true value indicates success. A false value indicates failure.

responseDataobjectOptional
responseTextstringOptional

Response text for operation: ‘Success’ or ‘Declined’.

Errors