moneyOut

Authorize and capture a payout

Authorizes a payout and captures it in the same request, returning the capture result. Use this endpoint when you need the capture outcome synchronously: it does the same work as calling POST /MoneyOut/authorize followed by GET /MoneyOut/capture/{referenceId}, in a single call.

Risk and fraud review runs at both the authorize and capture stages, exactly as it does for the two-call flow.

Payabli ignores the autoCapture field in the request body, since this endpoint always captures inline.

If the capture fails, the payout stays authorized. Retry the capture with GET /MoneyOut/capture/{referenceId} using the referenceId from the error response rather than resubmitting, which would create a second payout. See the Manage payouts guide for details.

post/MoneyOut/payout

Request

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

Query parameters

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.

Because this endpoint captures immediately, pass autoConvertSameDayAch with a value of true to fall back to standard ACH if the capture runs after the same-day ACH cutoff.

doNotCreateBillsboolean

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

allowDuplicatedBillsboolean

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

updateVendorPaymentMethodboolean

When true, Payabli updates the vendor's stored default payment method to the method used in this payout.

autoConvertSameDayAchboolean

Controls what happens to a payout authorized with sameDayACH set to true when the capture runs after the same-day ACH cutoff. When true, Payabli converts the payout to a standard ACH payment and captures it. When false, the capture is declined.

This parameter has no effect on payouts that weren't authorized for same-day ACH.

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.