diff --git a/payout/api.md b/payout/api.md index 6a6a3bf..ebfd662 100644 --- a/payout/api.md +++ b/payout/api.md @@ -10,3 +10,12 @@ ## Production * https://mapi.yuansfer.com + + +## 参数类型描述 + +|符号|描述| +|---|---| +|M|必填| +|O|非必填| +|C|条件必填,一般为多个参数可选择性填其中一个| diff --git a/payout/payee.md b/payout/payee.md index 0d0ac02..8f6f64d 100644 --- a/payout/payee.md +++ b/payout/payee.md @@ -11,13 +11,44 @@ * 注册成功之后,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|C|国家名称| +|countryCode|M|国家代码,两位| +|state|M|州/省| +|city|M|市| +|street|M|address line 1| +|street2|M|address line 2| + + +###### profileType + +* 收款人实体类别 + +|参数名|描述| +|---|--- +|INDIVIDUAL|个人类型用户| +|BUSINESS|对公用户,企业用户| + +###### governmentIdType + +* 证件类型 + +|参数|说明| |---|---| -|customerCode|商户系统客户编号| -|dateOfBirth|大于18岁| -|governmentId|中国大陆公民使用居民身份证号码| -|lastName|姓,中国公民使用中文,与身份证姓名一致| -|firstName|名,中国公民使用中文,与身份证姓名一致| +|ID_CARD|中国大陆身份证| +|PASSPORT|护照| +|DRIVER_LICENSE|驾照| +|BUSINESS_REGISTRATION_CERT|营业执照| ```json @@ -46,6 +77,11 @@ ### Response + +|参数名|M/C/O|描述| +|---|---|---| +|customerNo|M|客户编号,唯一ID,请保存| + ```json { "ret_msg": "success", @@ -71,6 +107,8 @@ * email, customerCode, customerNo 都可以作为查询条件 +* `timestamp`: API调用实时时间戳,UTC零时区格式 + ```json { "customerCode": "1667198337", diff --git a/payout/payout-account.md b/payout/payout-account.md index 30bae64..78daeb5 100644 --- a/payout/payout-account.md +++ b/payout/payout-account.md @@ -1,10 +1,27 @@ # 添加收款账号 +--- + * {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请求实时时间戳| + + |类型|api|描述| |---|---|---| |BANK_ACCOUNT|bank-account|银行账号/卡号| @@ -34,6 +51,10 @@ ### Response +|参数名|M/C/O|描述| +|---|---|---| +|accountToken|M|我方系统中收款人账号编号,唯一| + ```json { "result": diff --git a/payout/transfer.md b/payout/transfer.md index d2badb2..e981fe6 100644 --- a/payout/transfer.md +++ b/payout/transfer.md @@ -7,6 +7,19 @@ transfer.md ### Request +|参数名|M/C/O|描述| +|---|---|---| +|accountToken|M|我方系统中收款人账号编号| +|amount|M|金额| +|currency|M|币种| +|customerNo|M|收款人客户编号| +|invoiceId|O|商户系统中订单编号,唯一ID| +|subject|O|收款人打款通知邮件标题(暂未使用)| +|note|O|附言| +|description|O|描述| +|note|O|附言| + + ```json { "accountToken": "2010305228294111721580",