Create a payee

POST /svc/ts/api/v1/openapi/payees

Request

application/json

Body

payee objectrequired

type stringrequired

Possible values: [Business, People]

Example: Business

payout_category_name stringrequired

Possible values: [Related Company Transfer, Capital Investment, Office Supplies]

Example: Related Company Transfer

nickname stringrequired

Possible values:<= 50 characters

Example: Test Name

email stringrequired

Possible values:<= 100 characters

Example: hk.payee@example.com

phone_country_code stringrequired

Example: +862

phone_number stringrequired

Example: 88888888

company_name stringrequired

Possible values:<= 120 characters

Example: Test Company Name

payout_account objectrequired

country stringrequired

Example: HK

currency stringrequired

Example: HKD

transfer_method stringrequired

Possible values: [HK FPS - Account Number, HK FPS - Email, HK FPS - Mobile, HK FPS - FPS ID, RTGS, SWIFT]

date_of_birth stringnullablerequired

transfer method为FPS且type是People时，该字必填

Example: 2000-10-24

hk_fps objectnullablerequired

transfer method为FPS时，该字段必填

bank_account objectnullablerequired

transfer method是HK FPS - Account Number时，该字段必填

bank_code stringnullablerequired

Example: 374

account_name stringnullablerequired

Example: Test

account_number stringnullablerequired

Example: 68162321

mobile stringnullablerequired

transfer method是HK FPS - Mobile时，该字段必填

Example: +852-88888888

email stringnullablerequired

transfer method是HK FPS - Email时，该字段必填

Example: hk.payee@example.com

fps_id stringnullablerequired

transfer method是HK FPS - FPS ID时，该字段必填

Example: 172637183

full_name stringnullablerequired

Example: 陳大文

rtgs objectnullablerequired

transfer method是RTGS时，该字段必填

bank_account objectrequired

swift_code stringnullablerequired

Example: CIBBHKHKXXX

account_name stringnullablerequired

Example: Test

account_number stringnullablerequired

Example: 8762532

swift objectnullablerequired

transfer method是SWIF时，该字段必填

bank_account objectnullablerequired

swift_code stringnullablerequired

Example: CIBBHKHKXXX

account_name stringnullablerequired

Example: Test

account_number stringnullablerequired

Example: 3727878

Responses

Response Headers

application/json
Schema
Example (auto)
1
2

Schema

code integerrequired

Possible values: [200]

data objectrequired

payee objectrequired

id string<uuid>required

payee id

message stringrequired

{
  "code": 200,
  "data": {
    "payee": {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    }
  },
  "message": "string"
}

success示例

{
  "code": 200,
  "data": {
    "payee": {
      "id": "417c63ef-87a5-44af-bd46-ec358862263c"
    }
  },
  "message": "succeed"
}

异常示例

{
  "code": 810001,
  "message": "Invalid type"
}

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/payees");
request.Headers.Add("Accept", "application/json");
var content = new StringContent("{\n  \"payee\": {\n    \"type\": \"Business\",\n    \"payout_category_name\": \"Related Company Transfer\",\n    \"nickname\": \"Test Name\",\n    \"email\": \"hk.payee@example.com\",\n    \"phone_country_code\": \"+862\",\n    \"phone_number\": \"88888888\",\n    \"company_name\": \"Test Company Name\",\n    \"payout_account\": {\n      \"country\": \"HK\",\n      \"currency\": \"HKD\",\n      \"transfer_method\": \"HK FPS - Account Number\",\n      \"date_of_birth\": \"2000-10-24\",\n      \"hk_fps\": {\n        \"bank_account\": {\n          \"bank_code\": \"374\",\n          \"account_name\": \"Test\",\n          \"account_number\": \"68162321\"\n        },\n        \"mobile\": \"+852-88888888\",\n        \"email\": \"hk.payee@example.com\",\n        \"fps_id\": \"172637183\",\n        \"full_name\": \"陳大文\"\n      },\n      \"rtgs\": {\n        \"bank_account\": {\n          \"swift_code\": \"CIBBHKHKXXX\",\n          \"account_name\": \"Test\",\n          \"account_number\": \"8762532\"\n        }\n      },\n      \"swift\": {\n        \"bank_account\": {\n          \"swift_code\": \"CIBBHKHKXXX\",\n          \"account_name\": \"Test\",\n          \"account_number\": \"3727878\"\n        }\n      }\n    }\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)
1
2
3
4
5
6

{
  "payee": {
    "type": "Business",
    "payout_category_name": "Related Company Transfer",
    "nickname": "Test Name",
    "email": "hk.payee@example.com",
    "phone_country_code": "+862",
    "phone_number": "88888888",
    "company_name": "Test Company Name",
    "payout_account": {
      "country": "HK",
      "currency": "HKD",
      "transfer_method": "HK FPS - Account Number",
      "date_of_birth": "2000-10-24",
      "hk_fps": {
        "bank_account": {
          "bank_code": "374",
          "account_name": "Test",
          "account_number": "68162321"
        },
        "mobile": "+852-88888888",
        "email": "hk.payee@example.com",
        "fps_id": "172637183",
        "full_name": "陳大文"
      },
      "rtgs": {
        "bank_account": {
          "swift_code": "CIBBHKHKXXX",
          "account_name": "Test",
          "account_number": "8762532"
        }
      },
      "swift": {
        "bank_account": {
          "swift_code": "CIBBHKHKXXX",
          "account_name": "Test",
          "account_number": "3727878"
        }
      }
    }
  }
}