APIPay Out endpointsPayout subscriptions

Create payout subscription

View as MarkdownOpen in Claude

Creates a payout subscription to automatically send payouts to a vendor on a recurring schedule. See Manage payout subscriptions for a step-by-step guide.

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.

Request

This endpoint expects an object.
entryPointstringRequired<=50 characters
The entrypoint identifier.
paymentMethodobjectRequired

Payment method for the payout subscription. Supports ach, vcard, and check. The managed method isn’t supported for payout subscriptions.

vendorDataobjectRequired

Object identifying the vendor for this subscription. Only a vendorId or vendorNumber is needed to link to an existing vendor.

subdomainstringOptional<=50 characters
Refers to the payment page identifier. If provided, then the transaction is linked to the payment page.
accountIdstringOptional
Custom identifier for payment connector.
sourcestringOptional<=100 characters
Custom identifier to indicate the transaction or request source.
setPausebooleanOptional
Flag indicating if the payout subscription is paused. When a payout subscription is paused, no payouts are processed until it's unpaused, and the next payment date isn't calculated automatically.
paymentDetailsobjectOptional
Object describing details of the payout.
billDatalist of objectsOptional

Array of bills associated with the payout subscription. If omitted and doNotCreateBills isn’t set to true, the system creates a bill automatically.

scheduleDetailsobjectOptional
Object describing the schedule for the payout subscription.

Response

Success
responseTextstring

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

responseDatainteger
The identifier of the newly created payout subscription.
isSuccessbooleanOptional

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

customerIdlongOptional
The identifier of the vendor associated with the payout subscription.

Errors

400
Bad Request Error
401
Unauthorized Error
500
Internal Server Error
503
Service Unavailable Error