APIPay In endpointsPayment method tokens

Update tokenized payment method

View as MarkdownOpen in Claude
Updates a saved payment method.

Authentication

requestTokenstring
API Key authentication via header

Path parameters

methodIdstringRequired
The saved payment method ID.

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.

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.

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

Object describing the vendor owner of payment method. Required when saving an ACH payment method on behalf of a vendor (for Pay Out transactions).

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
responseTextstring

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

isSuccessboolean or null

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

responseDataobject or null