Create a payout request

POST /svc/ts/api/v1/openapi/payout_requests

Request

application/json

Body

payout_request objectrequired

payee_id string<uuid>required

创建payee返回的id

currency stringrequired

Example: HKD

amount stringrequired

callback_url stringrequired

Example: https://api.example.com/callbacks/payout

remark string

Possible values:<= 120 characters

reference_id string

Possible values:<= 80 characters

schedule_at string

严格遵循 ISO 8601 标准格式：YYYY-MM-DDTHH:mm:ssZ（注意是 T 分隔，不是空格）
时区固定为 UTC（Z 标识不可省略）
不支持毫秒、时区偏移（如 +08:00）

Example: 2025-11-29T15:30:00Z

Responses

Response Headers

application/json
Schema
Example (auto)
1
2

Schema

code integerrequired

data objectrequired

payout_request objectrequired

id string<uuid>required

amount stringrequired

Example: 1465

currency stringrequired

Example: HKD

transfer_status stringrequired

Possible values: [Initiated, Processing Transfer, Reversed, Terminated, Refunded, Settled]

schedule_status stringrequired

Possible values: [Pending Approval, Approved, Rejected, Cancelled, Failed]

created_at stringrequired

Example: 2025-11-28T08:51:05.987294564Z

message stringrequired

{
  "code": 0,
  "data": {
    "payout_request": {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "amount": "1465",
      "currency": "HKD",
      "transfer_status": "Initiated",
      "schedule_status": "Pending Approval",
      "created_at": "2025-11-28T08:51:05.987294564Z"
    }
  },
  "message": "string"
}

success示例

{
  "code": 200,
  "data": {
    "payout_request": {
      "id": "580786d3-1e49-44f2-a0ab-c9bdb11107e1",
      "amount": "1006.88",
      "currency": "HKD",
      "transfer_status": "Initiated",
      "schedule_status": "Approved",
      "created_at": "2025-11-28T08:51:05.987294564Z"
    }
  },
  "message": "succeed"
}

异常

{
  "code": 820007,
  "message": "Invalid callback URL"
}

csharp
curl
dart
go
http
java
javascript
kotlin
c
nodejs
objective-c
ocaml
php
powershell
python
r
ruby
rust
shell
swift
HTTPCLIENT
RESTSHARP

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://developer.wonder.today/svc/ts/api/v1/openapi/payout_requests");
request.Headers.Add("Accept", "application/json");
var content = new StringContent("{\n  \"payout_request\": {\n    \"payee_id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n    \"currency\": \"HKD\",\n    \"amount\": \"string\",\n    \"callback_url\": \"https://api.example.com/callbacks/payout\",\n    \"remark\": \"string\",\n    \"reference_id\": \"string\",\n    \"schedule_at\": \"2025-11-29T15:30:00Z\"\n  }\n}", null, "application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Request Collapse all

Body

Example (from schema)
Example

{
  "payout_request": {
    "payee_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "currency": "HKD",
    "amount": "string",
    "callback_url": "https://api.example.com/callbacks/payout",
    "remark": "string",
    "reference_id": "string",
    "schedule_at": "2025-11-29T15:30:00Z"
  }
}