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.

183 lines
3.7 KiB

2 years ago
2 years ago
2 years ago
  1. # Payee Registration
  2. ---
  3. * {Domain}/v3/payee/register
  4. ### Request
  5. * `governmentIdType`: 中国大陆用户需要使用身份证号码,type = `ID_CARD`
  6. * 注册成功之后,Payee会收到注册通知邮件,根据指引登录Yuansfer Portal提交相关信息,激活账户之后才可以接收转账。
  7. |参数名|描述|
  8. |---|---|
  9. |customerCode|商户系统客户编号|
  10. |dateOfBirth|大于18岁|
  11. |governmentId|中国大陆公民使用居民身份证号码|
  12. |lastName|姓,中国公民使用中文,与身份证姓名一致|
  13. |firstName|名,中国公民使用中文,与身份证姓名一致|
  14. ```json
  15. {
  16. "city": "北京",
  17. "country": "中国",
  18. "countryCode": "CN",
  19. "customerCode": "1667198337",
  20. "dateOfBirth": "1999-01-01",
  21. "email": "[email protected]",
  22. "firstName": "三",
  23. "governmentId": "110101199003074493",
  24. "governmentIdType": "ID_CARD",
  25. "lastName": "张",
  26. "merchantNo": "202333",
  27. "phone": "1234567890",
  28. "profileType": "INDIVIDUAL",
  29. "state": "北京",
  30. "storeNo": "301854",
  31. "street": "长城",
  32. "street2": "",
  33. "verifySign": "141803fb1e21ff977d7fa5f68067860a",
  34. "zip": "100000"
  35. }
  36. ```
  37. ### Response
  38. ```json
  39. {
  40. "ret_msg": "success",
  41. "ret_code": "000100",
  42. "customer": {
  43. "firstName": "三",
  44. "lastName": "张",
  45. "customerCode": "1667198337",
  46. "createdTime": "2022-10-31T06:40:20Z",
  47. "customerNo": "2000305228294092293550",
  48. "email": "[email protected]"
  49. }
  50. }
  51. ```
  52. # 查询
  53. ---
  54. * {Domain}/v3/payee/retrieve
  55. ### Request
  56. * email, customerCode, customerNo 都可以作为查询条件
  57. ```json
  58. {
  59. "customerCode": "1667198337",
  60. "customerNo": "2000305228294092293550",
  61. "email": "[email protected]",
  62. "merchantNo": "202333",
  63. "storeNo": "301854",
  64. "timestamp":"2022-10-31T10:13:05Z",
  65. "verifySign": "2ed37ef290331e712e1f46b278913b5d"
  66. }
  67. ```
  68. ### Response
  69. ```json
  70. {
  71. "ret_msg": "query success",
  72. "ret_code": "000100",
  73. "customer": {
  74. "zip": "100000",
  75. "lastName": "张",
  76. "country": "中国",
  77. "updatedTime": "2022-10-31T06:40:20Z",
  78. "city": "北京",
  79. "customerCode": "1667198337",
  80. "dateOfBirth": "1999-01-01",
  81. "firstName": "三",
  82. "phone": "1234567890",
  83. "countryCode": "CN",
  84. "street": "长城",
  85. "createdTime": "2022-10-31T06:40:20Z",
  86. "state": "北京",
  87. "lang": "en",
  88. "customerNo": "2000305228294092293550",
  89. "email": "[email protected]"
  90. }
  91. }
  92. ```
  93. # 修改
  94. ---
  95. * {Domain}/v3/payee/update
  96. * 已激活(审核通过)的账号不允许再修改,会报错
  97. ### Request
  98. ```json
  99. {
  100. "customerNo":"2000305228294092293550",
  101. "city": "北京",
  102. "country": "中国",
  103. "countryCode": "CN",
  104. "customerCode": "1667198337",
  105. "dateOfBirth": "1999-01-02",
  106. "firstName": "三",
  107. "governmentId": "110101199003074493",
  108. "governmentIdType": "ID_CARD",
  109. "lastName": "张",
  110. "merchantNo": "202333",
  111. "phone": "1234567890",
  112. "profileType": "INDIVIDUAL",
  113. "state": "北京",
  114. "storeNo": "301854",
  115. "street": "中南海",
  116. "street2": "No. 123",
  117. "verifySign": "55704c3e018d7878f3be3f14b472e05f",
  118. "zip": "100001"
  119. }
  120. ```
  121. ### Response
  122. ```json
  123. {
  124. "ret_msg": "update success",
  125. "ret_code": "000100"
  126. }
  127. ```
  128. # 删除
  129. ---
  130. * {Domain}/v3/payee/delete
  131. ### Request
  132. ```json
  133. {
  134. "customerNo": "2000305228294092293550",
  135. "email": "[email protected]",
  136. "merchantNo": "202333",
  137. "storeNo": "301854",
  138. "timestamp":"2022-10-31T10:15:11Z",
  139. "verifySign": "24d8c40c625b0a8645d1bf574f3ba085"
  140. }
  141. ```
  142. ### Response
  143. ```json
  144. {
  145. "ret_msg": "delete success",
  146. "ret_code": "000100"
  147. }
  148. ```