Create payout request

Creates a payout and auto-approve it.

Header parameters

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

Payout request

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> | null

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

Response data

required

object

Payout request

curl -X POST "https://api.wonder.app/api/v1/openapi/payout_requests" \ -H "Content-Type: application/json" \ -H "Signature: <Signature>" \ -H "Credential: <Credential>" \ -H "x-request-id: <x-request-id>" \ -H "x-i18n-lang: <x-i18n-lang>" \ -d '{"payout_request":{"amount":"100.50","remark":"Invoice payment","currency":"HKD","payee_id":"7c9e6679-7425-40de-944b-e07fc1f90ae7","reference_id":"INV-2026-0001"}}'

{ "payout_request": { "amount": "100.50", "remark": "Invoice payment", "currency": "HKD", "payee_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7", "reference_id": "INV-2026-0001" } }

{ "code": 200, "data": { "payout_request": { "id": "1a2b3c4d-1111-2222-3333-444455556666", "amount": "100.50", "currency": "HKD", "created_at": "2026-07-22T04:00:00Z", "transfer_status": "Initiated" } }, "message": "succeed" }