API referencePay In endpointsMake transactions

Authorize transaction

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

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

Headers

requestTokenstringRequired
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 is not generated in Payabli, you must generate it yourself.

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<=250 characters

Custom identifier for payment connector.

customerDataobjectOptional

Object describing the Customer/Payor. Which fields are required depends on the paypoint’s custom identifier settings. See PayorData Object Model for a complete reference.

entryPointstringOptional<=50 characters

The entrypoint identifier.

invoiceDataobjectOptional

Object describing an Invoice linked to the transaction.

ipaddressstringOptional

Recommended. The customer’s IP address. This field is used to help prevent fraudulent transactions, and Payabli strongly recommends including this data.

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

isSuccessbooleanOptional

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

pageIdentifierstringOptional

Auxiliary validation used internally by payment pages and components.

responseDataobjectOptional
responseTextstringOptional

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

Errors