moneyOut

Authorize a payout

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

For check payouts, Payabli validates the remit (mailing) address at authorization. If the address fails deliverability validation, the endpoint returns a 422 response and doesn't charge the paypoint. Correct the address and re-authorize. Other payout rails (ACH, RTP, virtual card, wire, and managed payables) aren't affected.

post/MoneyOut/authorize

Request

  • Base URL: https://api-sandbox.payabli.com/api
  • URL: https://api-sandbox.payabli.com/api/MoneyOut/authorize
  • Auth: HTTP bearer

Query parameters

allowDuplicatedBillsboolean

When true, the authorization bypasses the requirement for unique bills, identified by vendor invoice number. This allows you to make more than one payout authorization for a bill, like a split payment.

doNotCreateBillsboolean

When true, Payabli won't automatically create a bill for this payout transaction.

sameDayACHboolean

When true, Payabli authorizes the payout for same-day ACH processing instead of standard ACH. Same-day ACH must be enabled for the paypoint, otherwise the authorization fails with a 400 response and responseCode 3492. Only ACH payouts honor this flag. Wire and RTP payouts ignore it.

Same-day ACH has a daily cutoff. Capture the transaction before the cutoff, or pass autoConvertSameDayAch with a value of true when you capture it.

Headers

idempotencyKeystring

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. The key persists for 2 minutes. After 2 minutes, you can reuse the key if needed.

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.

Request body

entryPointstring required

The entrypoint identifier.

sourcestring

Custom identifier to indicate the transaction or request source.

orderIdstring

Custom identifier for the transaction.

orderDescriptionstring

Text description of the transaction.

accountIdstring

Custom identifier for payment connector.

subdomainstring

Refers to the payment page identifier. If provided, then the transaction is linked to the payment page.

subscriptionIdinteger

Payabli identifier of the subscription associated with the transaction.

autoCaptureboolean

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.

Response

Success

responseCodeinteger required

Code for the response. Learn more in API Response Codes.

pageIdentifierstring required

Auxiliary validation used internally by payment pages and components.

roomIdinteger required

Field not in use on this endpoint. It always returns 0.

isSuccessboolean required

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

responseTextstring required

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

Changes

No recorded changes to this operation across all 1 revision of this API.