docs/payout/payout-account.md

# 添加收款账号

---

* {Domain}/v3/customers/account/create/bank-account
* {Domain}/v3/customers/account/create/paypal
* {Domain}/v3/customers/account/create/venmo

### 收款账号类型

|参数名|M/C/O|描述|
|---|---|---|
|accountCountry|M|收款人账号国家代码, 例如CN, JP|
|accountCurrency|M|收款人账号结算币种, 例如CNY|
|accountTag|M|商户系统中账号标识，unique ID|
|accountType|M|账号类型|
|bankAccountId|M|账号，例如中国大陆银行卡号，PayPal账号, Venmo账号等|
|bankName|M|银行名称，中国大陆银行名称列表见附录|
|customerNo|M|创建Payee时返回的客户编号|
|ipnUrl|M|用于接收打款结果通知|
|timestamp|M|API请求实时时间戳|
|clientIp|M|收款人IP地址|


|类型|api|描述|
|---|---|---|
|BANK_ACCOUNT|bank-account|银行账号/卡号|
|PAYPAL|paypal|PayPal|
|VENMO|venmo|Venmo|


### Request

```json
{
    "accountCountry": "CN",
    "accountCurrency": "CNY",
    "accountTag": "1667217845",
    "accountType": "BANK_ACCOUNT",
    "bankAccountId": "6227000734730752257",
    "bankName": "中国建设银行",
    "clientIp": "2401:1740:1000:0:801:6666:20cd:6034",
    "customerNo": "2000305228294106374322",
    "ipnUrl": "https://example.com/notify",
    "merchantNo": "202333",
    "storeNo": "301854",
    "timestamp": "2022-10-31T12:04:05Z",
    "verifySign": "6d131346908c10e76583a3c1c24d3a4f"
}
```

### Response

|参数名|M/C/O|描述|
|---|---|---|
|accountToken|M|我方系统中收款人账号编号,唯一|

```json
{
    "result":
    {
        "accountTag": "1667217845",
        "accountStatus": "ACTIVATED",
        "country": "CN",
        "lastName": "雄",
        "firstName": "霸",
        "accountType": "BANK_ACCOUNT",
        "currency": "CNY",
        "accountToken": "2010305228294111721580",
        "customerNo": "2000305228294106374322",
        "email": "[email protected]",
        "timestamp": "2022-10-31T12:04:08Z",
        "status": "success"
    },
    "ret_msg": "success",
    "ret_code": "000100"
}
```


# 查询收款人账号信息

---

* {Domain}/v3/payee/payout-accounts

## 查询成功

### Request

* 查询由收款人登录portal，自己添加的银行账号，PayPal账号，Alipay账号等

```json
{
    "merchantNo": "202333",
    "storeNo": "301854",
    "customerNo": "2000305228289295850180",
    "verifySign": "05a150f56706f9a435748eb986c2daad",
    "timestamp": "2022-10-10T18:25:52Z"
}
```

### Response

```json
{
    "accounts": [
        {
            "accountTag": "ee1d4197-36aa-4991-952c-0a9b35f505dd",
            "country": "CN",
            "createdAt": "2022-09-05T18:27:40Z",
            "accountType": "BANK_ACCOUNT",
            "currency": "CNY",
            "accountToken": "2010305228289296332658",
            "cardNumber": "****5655",
            "status": "activated"
        }
    ],
    "ret_msg": "success",
    "user": {
        "firstName": "俊义",
        "lastName": "卢",
        "customerNo": "2000305228289295850180",
        "email": "[email protected]"
    },
    "ret_code": "000100"
}
```

## 通过`accountTag` 查询单个账号

### Request 

```json
{
    "merchantNo": "202333",
    "storeNo": "301854",
    "customerNo": "2000305228289295850180",
    "accountTag":"ee1d4197-36aa-4991-952c-0a9b35f505dd",
    "verifySign": "700655e94a50e7e3e6115ade9665ae87",
    "timestamp": "2022-10-31T07:11:29Z"
}
```

### Response

```json
{
    "result": {
        "accountTag": "ee1d4197-36aa-4991-952c-0a9b35f505dd",
        "country": "CN",
        "createdAt": "2022-09-05T18:27:40Z",
        "firstName": "俊义",
        "lastName": "卢",
        "accountType": "BANK_ACCOUNT",
        "currency": "CNY",
        "accountToken": "2010305228289296332658",
        "customerNo": "2000305228289295850180",
        "email": "[email protected]",
        "cardNumber": "****5655",
        "status": "activated"
    },
    "ret_msg": "success",
    "ret_code": "000100"
}
```

## 查询失败，payee账号待审核

### Request

```json
{
    "merchantNo": "202333",
    "storeNo": "301854",
    "customerNo": "2000305228294092293550",
    "verifySign": "b7168db325fa9a3c49e8b62fd2dab4ff",
    "timestamp": "2022-10-31T06:51:20Z"
}
```

### Response

```json
{
    "ret_code": "000040",
    "ret_msg": "payee status Unverified"
}
```