APIPay In endpointsMake transactions

Authorize transaction

View as MarkdownOpen in Claude
Authorize a card transaction. This returns an authorization code and reserves funds for the merchant. Authorized transactions aren't flagged for settlement until captured. This is the v2 version of the `api/MoneyIn/authorize` endpoint, and returns the unified response format. See [Pay In unified response codes reference](/guides/pay-in-unified-response-codes-reference) for more information. **Note**: 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
codestring

Payabli’s unified response code. Starts with A (Approved) or D (Declined) followed by a four-digit code that provides specific details about the transaction result. See Pay In unified response codes reference for more information.

reasonstring

Human-readable reason corresponding to the response code.

explanationstring
Detailed description of the response code.
actionstring
Recommended resolution approach or next steps based on the response.
dataobject
Complete transaction details returned by v2 Money In endpoints. This matches the structure of the transaction details previously returned by the v1 details endpoint.
tokenstring or null

Pagination token (equivalent to pageIdentifier in v1 APIs). Returns null when pagination is not applicable.

Errors

400
Bad Request Error
401
Unauthorized Error
402
Payment Required Error
500
Internal Server Error