Authorizes a transaction for payout.
If you don't pass `autoCapture` with a value of `true`, authorized transactions aren't flagged for settlement until captured. Use the `referenceId` returned in the response to capture the transaction.
When `autoCapture` is `true`, Payabli captures the transaction asynchronously after authorization. The response confirms only that the transaction was authorized; it doesn't confirm that capture succeeded. To confirm capture, listen for the [`payout_transaction_approvedcaptured`](/developers/webhooks/payout-transaction-approved-captured) webhook event.
If a velocity fraud alert is triggered, the endpoint returns a `202` response with `responseCode` `9051`, and the authorization is held for risk review rather than rejected. If a risk policy blocks the transaction, the endpoint returns a `422` response with `responseCode` `9005`, a terminal rejection.
Request
This endpoint expects an object.
entryPointstringRequired<=50 characters
The entrypoint identifier.
paymentMethodobjectRequired
Payment method object for vendor payouts.
{ method: "managed" } - Managed payment method{ method: "vcard" } - Virtual card payment method{ method: "check" } - Check payment method{ method: "ach", achHolder: "...", achRouting: "...", achAccount: "...", achAccountType: "..." } - ACH payment method with bank details{ method: "ach", storedMethodId: "..." } - ACH payment method using stored method ID{ method: "wire", achHolder: "...", achRouting: "...", achAccount: "...", achAccountType: "..." } - Wire transfer payment method (US only, irrevocable){ method: "rtp", achHolder: "...", achRouting: "...", achAccount: "...", achAccountType: "..." } - Real-Time Payments method (US only, irrevocable)
paymentDetailsobjectRequired
Object containing payment details.
vendorDataobjectRequired
Object containing vendor data.
invoiceDatalist of objectsRequired
Array of bills associated to the transaction
sourcestringOptional<=100 characters
Custom identifier to indicate the transaction or request source.
orderIdstringOptional<=250 characters
Custom identifier for the transaction.
orderDescriptionstringOptional<=250 characters
Text description of the transaction.
accountIdstringOptional
Custom identifier for payment connector.
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.
autoCapturebooleanOptional
When true, Payabli captures the transaction asynchronously after a
successful authorization. The authorization request returns once the
transaction is authorized; capture happens later, and the response
doesn’t confirm capture. To confirm capture succeeded, listen for the
payout_transaction_approvedcaptured
webhook event.
When false, you must manually capture the transaction after a
successful authorization. Defaults to false.
See Manage payouts with the API
for more information.
Success
pageIdentifierstring or null
Auxiliary validation used internally by payment pages and components.
roomIdlong
Field not in use on this endpoint. It always returns 0.
isSuccessboolean
Boolean indicating whether the operation was successful. A true value
indicates success. A false value indicates failure.
responseTextstring
Response text for operation: ‘Success’ or ‘Declined’.
