v1

latestOpenAPI 3.1.02026-07-245575200.1 KB
Headless Payout

Create a headless payout

Creates a payout for a KYC-verified customer in a single API call. Validates the customer has active TIER_2 KYC, creates or reuses an ACH bank account, and initiates the payout. Idempotent on clientReferenceId.

Note: This endpoint requires the customer to have been KYC-verified via the Headless KYC API. It is only available to merchants configured by the Breeze team. Please reach out to the Breeze team to find out more.

post/v1/headless_payout

Request body

amountinteger required
currency'USD' required
clientReferenceIdstring required
releaseMethod'MANUAL' | 'AUTOMATIC' required

Response

Success

status'SUCCEEDED' required