payee APIs

2 years ago · 728f7cb4dd
2 changed files with 105 additions and 19 deletions
--- a/payout/payee.md
+++ b/payout/payee.md
@ -50,6 +50,7 @@
 |DRIVER_LICENSE|驾照|
 |BUSINESS_REGISTRATION_CERT|营业执照|

+###### Individual Registration

 ```json
 {
@ -75,7 +76,7 @@
 }
 ```

-### Response
+###### Response


 |参数名|M/C/O|描述|
@ -97,6 +98,50 @@
 }
 ```

+###### Business registraiton
+
+```json
+{
+    "city": "北京",
+    "country": "中国",
+    "countryCode": "CN",
+    "customerCode": "1667198337",
+    "dateOfBirth": "1999-01-01",
+    "email": "[email protected]",
+    "firstName": "白",
+    "governmentId": "91310115768225450T",
+    "governmentIdType": "BUSINESS_REGISTRATION_CERT",
+    "company":"支付宝",
+    "lastName": "李",
+    "merchantNo": "202333",
+    "profileType": "BUSINESS",
+    "state": "北京",
+    "storeNo": "301854",
+    "street": "长城",
+    "street2": "",
+    "timestamp":"2022-11-08T07:02:42Z",
+    "verifySign": "0df90da9e26240fe3d8cfdaef2e66e9b",
+    "zip": "100000"
+}
+```
+
+###### Response
+
+```json
+{
+    "ret_msg": "success",
+    "ret_code": "000100",
+    "customer": {
+        "firstName": "白",
+        "lastName": "李",
+        "customerCode": "1667198337",
+        "createdTime": "2022-11-08T07:03:28Z",
+        "customerNo": "2000305228294784880996",
+        "email": "[email protected]"
+    }
+}
+```
+
 # 查询

 ---
@ -111,39 +156,53 @@

 ```json
 {
-    "customerCode": "1667198337",
-    "customerNo": "2000305228294092293550",
-    "email": "[email protected]",
+    "customerNo": "2000305228294780373141",
+    "email": "[email protected]",
    "merchantNo": "202333",
    "storeNo": "301854",
-    "timestamp":"2022-10-31T10:13:05Z",
-    "verifySign": "2ed37ef290331e712e1f46b278913b5d"
+    "timestamp":"2022-11-08T06:31:34Z",
+    "verifySign": "1d63dd51b198bc3013b8e102d57c5d7e"
 }
 ```

 ### Response

+###### Payee Statuses
+
+|Status|Description|
+|---|---|
+|Unverified|payee need to sign agreement in the Pockyt Portal|
+|Pending|pending payee to submit supplemental docs|
+|Underreview|pending Pockyt KYC|
+|Activated|ready to add payment methods & receive payouts|
+|Deactivated|offboarded accounts|
+|Declined|rejected accounts|
+
+
 ```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",
+        "zip": "90012",
+        "lastName": "Doe",
+        "country": "China",
+        "updatedTime": "2022-11-08T05:48:20Z",
+        "payeeStatus": "Unverified",
+        "city": "北京市",
+        "customerCode": "123",
+        "dateOfBirth": "1990-03-07",
+        "firstName": "John",
+        "governmentIdType": "ID_CARD",
+        "profileType": "INDIVIDUAL",
        "countryCode": "CN",
        "street": "长城",
-        "createdTime": "2022-10-31T06:40:20Z",
+        "createdTime": "2022-11-08T05:48:20Z",
        "state": "北京",
-        "lang": "en",
-        "customerNo": "2000305228294092293550",
-        "email": "[email protected]"
+        "lang": "zh_CN",
+        "customerNo": "2000305228294780373141",
+        "email": "[email protected]",
+        "governmentId": "110101199003079139"
    }
 }
 ```
--- a/payout/payout-account.md
+++ b/payout/payout-account.md
@ -189,3 +189,30 @@
 }
 ```

+# 删除账号
+
+---
+
+* {Domain}/v3/payee/account/delete
+
+### request 
+
+```json
+{
+    "customerNo": "2000305228294784880996",
+    "accountToken":"2010305228294786604676",
+    "merchantNo": "202333",
+    "storeNo": "301854",
+    "timestamp":"2022-11-08T07:44:18Z",
+    "verifySign": "13a3797b012da9b31b30eec177c6d76b"
+}
+```
+
+### Response
+
+```json
+{
+    "ret_msg": "deleted",
+    "ret_code": "000100"
+}
+```