BRbreeze
Headless Payout

Create a headless payout

Changed on

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.

post/v1/headless_payout

Request

Request body

OR

Response

Success

status'SUCCEEDED' required

Changes

  • 4af083d182a6Revision changes
    • breaking

      request property was restricted to a list of enum values

    • breaking

      the request property type changed from no type to string

    • warning

      added the new BREEZE_CARD enum value to the / response property for the response status

    • warning

      added the new breeze_card_usd enum value to the / response property for the response status

    • warning

      added the new gbp_fps enum value to the / response property for the response status

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added subschema #1 subschema #2 to the request body oneOf list

    • info

      the request property became optional

    • info

      the request property const value USD was removed

    • info

      added the new EUR enum value to the request property

    • info

      added the new USD enum value to the request property