Create Payee

application/json

Request Body

payee object required
type string required
Possible values: [Business, People]
payout_category_name string required
Possible values: [Related Company Transfer, Capital Investment, Office Supplies]
nickname string required
Possible values: <= 50 characters
email string required
Possible values: <= 100 characters
phone_country_code string required
phone_number string required
company_name string required
Possible values: <= 120 characters
payout_account object required
country string required
currency string required
date_of_birth string nullable required
type是People时，该字必填
transfer_method string required
Possible values: [HK FPS - Account Number, HK FPS - Email, HK FPS - Mobile, HK FPS - FPS ID, RTGS, SWIFT]
hk_fps object nullable required
transfer method为FPS时，该字段必填
bank_account object nullable required
transfer method是HK FPS - Account Number时，该字段必填
bank_code string nullable required
account_name string nullable required
account_number string nullable required
mobile string nullable required
transfer method是HK FPS - Mobile时，该字段必填
email string nullable required
transfer method是HK FPS - Email时，该字段必填
fps_id string nullable required
transfer method是HK FPS - FPS ID时，该字段必填
full_name string nullable required
rtgs object nullable required
transfer method是RTGS时，该字段必填
swift_code string nullable required
account_name string nullable required
account_number string nullable required
swift object nullable required
transfer method是SWIF时，该字段必填
swift_code string nullable required
account_name string nullable required
account_number string nullable required

Responses

• 200

---

Response Headers

application/json

Schema

Example (from schema)

1

2

---

Schema

code integer required

Possible values: [200]

data object required

payee object required

id uuid required

payee id

message string required

{
  "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"
}

Loading...