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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Headless payout details

integer
required
const
enum
required
Allowed:
string
required
length between 1 and 255
string
enum
required
Allowed:
customer
required
bankAccount
object
required
Responses

Language
Credentials
Basic
base64
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json