Skip to main content

Create payout request

POST 
/api/v1/openapi/payout_requests

Create a payout and auto-approve it.

Required fields​

  • payout_request.reference_id
  • payout_request.payee_id
  • payout_request.currency
  • payout_request.amount

reference_id (EndToEndId) rules​

  • Length: 1–35 (Unicode rune count)
  • Charset: a-z A-Z 0-9 / - ? : ( ) . , ' + and space
  • Must not start or end with /
  • Must not contain //
  • Must be unique within the same business (duplicate → invalid reference id)

amount rules​

  • Must be > 0
  • Decimal places must match the currency standard
  • Subject to min/max limits for the payee payout_account transfer_method + currency; if no limit config, default upper bound is < 1_000_000_000

payee / currency pairing​

  • payee_id must belong to the current business
  • The payee must have a payout_account whose currency matches the request currency; otherwise the payee is invalid

remark (optional)​

  • Max 120 characters (runes)
  • Allowed: Unicode letters/numbers + payment punctuation / - ? : ( ) . , ' + (space allowed; CJK allowed)

Request​

Responses​

Created successfully (auto-approved)

Response Headers