payoutSubscription

Create payout subscription

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.

post/PayoutSubscription

Request

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

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.

subdomainstring

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

accountIdstring

Custom identifier for payment connector.

sourcestring

Custom identifier to indicate the transaction or request source.

setPauseboolean

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.

Response

Success

isSuccessboolean

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

responseDatainteger required

The identifier of the newly created payout subscription.

customerIdinteger

The Payabli-generated unique ID for the customer.

Changes

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