Create Payment Method Token
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.
If you are converting a temporary token to a permanent token, note that the field is tokenId
in requests to this endpoint, not storedMethodId
.
Authorizations
Most endpoints require an organization
token. Some endpoints require an application
token, and those endpoints are noted.
Headers
A unique ID you can include to prevent duplicating objects or transactions if a request is sent more than once. This key is not generated in Payabli, you must generate it yourself.
"6B29FC40-CA47-1067-B31D-00DD010662DA"
Query Parameters
Creates a temporary, one-time-use token for the payment method that expires in 12 hours.
When true
, the request creates a new customer record, regardless of whether customer identifiers match an existing customer.
When true
, enables real-time validation of ACH account and routing numbers. This is an add-on feature, contact Payabli for more information.
"true"
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
.
true
Body
Entrypoint identifier. Required for POST requests.
50
"d193cf9a46"
Refers to the payment page identifier. If provided, then the transaction is linked to the payment page.
50
"mypage-1"
Custom identifier to indicate the source for the request
100
"api"
Custom description for stored payment method.
"My card"
Information about the payment method for the transaction.
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.
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.
false
The amount for the fallbackAuth
transaction. Defaults to one dollar.
150
Response
Boolean indicating whether the operation was successful. A true
value indicates success. A false
value indicates failure.
true
Response text for operation: 'Success' or 'Declined'.
"Success"
The object containing the response data.