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 the destination bank account, and initiates the payout. Idempotent on clientReferenceId.

Provide exactly one destination, and the matching currency:

  • bankAccount (US ACH): currency must be USD.
  • sepaBankAccount (SEPA): currency must be EUR. The account holder is checked with Verification of Payee before the account is saved; a failed check is returned as BANK_ACCOUNT_VOP_VERIFICATION_FAILED and nothing is created.

The amount is paid out in currency with no conversion. Each currency needs a matching payout wallet on your merchant account, and the corresponding payout rail must be enabled.

customerIpAddress is the IP address the customer consented to the payout from. Pass it when you collected it; when omitted, the consent IP recorded with the customer's headless KYC request is used, and the call fails with RESOURCE_NOT_FOUND if the customer was not verified through the Headless KYC API.

Note: This endpoint requires the customer to have active TIER_2 KYC, for example through 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
integer
required
string
enum
required
Allowed:
string
required
length between 1 and 255
string
enum
required
Allowed:
customer
required
bankAccount
object
required
sepaBankAccount
object
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