You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

218 lines
4.6 KiB

2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
  1. # 添加收款账号
  2. ---
  3. * {Domain}/v3/customers/account/create/bank-account
  4. * {Domain}/v3/customers/account/create/paypal
  5. * {Domain}/v3/customers/account/create/venmo
  6. ### 收款账号类型
  7. |参数名|M/C/O|描述|
  8. |---|---|---|
  9. |accountCountry|M|收款人账号国家代码, 例如CN, JP|
  10. |accountCurrency|M|收款人账号结算币种, 例如CNY|
  11. |accountTag|M|商户系统中账号标识,unique ID|
  12. |accountType|M|账号类型|
  13. |bankAccountId|M|账号,例如中国大陆银行卡号,PayPal账号, Venmo账号等|
  14. |bankName|M|银行名称,中国大陆银行名称列表见附录|
  15. |customerNo|M|创建Payee时返回的客户编号|
  16. |ipnUrl|M|用于接收打款结果通知|
  17. |timestamp|M|API请求实时时间戳|
  18. |clientIp|M|收款人IP地址|
  19. |类型|api|描述|
  20. |---|---|---|
  21. |BANK_ACCOUNT|bank-account|银行账号/卡号|
  22. |PAYPAL|paypal|PayPal|
  23. |VENMO|venmo|Venmo|
  24. ### Request
  25. ```json
  26. {
  27. "accountCountry": "CN",
  28. "accountCurrency": "CNY",
  29. "accountTag": "1667217845",
  30. "accountType": "BANK_ACCOUNT",
  31. "bankAccountId": "6227000734730752257",
  32. "bankName": "中国建设银行",
  33. "clientIp": "2401:1740:1000:0:801:6666:20cd:6034",
  34. "customerNo": "2000305228294106374322",
  35. "ipnUrl": "https://example.com/notify",
  36. "merchantNo": "202333",
  37. "storeNo": "301854",
  38. "timestamp": "2022-10-31T12:04:05Z",
  39. "verifySign": "6d131346908c10e76583a3c1c24d3a4f"
  40. }
  41. ```
  42. ### Response
  43. |参数名|M/C/O|描述|
  44. |---|---|---|
  45. |accountToken|M|我方系统中收款人账号编号,唯一|
  46. ```json
  47. {
  48. "result":
  49. {
  50. "accountTag": "1667217845",
  51. "accountStatus": "ACTIVATED",
  52. "country": "CN",
  53. "lastName": "雄",
  54. "firstName": "霸",
  55. "accountType": "BANK_ACCOUNT",
  56. "currency": "CNY",
  57. "accountToken": "2010305228294111721580",
  58. "customerNo": "2000305228294106374322",
  59. "email": "[email protected]",
  60. "timestamp": "2022-10-31T12:04:08Z",
  61. "status": "success"
  62. },
  63. "ret_msg": "success",
  64. "ret_code": "000100"
  65. }
  66. ```
  67. # 查询收款人账号信息
  68. ---
  69. * {Domain}/v3/payee/payout-accounts
  70. ## 查询成功
  71. ### Request
  72. * 查询由收款人登录portal,自己添加的银行账号,PayPal账号,Alipay账号等
  73. ```json
  74. {
  75. "merchantNo": "202333",
  76. "storeNo": "301854",
  77. "customerNo": "2000305228289295850180",
  78. "verifySign": "05a150f56706f9a435748eb986c2daad",
  79. "timestamp": "2022-10-10T18:25:52Z"
  80. }
  81. ```
  82. ### Response
  83. ```json
  84. {
  85. "accounts": [
  86. {
  87. "accountTag": "ee1d4197-36aa-4991-952c-0a9b35f505dd",
  88. "country": "CN",
  89. "createdAt": "2022-09-05T18:27:40Z",
  90. "accountType": "BANK_ACCOUNT",
  91. "currency": "CNY",
  92. "accountToken": "2010305228289296332658",
  93. "cardNumber": "****5655",
  94. "status": "activated"
  95. }
  96. ],
  97. "ret_msg": "success",
  98. "user": {
  99. "firstName": "俊义",
  100. "lastName": "卢",
  101. "customerNo": "2000305228289295850180",
  102. "email": "[email protected]"
  103. },
  104. "ret_code": "000100"
  105. }
  106. ```
  107. ## 通过`accountTag` 查询单个账号
  108. ### Request
  109. ```json
  110. {
  111. "merchantNo": "202333",
  112. "storeNo": "301854",
  113. "customerNo": "2000305228289295850180",
  114. "accountTag":"ee1d4197-36aa-4991-952c-0a9b35f505dd",
  115. "verifySign": "700655e94a50e7e3e6115ade9665ae87",
  116. "timestamp": "2022-10-31T07:11:29Z"
  117. }
  118. ```
  119. ### Response
  120. ```json
  121. {
  122. "result": {
  123. "accountTag": "ee1d4197-36aa-4991-952c-0a9b35f505dd",
  124. "country": "CN",
  125. "createdAt": "2022-09-05T18:27:40Z",
  126. "firstName": "俊义",
  127. "lastName": "卢",
  128. "accountType": "BANK_ACCOUNT",
  129. "currency": "CNY",
  130. "accountToken": "2010305228289296332658",
  131. "customerNo": "2000305228289295850180",
  132. "email": "[email protected]",
  133. "cardNumber": "****5655",
  134. "status": "activated"
  135. },
  136. "ret_msg": "success",
  137. "ret_code": "000100"
  138. }
  139. ```
  140. ## 查询失败,payee账号待审核
  141. ### Request
  142. ```json
  143. {
  144. "merchantNo": "202333",
  145. "storeNo": "301854",
  146. "customerNo": "2000305228294092293550",
  147. "verifySign": "b7168db325fa9a3c49e8b62fd2dab4ff",
  148. "timestamp": "2022-10-31T06:51:20Z"
  149. }
  150. ```
  151. ### Response
  152. ```json
  153. {
  154. "ret_code": "000040",
  155. "ret_msg": "payee status Unverified"
  156. }
  157. ```
  158. # 删除账号
  159. ---
  160. * {Domain}/v3/payee/account/delete
  161. ### request
  162. ```json
  163. {
  164. "customerNo": "2000305228294784880996",
  165. "accountToken":"2010305228294786604676",
  166. "merchantNo": "202333",
  167. "storeNo": "301854",
  168. "timestamp":"2022-11-08T07:44:18Z",
  169. "verifySign": "13a3797b012da9b31b30eec177c6d76b"
  170. }
  171. ```
  172. ### Response
  173. ```json
  174. {
  175. "ret_msg": "deleted",
  176. "ret_code": "000100"
  177. }
  178. ```