docs/payout/payee.md

Payee Registration

---

• {Domain}/v3/payee/register

Request

• governmentIdType: 中国大陆用户需要使用身份证号码，type = ID_CARD

• 注册成功之后，Payee会收到注册通知邮件，根据指引登录Yuansfer Portal提交相关信息，激活账户之后才可以接收转账。

参数名	M/C/O	描述
customerCode	O	商户系统客户编号
dateOfBirth	M	收款人出生日期，需大于18岁
governmentId	M	中国大陆公民使用居民身份证号码
governmentIdType	M	证件类型：身份证，营业执照号码等
lastName	M	姓，中国公民使用中文，与身份证姓名一致
firstName	M	名，中国公民使用中文，与身份证姓名一致
email	M	邮箱
phone	O	电话
zip	M	邮编
country	O	国家名称
countryCode	M	国家代码，两位
state	M	州/省
city	M	市
street	M	address line 1
street2	O	address line 2

profileType

• 收款人实体类别

参数名	描述
INDIVIDUAL	个人类型用户
BUSINESS	对公用户，企业用户

governmentIdType

• 证件类型

参数	说明
ID_CARD	中国大陆身份证
PASSPORT	护照
DRIVER_LICENSE	驾照
BUSINESS_REGISTRATION_CERT	营业执照

{
    "city": "北京",
    "country": "中国",
    "countryCode": "CN",
    "customerCode": "1667198337",
    "dateOfBirth": "1999-01-01",
    "email": "[email protected]",
    "firstName": "三",
    "governmentId": "110101199003074493",
    "governmentIdType": "ID_CARD",
    "lastName": "张",
    "merchantNo": "202333",
    "phone": "1234567890",
    "profileType": "INDIVIDUAL",
    "state": "北京",
    "storeNo": "301854",
    "street": "长城",
    "street2": "",
    "verifySign": "141803fb1e21ff977d7fa5f68067860a",
    "zip": "100000"
}

Response

参数名	M/C/O	描述
customerNo	M	客户编号，唯一ID，请保存

{
    "ret_msg": "success",
    "ret_code": "000100",
    "customer": {
        "firstName": "三",
        "lastName": "张",
        "customerCode": "1667198337",
        "createdTime": "2022-10-31T06:40:20Z",
        "customerNo": "2000305228294092293550",
        "email": "[email protected]"
    }
}

查询

---

• {Domain}/v3/payee/retrieve

Request

• email, customerCode, customerNo 都可以作为查询条件

• timestamp: API调用实时时间戳，UTC零时区格式

{
    "customerCode": "1667198337",
    "customerNo": "2000305228294092293550",
    "email": "[email protected]",
    "merchantNo": "202333",
    "storeNo": "301854",
    "timestamp":"2022-10-31T10:13:05Z",
    "verifySign": "2ed37ef290331e712e1f46b278913b5d"
}

Response

{
    "ret_msg": "query success",
    "ret_code": "000100",
    "customer": {
        "zip": "100000",
        "lastName": "张",
        "country": "中国",
        "updatedTime": "2022-10-31T06:40:20Z",
        "city": "北京",
        "customerCode": "1667198337",
        "dateOfBirth": "1999-01-01",
        "firstName": "三",
        "phone": "1234567890",
        "countryCode": "CN",
        "street": "长城",
        "createdTime": "2022-10-31T06:40:20Z",
        "state": "北京",
        "lang": "en",
        "customerNo": "2000305228294092293550",
        "email": "[email protected]"
    }
}

修改

---

• {Domain}/v3/payee/update
• 已激活(审核通过)的账号不允许再修改，会报错

Request

{
    "customerNo":"2000305228294092293550",
    "city": "北京",
    "country": "中国",
    "countryCode": "CN",
    "customerCode": "1667198337",
    "dateOfBirth": "1999-01-02",
    "firstName": "三",
    "governmentId": "110101199003074493",
    "governmentIdType": "ID_CARD",
    "lastName": "张",
    "merchantNo": "202333",
    "phone": "1234567890",
    "profileType": "INDIVIDUAL",
    "state": "北京",
    "storeNo": "301854",
    "street": "中南海",
    "street2": "No. 123",
    "verifySign": "55704c3e018d7878f3be3f14b472e05f",
    "zip": "100001"
}

Response

{
    "ret_msg": "update success",
    "ret_code": "000100"
}

删除

---

• {Domain}/v3/payee/delete

Request

{
    "customerNo": "2000305228294092293550",
    "email": "[email protected]",
    "merchantNo": "202333",
    "storeNo": "301854",
    "timestamp":"2022-10-31T10:15:11Z",
    "verifySign": "24d8c40c625b0a8645d1bf574f3ba085"
}

Response

{
    "ret_msg": "delete success",
    "ret_code": "000100"
}