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.

190 lines
4.2 KiB

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. |类型|api|描述|
  19. |---|---|---|
  20. |BANK_ACCOUNT|bank-account|银行账号/卡号|
  21. |PAYPAL|paypal|PayPal|
  22. |VENMO|venmo|Venmo|
  23. ### Request
  24. ```json
  25. {
  26. "accountCountry": "CN",
  27. "accountCurrency": "CNY",
  28. "accountTag": "1667217845",
  29. "accountType": "BANK_ACCOUNT",
  30. "bankAccountId": "6227000734730752257",
  31. "bankName": "中国建设银行",
  32. "clientIp": "2401:1740:1000:0:801:6666:20cd:6034",
  33. "customerNo": "2000305228294106374322",
  34. "ipnUrl": "https://example.com/notify",
  35. "merchantNo": "202333",
  36. "storeNo": "301854",
  37. "timestamp": "2022-10-31T12:04:05Z",
  38. "verifySign": "6d131346908c10e76583a3c1c24d3a4f"
  39. }
  40. ```
  41. ### Response
  42. |参数名|M/C/O|描述|
  43. |---|---|---|
  44. |accountToken|M|我方系统中收款人账号编号,唯一|
  45. ```json
  46. {
  47. "result":
  48. {
  49. "accountTag": "1667217845",
  50. "accountStatus": "ACTIVATED",
  51. "country": "CN",
  52. "lastName": "雄",
  53. "firstName": "霸",
  54. "accountType": "BANK_ACCOUNT",
  55. "currency": "CNY",
  56. "accountToken": "2010305228294111721580",
  57. "customerNo": "2000305228294106374322",
  58. "email": "[email protected]",
  59. "timestamp": "2022-10-31T12:04:08Z",
  60. "status": "success"
  61. },
  62. "ret_msg": "success",
  63. "ret_code": "000100"
  64. }
  65. ```
  66. # 查询收款人账号信息
  67. ---
  68. * {Domain}/v3/payee/payout-accounts
  69. ## 查询成功
  70. ### Request
  71. * 查询由收款人登录portal,自己添加的银行账号,PayPal账号,Alipay账号等
  72. ```json
  73. {
  74. "merchantNo": "202333",
  75. "storeNo": "301854",
  76. "customerNo": "2000305228289295850180",
  77. "verifySign": "05a150f56706f9a435748eb986c2daad",
  78. "timestamp": "2022-10-10T18:25:52Z"
  79. }
  80. ```
  81. ### Response
  82. ```json
  83. {
  84. "accounts": [
  85. {
  86. "accountTag": "ee1d4197-36aa-4991-952c-0a9b35f505dd",
  87. "country": "CN",
  88. "createdAt": "2022-09-05T18:27:40Z",
  89. "accountType": "BANK_ACCOUNT",
  90. "currency": "CNY",
  91. "accountToken": "2010305228289296332658",
  92. "cardNumber": "****5655",
  93. "status": "activated"
  94. }
  95. ],
  96. "ret_msg": "success",
  97. "user": {
  98. "firstName": "俊义",
  99. "lastName": "卢",
  100. "customerNo": "2000305228289295850180",
  101. "email": "[email protected]"
  102. },
  103. "ret_code": "000100"
  104. }
  105. ```
  106. ## 通过`accountTag` 查询单个账号
  107. ### Request
  108. ```json
  109. {
  110. "merchantNo": "202333",
  111. "storeNo": "301854",
  112. "customerNo": "2000305228289295850180",
  113. "accountTag":"ee1d4197-36aa-4991-952c-0a9b35f505dd",
  114. "verifySign": "700655e94a50e7e3e6115ade9665ae87",
  115. "timestamp": "2022-10-31T07:11:29Z"
  116. }
  117. ```
  118. ### Response
  119. ```json
  120. {
  121. "result": {
  122. "accountTag": "ee1d4197-36aa-4991-952c-0a9b35f505dd",
  123. "country": "CN",
  124. "createdAt": "2022-09-05T18:27:40Z",
  125. "firstName": "俊义",
  126. "lastName": "卢",
  127. "accountType": "BANK_ACCOUNT",
  128. "currency": "CNY",
  129. "accountToken": "2010305228289296332658",
  130. "customerNo": "2000305228289295850180",
  131. "email": "[email protected]",
  132. "cardNumber": "****5655",
  133. "status": "activated"
  134. },
  135. "ret_msg": "success",
  136. "ret_code": "000100"
  137. }
  138. ```
  139. ## 查询失败,payee账号待审核
  140. ### Request
  141. ```json
  142. {
  143. "merchantNo": "202333",
  144. "storeNo": "301854",
  145. "customerNo": "2000305228294092293550",
  146. "verifySign": "b7168db325fa9a3c49e8b62fd2dab4ff",
  147. "timestamp": "2022-10-31T06:51:20Z"
  148. }
  149. ```
  150. ### Response
  151. ```json
  152. {
  153. "ret_code": "000040",
  154. "ret_msg": "payee status Unverified"
  155. }
  156. ```