tokenStorage

Save a payment method (tokenize)

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, and the methodId to use when you manage the saved payment method.

post/TokenStorage/add

Request

  • Base URL: https://api-sandbox.payabli.com/api
  • URL: https://api-sandbox.payabli.com/api/TokenStorage/add
  • Auth: HTTP bearer

Query parameters

achValidationboolean

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

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

createAnonymousboolean

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.

forceCustomerCreationboolean

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

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

temporaryboolean

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

Headers

idempotencyKeystring

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 isn't generated in Payabli; you must generate it yourself. The key persists for 2 minutes. After 2 minutes, you can reuse the key if needed.

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 isn't generated in Payabli, you must generate it yourself. This key persists for 2 minutes. After 2 minutes, you can reuse the key if needed.

Request body

entryPointstring

The entrypoint identifier.

fallbackAuthboolean

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.

fallbackAuthAmountinteger

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

methodDescriptionstring

Custom description for stored payment method.

sourcestring

Custom identifier to indicate the transaction or request source.

subdomainstring

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

Response

Success

isSuccessboolean

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

responseTextstring required

Response text for operation: 'Success' or 'Declined'.

pageIdentifierstring

Auxiliary validation used internally by payment pages and components.

Changes

No recorded changes to this operation across all 1 revision of this API.