Browse Source

payout API

master
frank 2 years ago
parent
commit
0e9d514a35
  1. 12
      payout/api.md
  2. 314
      payout/appendex.md
  3. 183
      payout/payee.md
  4. 169
      payout/payout-account.md
  5. 46
      payout/transfer.md

12
payout/api.md

@ -0,0 +1,12 @@
# API Domain URL
---
## Sandbox
* https://mapi.yuansfer.yunkeguan.com
## Production
* https://mapi.yuansfer.com

314
payout/appendex.md

@ -0,0 +1,314 @@
# 中国银行名称列表
* 不在列表的银行,填`其他银行`
```text
中国邮政储蓄银行
中国工商银行
中国农业银行
中国银行
中国建设银行
交通银行
中信银行
光大银行
华夏银行
民生银行
广东发展银行
平安银行
招商银行
兴业银行
上海浦发银行
烟台市商业银行
威海市商业银行
浙商银行
渤海银行
东亚银行中国有限公司
友利银行
新韩银行
韩亚银行
企业银行
深圳前海微众银行
天津金城银行
温州民商
重庆富民银行
福建华通银行股份有限公司
江苏苏宁银行
威海蓝海银行
上海银行
厦门银行股份有限公司
北京银行
宁波银行
洛阳银行
辽阳银行股份有限公司
大连市商业银行
杭州银行
南京银行
东莞银行
金华市商业银行
绍兴市商业银行
抚顺银行
天津市商业银行
郑州市商业银行
宁夏银行
锦州市商业银行
重庆市商业银行
哈尔滨市银行
贵阳银行股份有限公司
西安银行股份有限公司
兰州市商业银行
晋商银行
青岛银行
鞍山银行
秦皇岛银行股份有限公司
台州市商业银行
长沙市商业银行
泉州市商业银行
营口市商业银行
嘉兴市商业银行
廊坊市商业银行
沧州银行
包商银行
绵阳市商业银行
泸州市商业银行
大同银行
张家口市商业银行
龙江银行
江苏长江商业银行
柳州市商业银行
莱商银行
曲靖市商业银行
晋城商业银行
长治市商业银行
邯郸市商业银行
浙江民泰商业银行
泰安市商业银行
浙江稠州商业银行
乌海银行股份有限公司
自贡市商业银行
鄂尔多斯银行股份有限公司
济宁银行
乐山市商业银行
长安银行
昆仑银行股份有限公司
平顶山银行股份有限公司
平顶山银行
宁波东海银行
遂宁市商业银行
保定银行
邢台银行
晋中市商业银行
衡水市商业银行
阳泉市商业银行
宜宾市商业银行
库尔勒市商业银行
雅安市商业银行
华融湘江银行
营口沿海银行
西藏银行
新疆汇和银行
宁波通商银行
甘肃银行
枣庄银行
苏州银行
中原银行
厦门国际银行
海南银行
湖南三湘银行
常熟农村商业银行
深圳农村商业银行
广州农村商业银行
广东南海农村商业银行
湖北农信社
江阴市农村商业银行
重庆农村商业银行
山东省农村信用社联合社
张家港市农村商业银行
北京农村商业银行
宁波鄞州农村合作银行
宁波鄞州农村合作银行
吴江农商行
浙江省农村信用社联合社
太仓农村商业银行
贵州省农村信用社
湖南省农村信用社联合社
河南省农村信用社
河北省农村信用社
陕西省农村信用社联合社
广西农村信用社联合社
新疆农村信用社联合社
吉林省农村信用社联合社
黄河农村商业银行
安徽省农村信用社
海南省农村信用社联合社
青海省农村信用社联合社
广东农信
四川省农村信用社
甘肃省农村信用社联合社
辽宁省农村信用社联合社
山西省农村信用社联合社
天津滨海农村商业银行
黑龙江省农村信用社联合社
武汉农村商业银行
江南农村商业银行
大连农商行
浙江长兴联合村镇银行
重庆农村商业银行
方大村镇银行
深圳龙岗鼎业村镇银行
水城蒙银村镇银行
仁怀蒙银村镇银行
中山小榄村镇银行
浙江三门银座村镇银行
南阳村镇银行
浙江萧山湖商村镇银行
晋中市榆次融信村镇银行
梅县客家村镇银行
南宁江南国民村镇银行
桂林国民村镇银行
古交汇泽村镇银行
兴县汇泽村镇银行
柳林汇泽村镇银行
罕台村镇银行
广元贵商村镇银行
东营莱商村镇银行
舒兰吉银村镇银行
珲春吉银村镇银行
张北信达村镇银行
康保银丰村镇银行
蔚县银泰村镇银行
宝丰豫丰村镇银行
灵宝融丰村镇银行
天津华明村镇银行
天津宁河村镇银行
任丘泰寿村镇银行
芜湖泰寿村镇银行
乐陵圆融村镇银行
平原圆融村镇银行
武城圆融村镇银行
山东兰陵村镇银行
尉氏合益村镇银行
开封新东方村镇银行
长葛轩辕村镇银行
浙江兰溪越商村镇银行
淮安光大村镇银行
韶山光大村镇银行
内江兴隆村镇银行
山东周村青隆村镇银行
哈密天山村镇银行
山东临朐聚丰村镇银行
珠海横琴村镇银行
襄城汇浦村镇银行
清镇兴邦村镇银行
平坝鼎立村镇银行
滦平盛阳村镇银行
香河益民村镇银行
大洼恒丰村镇银行
盘山安泰村镇银行
涞水利丰村镇银行
怀来利丰村镇银行
荥阳利丰村镇银行
沂源博商村镇银行
太原市尖草坪区信都村镇银行
阳高县兴都村镇银行
大同市南郊区京都村镇银行
平定县昌都村镇银行
长治县泰都村镇银行
武乡县泽都村镇银行
应县金都村镇银行
代县泓都村镇银行
宁武县瑞都村镇银行
忻州市忻府区秀都村镇银行
文水县润都村镇银行
临县泉都村镇银行
和顺县贵都村镇银行
寿阳县汇都村镇银行
介休市华都村镇银行
临汾市尧都区惠都村镇银行
洪洞县洪都村镇银行
河津市龙都村镇银行
广饶梁邹村镇银行
费县梁邹村镇银行
铁岭新星村镇银行
无为徽银村镇银行
调兵山惠民村镇银行
乐亭舜丰村镇银行
大城舜丰村镇银行
霸州舜丰村镇银行
广阳舜丰村镇银行
黔西花都村镇银行
元氏信融村镇银行
朝阳柳城村镇银行
崇州上银村镇银行
垦利乐安村镇银行
莱阳胶东村镇银行
牟平胶东村镇银行
夏津胶东村镇银行
齐河胶东村镇银行
禹城胶东村镇银行
宁津胶东村镇银行
许昌新浦村镇银行
东方惠丰村镇银行
岚县慧融村镇银行
信阳平桥中原村镇银行
武安村镇银行
深州丰源村镇银行
长春朝阳和润村镇银行
长春经开融丰村镇银行
长春绿园融泰村镇银行
前郭县阳光村镇银行
云霄润发村镇银行
东山润鑫村镇银行
平和润丰村镇银行
五峰金谷村镇银行
禹州新民生村镇银行
上蔡惠民村镇银行
南江农科村镇银行
平昌农科村镇银行
昌乐乐安村镇银行
庆云乐安村镇银行
贵安新区发展村镇银行
德惠敦银村镇银行
图们敦银村镇银行
和龙敦银村镇银行
沾化青云村镇银行
日本三井住友卡公司
日本三菱信用卡公司
齐鲁银行股份有限公司
广州市商业银行
成都市商业银行
临商银行
珠海华润银行
齐商银行
锦州银行
江西银行
九江银行股份有限公司
日照银行
青海银行
潍坊银行
赣州银行股份有限公司
浙江泰隆商业银行
内蒙古银行
湖州银行
广西北部湾银行
广东南粤银行
桂林银行
四川天府银行
昆山农村商业银行
云南省农村信用社
承德银行
德州银行
福建省农村信用社联合社
天津农村商业银行
成都农村商业银行
江苏省农村信用社联合社
上饶银行
东营银行
无锡农村商业银行
江西省农村信用社联合社
哈尔滨农村商业银行股份有限公司
百信银行
吉林亿联银行
新网银行
其他银行
```

183
payout/payee.md

@ -0,0 +1,183 @@
# Payee Registration
---
* {Domain}/v3/payee/register
### Request
* `governmentIdType`: 中国大陆用户需要使用身份证号码,type = `ID_CARD`
* 注册成功之后,Payee会收到注册通知邮件,根据指引登录Yuansfer Portal提交相关信息,激活账户之后才可以接收转账。
|参数名|描述|
|---|---|
|customerCode|商户系统客户编号|
|dateOfBirth|大于18岁|
|governmentId|中国大陆公民使用居民身份证号码|
|lastName|姓,中国公民使用中文,与身份证姓名一致|
|firstName|名,中国公民使用中文,与身份证姓名一致|
```json
{
"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
```json
{
"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 都可以作为查询条件
```json
{
"customerCode": "1667198337",
"customerNo": "2000305228294092293550",
"email": "[email protected]",
"merchantNo": "202333",
"storeNo": "301854",
"timestamp":"2022-10-31T10:13:05Z",
"verifySign": "2ed37ef290331e712e1f46b278913b5d"
}
```
### Response
```json
{
"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
```json
{
"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
```json
{
"ret_msg": "update success",
"ret_code": "000100"
}
```
# 删除
---
* {Domain}/v3/payee/delete
### Request
```json
{
"customerNo": "2000305228294092293550",
"email": "[email protected]",
"merchantNo": "202333",
"storeNo": "301854",
"timestamp":"2022-10-31T10:15:11Z",
"verifySign": "24d8c40c625b0a8645d1bf574f3ba085"
}
```
### Response
```json
{
"ret_msg": "delete success",
"ret_code": "000100"
}
```

169
payout/payout-account.md

@ -0,0 +1,169 @@
# 添加收款账号
* {Domain}/v3/customers/account/create/bank-account
### 收款账号类型
|类型|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
```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"
}
```

46
payout/transfer.md

@ -0,0 +1,46 @@
transfer.md
# 打款/转账/提现
* {Domain}/v3/customers/account/create/bank-account
### Request
```json
{
"accountToken": "2010305228294111721580",
"amount": "200",
"currency": "USD",
"customerNo": "2000305228294106374322",
"description": "thank you",
"invoiceId": "fd641a80dfd814afdbf0e68ce5b6d2ff",
"ipnUrl": "https://example.com/notify",
"merchantNo": "202333",
"note": "Payouts, Thanks",
"storeNo": "301854",
"subject": "Payouts",
"verifySign": "2606ac28c2f7bda525f4d7cc3ff6fca5"
}
```
### Response
```json
{
"result":
{
"amount": "200.00",
"transactionFee": "14.00",
"transactionNo": "305469836617940464",
"createdTime": "2022-10-31T12:13:03Z",
"invoiceId": "fd641a80dfd814afdbf0e68ce5b6d2ff",
"currency": "USD",
"accountToken": "2010305228294111721580",
"customerNo": "2000305228294106374322",
"status": "pending"
},
"ret_msg": "pending",
"ret_code": "000100"
}
```
Loading…
Cancel
Save