Skip to navigation
APIPay In endpointsLegacy endpoints (deprecated)

Authorize transaction

Deprecated
View as MarkdownOpen in Claude

This endpoint is deprecated. New integrations should use the Authorize endpoint, then capture, void, or refund the resulting transaction with the corresponding endpoints. Transactions created with this legacy endpoint must be managed with the legacy lifecycle endpoints — they aren’t interchangeable with the current ones.

Authorize a card transaction. This returns an authorization code and reserves funds for the merchant. Authorized transactions aren’t flagged for settlement until captured.

Only card transactions can be authorized. This endpoint can’t be used for ACH transactions.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

OR
requestTokenstring

Long-lived API token sent in the requestToken header. See API token authentication.

Headers

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

Query parameters

forceCustomerCreationbooleanOptional

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

Request

This endpoint expects an object.
paymentDetailsobjectRequired
Object describing details of the payment. Required.
paymentMethodobjectRequired
Information about the payment method for the transaction. Required and recommended fields for each payment method type are described in each schema below.
accountIdstringOptional
Custom identifier for payment connector.
customerDataobjectOptional

Object describing the Customer/Payor. Which fields are required depends on the paypoint's custom identifier settings.

entryPointstringOptional<=50 characters
The entrypoint identifier.
invoiceDataobjectOptional
Object describing an Invoice linked to the transaction.
ipaddressstringOptional
The IP address associated with the transaction.
orderDescriptionstringOptional<=250 characters
Text description of the transaction.
orderIdstringOptional<=250 characters
Custom identifier for the transaction.
sourcestringOptional<=100 characters
Custom identifier to indicate the transaction or request source.
subdomainstringOptional<=50 characters
Refers to the payment page identifier. If provided, then the transaction is linked to the payment page.
subscriptionIdlongOptional
Payabli identifier of the subscription associated with the transaction.

Response

Ok
responseTextstring

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

isSuccessboolean

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

responseDataobject
pageIdentifierstringOptional
Auxiliary validation used internally by payment pages and components.

Errors

400
Bad Request Error
401
Unauthorized Error
500
Internal Server Error
503
Service Unavailable Error