Wonder
post/api/v1/openapi/payout_requests

Create payout request

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)

Header parameters

X-Skip-Signature
string

Example: TRUE

Signature
string

Example: good

Credential
string

Example: {{credential}}

x-request-id
string

Example: {{$string.uuid}}

x-i18n-lang
string

Example: zh-CN

Content-typerequired
string

Example: application/json

Request body · application/json

required
object
amountrequired
string

Payout amount (decimal as string or number in JSON; string recommended to avoid precision issues). Rules: - Must be `> 0`, otherwise `820004` - Decimal places must match currency standard, otherwise `820010` - Subject to transfer_method+currency limits: below min → `820005`; above max → `820006`

Example: 100.50

remark
string

Remark (optional). Empty string is treated as omitted. - Max 120 runes - Charset: Unicode letters/numbers + ` / -?:().,'+` (CJK allowed) Failure → `820008 Invalid remark`

Example: Invoice payment

currencyrequired
string

Payout currency. Must be active and match the payee payout_account currency. Invalid currency → `820003`; mismatch with payee → `820001`

Example: HKD

payee_idrequired
string<uuid>

Payee ID. Must belong to the current business and have a payout_account matching `currency`. Failure → `820001 Invalid payee`

Example: 7c9e6679-7425-40de-944b-e07fc1f90ae7

schedule_at
string<date-time>

Scheduled payout time (optional, RFC3339 absolute time with offset or `Z`). UTC (`...Z`) is recommended. Stored as UTC. - Omit: not scheduled - If provided: must not exceed global `scheduled_payout_max_days` Failure → `820002 Invalid schedule time`

Example: 2026-07-25T02:00:00Z

reference_idrequired
string

Client idempotency / reconciliation reference. Maps to ISO 20022 EndToEndId; stored as `ref_id`. **Required**. Rules: - Length 1–35 (runes) - Charset: `a-zA-Z0-9 / -?:().,'+` (space allowed) - Must not start/end with `/`; must not contain `//` - Unique within the same business Failure → `820009 Invalid reference ID` Lock contention / busy → `500104 System service busy`

Example: INV-2026-0001

Responses

Created successfully (auto-approved)

coderequired
enum<integer>

Always 200 on success

200

Example: 200

messagerequired
enum<string>

Always succeed on success

succeed

Example: succeed

object
required
object
PreviousGet wallet transactionsNext Get payout request