|
|
@@ -1,18 +1,18 @@
|
|
|
-# AllPay Integration Specification V5.0.0
|
|
|
-[Shanghai AllPay Technology Co., Ltd.](https://www.allpayx.com)
|
|
|
+# GoAllPay Integration Specification V5.0.0
|
|
|
+[Shanghai GoAllPay Technology Co., Ltd.](https://www.goallpayx.com)
|
|
|
|
|
|
* Version:English V5.0.0
|
|
|
* Update Time:2019/04
|
|
|
|
|
|
## 1.Overview
|
|
|
-AllPay provides customers with unified API access to help them implement fast, secure and centralized access payment channels.
|
|
|
+GoAllPay provides customers with unified API access to help them implement fast, secure and centralized access payment channels.
|
|
|
## 2.Transaction process
|
|
|
|
|
|
## 3.Description of verifying the signature
|
|
|
```
|
|
|
-1.For a POST request message sent to the AllPay system, in which all incoming parameters (except signature parameters) according to the field name of ASCII smallest sequence (dictionary), using the format of the URL key/value pair (key1 = value1 & key2 = value2... ) spliced into a string String1.
|
|
|
+1.For a POST request message sent to the GoAllPay system, in which all incoming parameters (except signature parameters) according to the field name of ASCII smallest sequence (dictionary), using the format of the URL key/value pair (key1 = value1 & key2 = value2... ) spliced into a string String1.
|
|
|
|
|
|
-2.At the end of String1, the signature Key (assigned at AllPay upon access) agreed by both parties is spliced directly (no need to connect with "&"), resulting in a stringSignTemp string, and an encryption on stringSignTemp to get the value of signature.
|
|
|
+2.At the end of String1, the signature Key (assigned at GoAllPay upon access) agreed by both parties is spliced directly (no need to connect with "&"), resulting in a stringSignTemp string, and an encryption on stringSignTemp to get the value of signature.
|
|
|
|
|
|
3.Sample signature string: acqID=99020344&backURL=https://www.allpayx.com&charSet=UTF-8&detailInfo=W3siZ29vZHNfbmFtZSI6IuiLueaenCIsInF1YW50aXR5IjoiMyJ9LHsiZ29vZHNfbmFtZSI6IuapmOWtkCIsInF1YW50aXR5IjoiNyJ9XQ==&frontURL=https://www.baidu.com&goodsInfo=apple&merID=000000000000015&merReserve=iPhone&orderAmount=0.01&orderCurrency=USD&orderNum=20190104022800&paymentSchema=AP&signType=MD5&transTime=20190104022800&transType=PURC&version=VER0000000052f2c77e3718c47cfb47a89a6fbc9d361
|
|
|
```
|
|
|
@@ -31,7 +31,10 @@ Common interface includes notification, asynchronous notification of transaction
|
|
|
| Pre-authorization | https://testapi.allpayx.com/api/unifiedorder | https://api.allpayx.com/api/unifiedorder |
|
|
|
| Pre-authorization completed | https://testapi.allpayx.com/api/pauc | https://api.allpayx.com/api/pauc |
|
|
|
| Cancellation | https://testapi.allpayx.com/api/canc | https://api.allpayx.com/api/canc |
|
|
|
-| Manual refund | https://testapi.allpayx.com/api/manrefd | https://api.allpayx.com/api/manrefd |
|
|
|
+| Manual refund application | https://testapi.allpayx.com/api/refdreq | https://api.allpayx.com/api/refdreq |
|
|
|
+| Card binding | https://testapi.allpayx.com/api/bindCard | https://api.allpayx.com/api/bindCard |
|
|
|
+| Card unbundling | https://testapi.allpayx.com/api/unBindCard | https://api.allpayx.com/api/unBindCard |
|
|
|
+| Card payment | https://testapi.allpayx.com/api/bindPay | https://api.allpayx.com/api/bindPay |
|
|
|
|
|
|
### 4.2 Purchase interface
|
|
|
|
|
|
@@ -53,7 +56,7 @@ This field is a list of common fields, sending, every channel needs some channel
|
|
|
| orderCurrency | String(3) | M | Currency of the order: ISO standard, such as RMB filling in "CNY", US dollar filling in "USD" |
|
|
|
| frontURL | String(400) | M | When the payment is complete, jump to the address |
|
|
|
| backURL | String(400) | M | Payment results are asynchronously notified to this address |
|
|
|
-| merID | String(15) | M | Merchant ID, assigned by AllPay |
|
|
|
+| merID | String(15) | M | Merchant ID, assigned by GoAllPay |
|
|
|
| acqID | String(11) | M | "99020344" |
|
|
|
| paymentSchema | String(10) | M | Channel code:[Click Here](https://git.allpayx.com/OpenAPI/common/src/master/paymentSchema.md) |
|
|
|
| goodsInfo | String(60) | M | Commodity information, displayed on the payment page |
|
|
|
@@ -65,9 +68,9 @@ This field is a list of common fields, sending, every channel needs some channel
|
|
|
|
|
|
3.Jump transformation Purchase interface response message
|
|
|
|
|
|
- The merchant needs to provide an HTTP/HTTPS protocol interface that is included in the parameters passed to the SDK, the backURL. After the payment is complete, the AllPay server will call the backURL as a POST, informing the payment result (JSON). When merchant receive the notification, the merchant is required to response String "OK".
|
|
|
+ The merchant needs to provide an HTTP/HTTPS protocol interface that is included in the parameters passed to the SDK, the backURL. After the payment is complete, the GoAllPay server will call the backURL as a POST, informing the payment result (JSON). When merchant receive the notification, the merchant is required to response String "OK".
|
|
|
|
|
|
- If we didn't receive "OK" from merchant，AllPay will resend the response message to merchant.Time interval is[15, 15, 30, 180, 1800, 3600, 7200, 14400, 14400], the unit is second.
|
|
|
+ If we didn't receive "OK" from merchant，GoAllPay will resend the response message to merchant.Time interval is[15, 15, 30, 180, 1800, 3600, 7200, 14400, 14400], the unit is second.
|
|
|
|
|
|
Parameters as follows:
|
|
|
|
|
|
@@ -79,7 +82,7 @@ Parameters as follows:
|
|
|
| orderNum | String(60) | M | Order number |
|
|
|
| orderAmount | String(12) | M | Order amount: if 100 yuan, it will be 100 or 100.00 |
|
|
|
| orderCurrency | String(3) | M | Currency of the order: ISO standard, such as RMB filling in "CNY", us dollar filling in "USD" |
|
|
|
-| merID | String(15) | M | Merchant ID, assigned by AllPay |
|
|
|
+| merID | String(15) | M | Merchant ID, assigned by GoAllPay |
|
|
|
| acqID | String(11) | M | "99020344" |
|
|
|
| paymentSchema | String(10) | M | Channel code:[Click Here](https://git.allpayx.com/OpenAPI/common/src/master/paymentSchema.md) |
|
|
|
| RespCode | String(2) | M | 00 stands for success; 01 stands for fail. See Chapter 6 Response Codes in this document for details. |
|
|
|
@@ -113,7 +116,7 @@ Parameters as follows:
|
|
|
| charSet | String(6) | M | "UTF-8" |
|
|
|
| transType | String(4) | M | "INQY" |
|
|
|
| orderNum | String(60) | M | Original payment order number |
|
|
|
-| merID | String(15) | M | Merchant ID, assigned by AllPay |
|
|
|
+| merID | String(15) | M | Merchant ID, assigned by GoAllPay |
|
|
|
| acqID | String(11) | M | "99020344" |
|
|
|
| paymentSchema | String(10) | M | Channel code：[Click Here](https://git.allpayx.com/OpenAPI/common/src/master/paymentSchema.md) |
|
|
|
| transTime | String(14) | M | Transaction time, format :" yyyyMMddHHmmss" |
|
|
|
@@ -129,7 +132,7 @@ Parameters as follows:
|
|
|
| transType | String(4) | M | "INQY" |
|
|
|
| orderNum | String(60) | M | Original payment order number |
|
|
|
| transID | String(32) | M | The unique transaction id generated by the gateway. |
|
|
|
-| merID | String(15) | M | Merchant ID, assigned by AllPay |
|
|
|
+| merID | String(15) | M | Merchant ID, assigned by GoAllPay |
|
|
|
| acqID | String(11) | M | "99020344" |
|
|
|
| paymentSchema | String(10) | M | Channel code：[Click Here](https://git.allpayx.com/OpenAPI/common/src/master/paymentSchema.md) |
|
|
|
| RespCode | String(2) | M | 00 stands for success; 01 stands for fail. See Chapter 6 Response Codes in this document for details. |
|
|
|
@@ -157,7 +160,7 @@ Parameters as follows:
|
|
|
|
|
|
2.Request message format
|
|
|
|
|
|
-| Parameter | Type | Required | Description |
|
|
|
+| Parameter | Type | Required | Description |
|
|
|
| ------------- | ---------- | ---- | ------------------------------------------------------------ |
|
|
|
| version | String(12) | M | "VER000000005" |
|
|
|
| charSet | String(6) | M | "UTF-8" |
|
|
|
@@ -166,7 +169,7 @@ Parameters as follows:
|
|
|
| origOrderNum | String(60) | M | Original trade order number |
|
|
|
| returnAmount | String(12) | M | Refund amount: if 100 yuan, it is 100 or 100.00 |
|
|
|
| orderCurrency | String(3) | M | Currency of the order: ISO standard, such as RMB filling in "CNY", us dollar filling in "USD" |
|
|
|
-| merID | String(15) | M | Merchant ID, assigned by AllPay |
|
|
|
+| merID | String(15) | M | Merchant ID, assigned by GoAllPay |
|
|
|
| paymentSchema | String(10) | M | Channel code:[Click Here](https://git.allpayx.com/OpenAPI/common/src/master/paymentSchema.md) |
|
|
|
| acqID | String(11) | M | "99020344" |
|
|
|
| transTime | String(14) | M | Transaction time, format :" yyyyMMddHHmmss" |
|
|
|
@@ -175,14 +178,14 @@ Parameters as follows:
|
|
|
|
|
|
3.Response message format
|
|
|
|
|
|
-| Parameter | Type | Required | Description |
|
|
|
+| Parameter | Type | Required | Description |
|
|
|
| --------- | ---------- | ---- | ---------------------------------------------- |
|
|
|
| version | String(12) | M | "VER000000005" |
|
|
|
| charSet | String(6) | M | "UTF-8" |
|
|
|
| transType | String(4) | M | "REFD" |
|
|
|
| orderNum | String(60) | M | Refund order number |
|
|
|
| transID | String(32) | M | The unique transaction id generated by the gateway. |
|
|
|
-| merID | String(15) | M | Merchant ID, assigned by AllPay |
|
|
|
+| merID | String(15) | M | Merchant ID, assigned by GoAllPay |
|
|
|
| acqID | String(11) | M | "99020344" |
|
|
|
| paymentSchema | String(10) | M | Channel code：[Click Here](https://git.allpayx.com/OpenAPI/common/src/master/paymentSchema.md) |
|
|
|
| RespCode | String(2) | M | 00 stands for success; 01 stands for fail. See Chapter 6 Response Codes in this document for details. |
|
|
|
@@ -214,7 +217,7 @@ Parameters as follows:
|
|
|
| charSet | String(6) | M | "UTF-8" |
|
|
|
| transType | String(4) | M | "RFQY" |
|
|
|
| orderNum | String(60) | M | Refund order number |
|
|
|
-| merID | String(15) | M | Merchant ID, assigned by AllPay |
|
|
|
+| merID | String(15) | M | Merchant ID, assigned by GoAllPay |
|
|
|
| acqID | String(11) | M | "99020344" |
|
|
|
| paymentSchema | String(10) | M | Channel code:[Click Here](https://git.allpayx.com/OpenAPI/common/src/master/paymentSchema.md) |
|
|
|
| transTime | String(14) | M | Transaction time, format :" yyyyMMddHHmmss" |
|
|
|
@@ -230,7 +233,7 @@ Parameters as follows:
|
|
|
| transType | String(4) | M | "RFQY" |
|
|
|
| orderNum | String(60) | M | Refund order number |
|
|
|
| transID | String(32) | M | The unique transaction id generated by the gateway. |
|
|
|
-| merID | String(15) | M | Merchant ID, assigned by AllPay |
|
|
|
+| merID | String(15) | M | Merchant ID, assigned by GoAllPay |
|
|
|
| acqID | String(11) | M | "99020344" |
|
|
|
| paymentSchema | String(10) | M | Channel code:[Click Here](https://git.allpayx.com/OpenAPI/common/src/master/paymentSchema.md) |
|
|
|
| RespCode | String(2) | M | 00 stands for success; 01 stands for fail. See Chapter 6 Response Codes in this document for details. |
|
|
|
@@ -260,7 +263,7 @@ Parameters as follows:
|
|
|
| orderCurrency | String(3) | M | Currency of the order: ISO standard, such as RMB filling in "CNY", US dollar filling in "USD" |
|
|
|
| frontURL | String(400) | M | When the payment is complete, jump to the address |
|
|
|
| backURL | String(400) | M | Payment results are asynchronously notified to this address |
|
|
|
-| merID | String(15) | M | Merchant ID, assigned by AllPay |
|
|
|
+| merID | String(15) | M | Merchant ID, assigned by GoAllPay |
|
|
|
| acqID | String(11) | M | "99020344" |
|
|
|
| paymentSchema | String(10) | M | Channel code: "FC" |
|
|
|
| goodsInfo | String(60) | M | Commodity information, displayed on the payment page |
|
|
|
@@ -272,9 +275,9 @@ Parameters as follows:
|
|
|
|
|
|
3.Response message
|
|
|
|
|
|
- The merchant needs to provide an HTTP/HTTPS protocol interface that is included in the parameters passed to the SDK, the backURL. After the payment is complete, the AllPay server will call the backURL as a POST, informing the payment result (JSON). When merchant receive the notification, the merchant is required to response String "OK".
|
|
|
+ The merchant needs to provide an HTTP/HTTPS protocol interface that is included in the parameters passed to the SDK, the backURL. After the payment is complete, the GoAllPay server will call the backURL as a POST, informing the payment result (JSON). When merchant receive the notification, the merchant is required to response String "OK".
|
|
|
|
|
|
- If we didn't receive "OK" from merchant，AllPay will resend the response message to merchant.Time interval is[15, 15, 30, 180, 1800, 3600, 7200, 14400, 14400], the unit is second.
|
|
|
+ If we didn't receive "OK" from merchant，GoAllPay will resend the response message to merchant.Time interval is[15, 15, 30, 180, 1800, 3600, 7200, 14400, 14400], the unit is second.
|
|
|
|
|
|
Parameters as follows:
|
|
|
|
|
|
@@ -286,7 +289,7 @@ Parameters as follows:
|
|
|
| orderNum | String(60) | M | Order number |
|
|
|
| orderAmount | String(12) | M | Order amount: if 100 yuan, it will be 100 or 100.00 |
|
|
|
| orderCurrency | String(3) | M | Currency of the order: ISO standard, such as RMB filling in "CNY", US dollar filling in "USD" |
|
|
|
-| merID | String(15) | M | Merchant ID, assigned by AllPay |
|
|
|
+| merID | String(15) | M | Merchant ID, assigned by GoAllPay |
|
|
|
| acqID | String(11) | M | "99020344" |
|
|
|
| paymentSchema | String(10) | M | Channel code: "FC" |
|
|
|
| RespCode | String(2) | M | 00 stands for success; 01 stands for fail. See Chapter 6 Response Codes in this document for details. |
|
|
|
@@ -325,7 +328,7 @@ Parameters as follows:
|
|
|
| origOrderNum | String(60) | M | Pre-authorized order number |
|
|
|
| orderAmount | String(12) | M | Order amount: if 100 yuan, it will be 100 or 100.00 |
|
|
|
| orderCurrency | String(3) | M | Currency of the order: ISO standard, such as RMB filling in "CNY", US dollar filling in "USD" |
|
|
|
-| merID | String(15) | M | Merchant ID, assigned by AllPay |
|
|
|
+| merID | String(15) | M | Merchant ID, assigned by GoAllPay |
|
|
|
| acqID | String(11) | M | "99020344" |
|
|
|
| paymentSchema | String(10) | M | Channel code: "FC" |
|
|
|
| transTime | String(14) | M | Transaction time, format :" yyyyMMddHHmmss" |
|
|
|
@@ -341,7 +344,7 @@ Parameters as follows:
|
|
|
| transType | String(4) | M | "PAUC" |
|
|
|
| orderNum | String(60) | M | Order number |
|
|
|
| transID | String(32) | M | The unique transaction id generated by the gateway. |
|
|
|
-| merID | String(15) | M | Merchant ID, assigned by AllPay |
|
|
|
+| merID | String(15) | M | Merchant ID, assigned by GoAllPay |
|
|
|
| acqID | String(11) | M | "99020344" |
|
|
|
| paymentSchema | String(10) | M | Channel code: "FC" |
|
|
|
| RespCode | String(2) | M | 00 stands for success; 01 stands for fail. See Chapter 6 Response Codes in this document for details. |
|
|
|
@@ -375,7 +378,7 @@ Parameters as follows:
|
|
|
| transType | String(4) | M | "VOID" |
|
|
|
| orderNum | String(60) | M | Order number: it is defined by the merchant itself, and the order number must not be repeated for the same merchant number |
|
|
|
| origOrderNum | String(60) | M | Original transaction order number: The order number to be revoked, which can be consumption, pre-authorization, pre-authorization completed orderNum |
|
|
|
-| merID | String(15) | M | Merchant ID, assigned by AllPay |
|
|
|
+| merID | String(15) | M | Merchant ID, assigned by GoAllPay |
|
|
|
| acqID | String(11) | M | "99020344" |
|
|
|
| paymentSchema | String(10) | M | Channel code: "FC" |
|
|
|
| transTime | String(14) | M | Transaction time, format :" yyyyMMddHHmmss" |
|
|
|
@@ -391,7 +394,7 @@ Parameters as follows:
|
|
|
| transType | String(4) | M | "VOID" |
|
|
|
| orderNum | String(60) | M | Order number of cancellation |
|
|
|
| transID | String(32) | M | The unique transaction id generated by the gateway. |
|
|
|
-| merID | String(15) | M | Merchant ID, assigned by AllPay |
|
|
|
+| merID | String(15) | M | Merchant ID, assigned by GoAllPay |
|
|
|
| acqID | String(11) | M | "99020344" |
|
|
|
| paymentSchema | String(10) | M | Channel code: "FC" |
|
|
|
| RespCode | String(2) | M | 00 stands for success; 01 stands for fail. See Chapter 6 Response Codes in this document for details. |
|
|
|
@@ -401,7 +404,7 @@ Parameters as follows:
|
|
|
| signType | String(10) | M | "MD5" or "SHA256" |
|
|
|
| signature | String(32) | M | MD5 or SHA256 signature |
|
|
|
|
|
|
-### 4.9 Manual refund interface
|
|
|
+### 4.9 Manual refund application interface
|
|
|
|
|
|
1.Interface specification
|
|
|
|
|
|
@@ -413,12 +416,12 @@ To refund the transaction before 90 days, the merchant can't process the online
|
|
|
| ------------- | ---------- | ---- | ------------------------------------------------------------ |
|
|
|
| version | String(12) | M | "VER000000005" |
|
|
|
| charSet | String(6) | M | "UTF-8" |
|
|
|
-| transType | String(4) | M | "MANREFD" |
|
|
|
+| transType | String(4) | M | "REFDREQ" |
|
|
|
| orderNum | String(60) | M | Refund order number: it is defined by the merchant, and the refund order number under the same merchant number cannot be repeated |
|
|
|
| origOrderNum | String(60) | M | Original trade order number |
|
|
|
| returnAmount | String(12) | M | Refund amount: if 100 yuan, it is 100 or 100.00 |
|
|
|
| orderCurrency | String(3) | M | Currency of the order: ISO standard, such as RMB filling in "CNY", us dollar filling in "USD" |
|
|
|
-| merID | String(15) | M | Merchant ID, assigned by AllPay |
|
|
|
+| merID | String(15) | M | Merchant ID, assigned by GoAllPay |
|
|
|
| paymentSchema | String(10) | M | Channel code: "FC" |
|
|
|
| acqID | String(11) | M | "99020344" |
|
|
|
| transTime | String(14) | M | Transaction time, format :" yyyyMMddHHmmss" |
|
|
|
@@ -427,14 +430,14 @@ To refund the transaction before 90 days, the merchant can't process the online
|
|
|
|
|
|
3.Response message format
|
|
|
|
|
|
-| Parameter | Type | Required | Description |
|
|
|
+| Parameter | Type | Required | Description |
|
|
|
| --------- | ---------- | ---- | ---------------------------------------------- |
|
|
|
| version | String(12) | M | "VER000000005" |
|
|
|
| charSet | String(6) | M | "UTF-8" |
|
|
|
-| transType | String(4) | M | "MANREFD" |
|
|
|
+| transType | String(4) | M | "REFDREQ" |
|
|
|
| orderNum | String(60) | M | Refund order number |
|
|
|
| transID | String(32) | M | The unique transaction id generated by the gateway. |
|
|
|
-| merID | String(15) | M | Merchant ID, assigned by AllPay |
|
|
|
+| merID | String(15) | M | Merchant ID, assigned by GoAllPay |
|
|
|
| acqID | String(11) | M | "99020344" |
|
|
|
| paymentSchema | String(10) | M | Channel code: "FC" |
|
|
|
| RespCode | String(2) | M | 00 means the application has been accepted |
|
|
|
@@ -444,6 +447,141 @@ To refund the transaction before 90 days, the merchant can't process the online
|
|
|
| signType | String(10) | M | "MD5" or "SHA256" |
|
|
|
| signature | String(32) | M | MD5 or SHA256 signature |
|
|
|
|
|
|
+### 4.10 Card binding interface
|
|
|
+
|
|
|
+1.Interface specification
|
|
|
+
|
|
|
+ Provide users with card binding function
|
|
|
+
|
|
|
+2.Request message format
|
|
|
+
|
|
|
+| Parameter | Type | Required | Description |
|
|
|
+| ------------- | ----------- | ---- | ---------------------------------------------------------- |
|
|
|
+| version | String(12) | M | "VER000000005" |
|
|
|
+| transType | String(10) | M | "BIND" |
|
|
|
+| orderNum | String(60) | M | Order number: it is defined by the merchant itself, and the order number must not be repeated for the same merchant number |
|
|
|
+| orderCurrency | String(3) | M | Currency of the order: ISO standard, such as RMB filling in "CNY", us dollar filling in "USD" |
|
|
|
+| customerId | String(60) | M | User ID: It is defined by the merchant, and it cannot be repeated under the same merchant number. |
|
|
|
+| frontURL | String(400) | M | Binding result front-end jump address |
|
|
|
+| backURL | String(400) | M | After binding successfully, it will be notified to this address asynchronously |
|
|
|
+| merID | String(15) | M | Merchant ID, assigned by GoAllPay |
|
|
|
+| paymentSchema | String(10) | M | Channel code: "FC" |
|
|
|
+| transTime | String(14) | M | Transaction time, format :" yyyyMMddHHmmss" |
|
|
|
+| signType | String(10) | M | "MD5" or "SHA256" |
|
|
|
+| signature | String(32) | M | MD5 or SHA256 signature |
|
|
|
+
|
|
|
+3.Response message format
|
|
|
+
|
|
|
+| Parameter | Type | Required | Description |
|
|
|
+| ------------- | ---------- | ---- | ---------------------------------------------------------- |
|
|
|
+| version | String(12) | M | "VER000000005" |
|
|
|
+| transType | String(10) | M | "BIND" |
|
|
|
+| orderNum | String(60) | M | Order number: it is defined by the merchant itself, and the order number must not be repeated for the same merchant number |
|
|
|
+| transID | String(32) | M | The unique transaction id generated by the gateway. |
|
|
|
+| merID | String(15) | M | Merchant ID, assigned by GoAllPay |
|
|
|
+| paymentSchema | String(10) | M | Channel code: "FC" |
|
|
|
+| RespCode | String(2) | M | 00 stands for success; 01 stands for fail. See Chapter 6 Response Codes in this document for details. |
|
|
|
+| RespMsg | String(20) | M | Response message |
|
|
|
+| token | String(32) | O | Returned when the response code is 00 |
|
|
|
+| customerId | String(60) | O | User ID: It is defined by the merchant, and it cannot be repeated under the same merchant number. |
|
|
|
+| cardNoTail | String(4) | O | The last four digits of the card number, return when the channel is FC |
|
|
|
+| transTime | String(14) | M | Transaction time, format :" yyyyMMddHHmmss" |
|
|
|
+| GWTime | String(14) | M | yyyyMMddHHmmss this should be a GWtime, currently is local transaction time |
|
|
|
+| signType | String(10) | M | "MD5" or "SHA256" |
|
|
|
+| signature | String(32) | M | MD5 or SHA256 signature |
|
|
|
+
|
|
|
+### 4.11 Card unbundling interface
|
|
|
+
|
|
|
+1.Interface specification
|
|
|
+
|
|
|
+ Unbound card
|
|
|
+
|
|
|
+2.Request message format
|
|
|
+
|
|
|
+| Parameter | Type | Required | Description |
|
|
|
+| ------------- | ---------- | ---- | ---------------------------------------------------------- |
|
|
|
+| version | String(12) | M | "VER000000005" |
|
|
|
+| transType | String(10) | M | "UNBIND" |
|
|
|
+| orderNum | String(60) | M | Order number: it is defined by the merchant itself, and the order number must not be repeated for the same merchant number |
|
|
|
+| orderCurrency | String(3) | M | Currency of the order: ISO standard, such as RMB filling in "CNY", us dollar filling in "USD" |
|
|
|
+| customerId | String(60) | M | User ID: It is defined by the merchant, and it cannot be repeated under the same merchant number. |
|
|
|
+| token | String(32) | M | The token returned after the card is successfully bound |
|
|
|
+| merID | String(15) | M | Merchant ID, assigned by GoAllPay |
|
|
|
+| paymentSchema | String(10) | M | Channel code: "FC" |
|
|
|
+| transTime | String(14) | M | Transaction time, format :" yyyyMMddHHmmss" |
|
|
|
+| signType | String(10) | M | "MD5" or "SHA256" |
|
|
|
+| signature | String(32) | M | MD5 or SHA256 signature |
|
|
|
+
|
|
|
+3.Response message format
|
|
|
+
|
|
|
+| Parameter | Type | Required | Description |
|
|
|
+| ------------- | ---------- | ---- | ---------------------------------------------------------- |
|
|
|
+| version | String(12) | M | "VER000000005" |
|
|
|
+| transType | String(10) | M | "UNBIND" |
|
|
|
+| orderNum | String(60) | M | Order number: it is defined by the merchant itself, and the order number must not be repeated for the same merchant number |
|
|
|
+| transID | String(32) | M | The unique transaction id generated by the gateway. |
|
|
|
+| merID | String(15) | M | Merchant ID, assigned by GoAllPay |
|
|
|
+| paymentSchema | String(10) | M | Channel code: "FC" |
|
|
|
+| RespCode | String(2) | M | 00 stands for success; 01 stands for fail. See Chapter 6 Response Codes in this document for details. |
|
|
|
+| RespMsg | String(20) | M | Response message |
|
|
|
+| customerId | String(60) | O | User ID: It is defined by the merchant, and it cannot be repeated under the same merchant number. |
|
|
|
+| cardNoTail | String(4) | O | The last four digits of the card number, return when the channel is FC |
|
|
|
+| token | String(32) | O | token |
|
|
|
+| transTime | String(14) | M | Transaction time, format :" yyyyMMddHHmmss" |
|
|
|
+| GWTime | String(14) | M | yyyyMMddHHmmss this should be a GWtime, currently is local transaction time |
|
|
|
+| signType | String(10) | M | "MD5" or "SHA256" |
|
|
|
+| signature | String(32) | M | MD5 or SHA256 signature |
|
|
|
+
|
|
|
+### 4.12 Card payment interface
|
|
|
+
|
|
|
+1.Interface specification
|
|
|
+
|
|
|
+ Card-tied consumer payment, debits the user based on the token returned when the card was tied.
|
|
|
+
|
|
|
+2.Request message format
|
|
|
+
|
|
|
+| Parameter | Type | Required | Description |
|
|
|
+| ------------- | ------------ | ---- | ------------------------------------------------------------ |
|
|
|
+| version | String(12) | M | "VER000000005" |
|
|
|
+| charSet | String(6) | M | "UTF-8" |
|
|
|
+| transType | String(4) | M | "PURC" |
|
|
|
+| orderNum | String(60) | M | Order number: it is defined by the merchant itself, and the order number must not be repeated for the same merchant number |
|
|
|
+| orderAmount | String(12) | M | Order amount: if 100 yuan, it will be 100 or 100.00 |
|
|
|
+| orderCurrency | String(3) | M | Currency of the order: ISO standard, such as RMB filling in "CNY", us dollar filling in "USD" |
|
|
|
+| backURL | String(400) | M | Payment results are asynchronously notified to this address |
|
|
|
+| customerId | String(60) | M | User ID: It is defined by the merchant, and it cannot be repeated under the same merchant number. |
|
|
|
+| token | String(32) | M | The token returned after the card is successfully bound |
|
|
|
+| merID | String(15) | M | Merchant ID, assigned by GoAllPay |
|
|
|
+| acqID | String(11) | M | "99020344" |
|
|
|
+| paymentSchema | String(10) | M | Channel code: "FC" |
|
|
|
+| detailInfo | String(400) | M | Product details format: [{"goods_name":"iPhone X","quantity":"2"},{"goods_name":"iPhone 8","quantity":"4"}], which requires base-64 encoding of this field before signing and sending. |
|
|
|
+| transTime | String(14) | M | Transaction time, format :" yyyyMMddHHmmss" |
|
|
|
+| merReserve | String(1024) | O | Merchant reserved content, can pass any content, such as purchase information, account number, etc., but do not pass special symbols, such as commas. |
|
|
|
+| signType | String(10) | M | "MD5" or "SHA256" |
|
|
|
+| signature | String(32) | M | MD5 or SHA256 signature |
|
|
|
+
|
|
|
+3.Response message format
|
|
|
+
|
|
|
+| Parameter | Type | Required | Description |
|
|
|
+| ------------- | ------------ | ---- | ------------------------------------------------------------ |
|
|
|
+| version | String(12) | M | "VER000000005" |
|
|
|
+| charSet | String(6) | M | "UTF-8" |
|
|
|
+| transType | String(4) | M | "PURC" |
|
|
|
+| orderNum | String(60) | M | Order number: it is defined by the merchant itself, and the order number must not be repeated for the same merchant number |
|
|
|
+| orderAmount | String(12) | M | Order amount: if 100 yuan, it will be 100 or 100.00 |
|
|
|
+| orderCurrency | String(3) | M | Currency of the order: ISO standard, such as RMB filling in "CNY", us dollar filling in "USD" |
|
|
|
+| merID | String(15) | M | Merchant ID, assigned by GoAllPay |
|
|
|
+| acqID | String(11) | M | "99020344" |
|
|
|
+| paymentSchema | String(10) | M | Channel code: "FC" |
|
|
|
+| RespCode | String(2) | M | 00 stands for success; 01 stands for fail. See Chapter 6 Response Codes in this document for details. |
|
|
|
+| RespMsg | String(20) | M | Response message |
|
|
|
+| transID | String(32) | M | The unique transaction id generated by the gateway. |
|
|
|
+| GWTime | String(14) | M | yyyyMMddHHmmss this should be a GWtime, currently is local transaction time |
|
|
|
+| transTime | String(14) | M | Transaction time, format :" yyyyMMddHHmmss" |
|
|
|
+| merReserve | String(1024) | O | Merchant reserved content, can pass any content, such as purchase information, account number, etc., but do not pass special symbols, such as commas. |
|
|
|
+| signType | String(10) | M | "MD5" or "SHA256" |
|
|
|
+| signature | String(32) | M | MD5 or SHA256 signature |
|
|
|
+
|
|
|
## 5.Channel exclusive allocation
|
|
|
|
|
|
### 5.1 WX
|
|
|
@@ -468,7 +606,7 @@ Response message:
|
|
|
|
|
|
#### 5.1.2 QR code jump mode
|
|
|
|
|
|
-It's jump mode, open the front-end page provided by AllPay, which contains WeChat QR code.
|
|
|
+It's jump mode, open the front-end page provided by GoAllPay, which contains WeChat QR code.
|
|
|
|
|
|
Purchase interface specific fields
|
|
|
|
|
|
@@ -776,6 +914,24 @@ Response message:
|
|
|
| RespMsg | String | M | Response message |
|
|
|
| code_url | String | O | Characters to generate QR code. When RespCode=00 returns it. |
|
|
|
|
|
|
+#### 5.9.3 APP mode
|
|
|
+
|
|
|
+ Purchase interface specific fields
|
|
|
+
|
|
|
+| Parameter | Type | Required | Description |
|
|
|
+| --------- | ------ | ---- | ----- |
|
|
|
+| tradeFrom | String | M | "APP" |
|
|
|
+
|
|
|
+Response message：
|
|
|
+
|
|
|
+| Parameter | Type | Required | Description |
|
|
|
+| -------- | ------ | ---- | --------------------------------------------------------- |
|
|
|
+| RespCode | String | M | 00 stands for success; 01 stands for fail. |
|
|
|
+| RespMsg | String | M | Response message |
|
|
|
+| tn | String | O | Transaction serial number. Required parameter for Wechat app payment. When RespCode=00 returns it. |
|
|
|
+
|
|
|
+After getting tn, call the SDK to pay according to Section 7 of this document.
|
|
|
+
|
|
|
### 5.10 FC
|
|
|
|
|
|
#### 5.10.1 Purchase/Pre-authorization
|
|
|
@@ -786,21 +942,49 @@ Response message:
|
|
|
| --------- | ------ | ---- | ---- |
|
|
|
| tradeFrom | String | M | "H5" |
|
|
|
|
|
|
+#### 5.10.2 Bound card payment
|
|
|
+
|
|
|
+There are two modes of card binding
|
|
|
+
|
|
|
+(1) The user chooses to add a card on the merchant platform, and then jumps to the card binding page of GoAllPay. The user enters the card number information on this page. If the card binding fails, the merchant will be notified of the failure; if the card binding is successful, "token + customerID + the last four digits of the card number" will be returned to the merchant.
|
|
|
+
|
|
|
+ Exclusive field
|
|
|
+
|
|
|
+| Parameter | Type | Required | Description |
|
|
|
+| --------- | ------ | ---- | ---- |
|
|
|
+| tradeFrom | String | M | "H5" |
|
|
|
+
|
|
|
+(2) The merchant collects the card number information by himself and sends it to the GoAllPay gateway through the API.
|
|
|
+
|
|
|
+ Exclusive field
|
|
|
+
|
|
|
+| Parameter | Type | Required | Description |
|
|
|
+| ---------- | ------ | ---- | ----------------- |
|
|
|
+| tradeFrom | String | M | "API" |
|
|
|
+| cardno | String | M | Card number |
|
|
|
+| cvv2 | String | M | cvv2 |
|
|
|
+| ExpiryDate | String | M | Validity period: Format MM / YY |
|
|
|
+
|
|
|
```javascript
|
|
|
Test card:
|
|
|
|
|
|
Card Number: 4761340000000019
|
|
|
Expiry Date: 1217
|
|
|
CVV2: 830
|
|
|
+
|
|
|
+Card Number: 5204730000002555
|
|
|
+Expiry Date: 1225
|
|
|
+CVV2: 123
|
|
|
```
|
|
|
|
|
|
### 5.11 RevPay
|
|
|
-#### 5.11.1 Purchase
|
|
|
+
|
|
|
+#### 5.11.1 H5 mode
|
|
|
|
|
|
| Parameter | Type | Required | Description |
|
|
|
| --------- | ------ | ---- | -------- |
|
|
|
| tradeFrom | String | M | "H5" |
|
|
|
-| bankCode | String | M | Bank Code，Test bank code:TEST0021，Production[view more](https://git.allpayx.com/OpenAPI/common/src/master/RevPayBankCode.md) |
|
|
|
+| bankCode | String | M | Bank Code. Test environment filled in TEST0021, production environment [click here for details](https://git.allpayx.com/OpenAPI/common/src/master/RevPayBankCode.md) |
|
|
|
|
|
|
```javascript
|
|
|
Test card：
|
|
|
@@ -812,12 +996,9 @@ User Id : 1234
|
|
|
Password : 1234
|
|
|
```
|
|
|
|
|
|
-
|
|
|
### 5.12 Gcash
|
|
|
|
|
|
-#### 5.12.1 H5
|
|
|
-
|
|
|
-
|
|
|
+#### 5.12.1 H5 mode
|
|
|
|
|
|
| Parameter | Type | Required | Description |
|
|
|
| --------- | ------ | ---- | ------- |
|
|
|
@@ -825,24 +1006,22 @@ Password : 1234
|
|
|
|
|
|
### 5.13 PO
|
|
|
|
|
|
-#### 5.13.1 H5
|
|
|
-
|
|
|
-
|
|
|
+#### 5.13.1 H5 mode
|
|
|
|
|
|
| Parameter | Type | Required | Description |
|
|
|
| ----------------- | ------ | ---- | ------------------------------------------------------------ |
|
|
|
| tradeFrom | String | M | "H5" |
|
|
|
| countrycode | String | M | The 2-letter ISO country code of the country in which the payment instrument is issued/operated (e.g. DE). For details see [payment method specific documentation](https://git.allpayx.com/OpenAPI/common/src/master/countrycode.md). |
|
|
|
| accountholdername | String | M | The account holder - minimum of 3 characters, up to 100 charac- ters. |
|
|
|
-| tag | String | M | Value：directpay, boleto, webpay, trustpay, skrill, singpost, sepaddmodela, safetypay, qiwi, p24, poli, paysafecard, mybank, itau, ideal, hipercard, giropay, eps, enets, dragonpay, bancodobrasil, baloto, aura, payu |
|
|
|
+| tag | String | M | Value：directpay, boleto, webpay, trustpay, skrill, singpost, sepaddmodela, safetypay, qiwi, p24, poli, paysafecard, mybank, itau, ideal, hipercard, giropay, eps, enets, dragonpay, bancodobrasil, baloto, aura, payu, bcmc |
|
|
|
|
|
|
-##### 5.13.1.1 when tag is paysafecard, you should add the following parameters:
|
|
|
+##### 5.13.1.1 When tag is paysafecard, you should add the following parameters:
|
|
|
|
|
|
| Parameter | Type | Required | Description |
|
|
|
| ----------- | ------ | ---- | ------------------------------------------------------------ |
|
|
|
| consumerref | String | M | Unique reference identifying the consumer, has to satisfy the regular expression [A-Za-z0-9.%,&/+*$-]{1,20} |
|
|
|
|
|
|
-##### 5.13.1.2 when tag is in aura, baloto, bancodobrasil, boleto, hipercard, itau, webpay , you should add the following parameters:
|
|
|
+##### 5.13.1.2 When tag is in aura, baloto, bancodobrasil, boleto, hipercard, itau, webpay , you should add the following parameters:
|
|
|
|
|
|
| Parameter | Type | Required | Description |
|
|
|
| ----------- | ------ | ---- | ------------------------------------------------------------ |
|
|
|
@@ -853,33 +1032,33 @@ Password : 1234
|
|
|
| zipcode | String | M | Consumer's zip/postal code |
|
|
|
| dob | String | O | Date of birth, format YYYYMMDD |
|
|
|
|
|
|
-##### 5.13.1.3 when tag is in dragonpay, enets, singpost , you should add the following parameters:
|
|
|
+##### 5.13.1.3 When tag is in dragonpay, enets, singpost , you should add the following parameters:
|
|
|
|
|
|
| Parameter | Type | Required | Description |
|
|
|
| ----- | ------ | ---- | ------------------------------------------------------ |
|
|
|
| email | String | M | RFC compliant email address of the account holder |
|
|
|
| phone | String | M | Valid international phone number of the account holder |
|
|
|
|
|
|
-##### 5.13.1.4 when tag is in giropay, directpay, you should add the following parameters:
|
|
|
+##### 5.13.1.4 When tag is in giropay, directpay, you should add the following parameters:
|
|
|
|
|
|
| Parameter | Type | Required | Description |
|
|
|
| ---- | ------ | ---- | ----------------------------------------------------------- |
|
|
|
| bic | String | O | Valid BIC (8 or 11 alphanumeric letters) of consumer’s bank |
|
|
|
|
|
|
-##### 5.13.1.5 when tag is in payu, p24, safetypay, you should add the following parameters:
|
|
|
+##### 5.13.1.5 When tag is in payu, p24, safetypay, you should add the following parameters:
|
|
|
|
|
|
| Parameter | Type | Required | Description |
|
|
|
| ----- | ------ | ---- | ------------------------------------------------- |
|
|
|
| email | String | M | RFC compliant email address of the account holder |
|
|
|
|
|
|
-##### 5.13.1.6 when tag is qiwi, you should add the following parameters:
|
|
|
+##### 5.13.1.6 When tag is qiwi, you should add the following parameters:
|
|
|
|
|
|
| Parameter | Type | Required | Description |
|
|
|
| ----------- | ------ | ---- | ------------------------------------------------------------ |
|
|
|
| mobilephone | String | M | Valid international Russian mobile phone number identifying the QIWI destination account to pay out to (excluding plus sign or any other international prefixes, including a leading 7 for Russia, 11 digits in total, e.g. 71234567890). |
|
|
|
| siteid | String | M | Unique site identifier, forwarded to qiwi. Required for clients serving multiple points of sale. |
|
|
|
|
|
|
-##### 5.13.1.7 when tag is skrill, you should add the following parameters:
|
|
|
+##### 5.13.1.7 When tag is skrill, you should add the following parameters:
|
|
|
|
|
|
| Parameter | Type | Required | Description |
|
|
|
| ------- | ------ | ---- | ------------------------------------------------- |
|
|
|
@@ -888,26 +1067,29 @@ Password : 1234
|
|
|
| zipcode | String | O | Consumer's zip/postal code |
|
|
|
| city | String | O | Consumer’s city |
|
|
|
|
|
|
-##### 5.13.1.8 when tag is is sepaddmodela, you should add the following parameters:
|
|
|
+##### 5.13.1.8 When tag is is sepaddmodela, you should add the following parameters:
|
|
|
|
|
|
| Parameter | Type | Required | Description |
|
|
|
| ----- | ------ | ---- | ------------------------------------------------- |
|
|
|
| email | String | M | RFC compliant email address of the account holder |
|
|
|
| iban | String | M | Valid IBAN |
|
|
|
|
|
|
+##### 5.13.1.9 When tag is bcmc, you should add the following parameters:
|
|
|
|
|
|
-
|
|
|
+| Parameter | Type | Required | Description |
|
|
|
+| ----- | ------ | ---- | ------------------------------------------------- |
|
|
|
+| BEPURL | String | O | Trigger URL for mobile payment options in the form BEP://1BC.GIROGATE.DE/BCMC/123456789$ICAE3BUIH5P9U53Y5HKA9CRT (contrived example). |
|
|
|
|
|
|
### 5.14 India_Netbanking
|
|
|
|
|
|
-#### 5.14.1 purchase
|
|
|
+#### 5.14.1 H5 mode
|
|
|
|
|
|
You should add the following parameters:
|
|
|
|
|
|
| Parameter | Type | Required | Description |
|
|
|
| --------- | ------ | ---- | ---- |
|
|
|
| tradeFrom | String | M | "H5" |
|
|
|
-| bank_code | String | M |see the following bank list |
|
|
|
+| bank_code | String | M | [bank list](https://git.allpayx.com/OpenAPI/common/src/master/India_Netbanking_BankCode.md) |
|
|
|
| email | String | M | Must contain valid e-mail of customer|
|
|
|
| phone | String | M | Must contain valid phone number of customer |
|
|
|
| firstname | String | M | Customer first name |
|
|
|
@@ -919,71 +1101,6 @@ You should add the following parameters:
|
|
|
| state | String | M | State code in ISO 3166-2, required for USA and Canada |
|
|
|
| document_id | String | M | Document ID of the consumer.|
|
|
|
|
|
|
-
|
|
|
-
|
|
|
-| Bank Name | Bank Code |
|
|
|
-| :------------------------------------- | :-------- |
|
|
|
-| Aditya Birla Idea Payments Bank | ABPB |
|
|
|
-| Airtel Payments Bank | AIRP |
|
|
|
-| Allahabad Bank | ALLA |
|
|
|
-| Andhra Bank | ANDB |
|
|
|
-| Bank of Baroda - Retail Banking | BARB_R |
|
|
|
-| Bank of Bahrein and Kuwait | BBKM |
|
|
|
-| Dena Bank | BKDN |
|
|
|
-| Bank of India | BKID |
|
|
|
-| Central Bank of India | CBIN |
|
|
|
-| City Union Bank | CIUB |
|
|
|
-| Canara Bank | CNRB |
|
|
|
-| Corporation Bank | CORP |
|
|
|
-| Cosmos Co-operative Bank | COSB |
|
|
|
-| Catholic Syrian Bank | CSBK |
|
|
|
-| Development Bank of Singapore | DBSS |
|
|
|
-| DCB Bank | DCBL |
|
|
|
-| Deutsche Bank | DEUT |
|
|
|
-| Dhanlaxmi Bank | DLXB |
|
|
|
-| Equitas Small Finance Bank | ESFB |
|
|
|
-| Federal Bank | FDRL |
|
|
|
-| HDFC Bank | HDFC |
|
|
|
-| IDBI | IBKL |
|
|
|
-| ICICI Bank | ICIC |
|
|
|
-| IDFC FIRST Bank | IDFB |
|
|
|
-| Indian Bank | IDIB |
|
|
|
-| Indusind Bank | INDB |
|
|
|
-| Indian Overseas Bank | IOBA |
|
|
|
-| Jammu and Kashmir Bank | JAKA |
|
|
|
-| Janata Sahakari Bank (Pune) | JSBP |
|
|
|
-| Karnataka Bank | KARB |
|
|
|
-| Kotak Mahindra Bank | KKBK |
|
|
|
-| Karur Vysya Bank | KVBL |
|
|
|
-| Lakshmi Vilas Bank - Corporate Banking | LAVB_C |
|
|
|
-| Lakshmi Vilas Bank - Retail Banking | LAVB_R |
|
|
|
-| Bank of Maharashtra | MAHB |
|
|
|
-| NKGSB Co-operative Bank | NKGS |
|
|
|
-| Oriental Bank of Commerce | ORBC |
|
|
|
-| Punjab & Maharashtra Co-operative Bank | PMCB |
|
|
|
-| Punjab & Sind Bank | PSIB |
|
|
|
-| Punjab National Bank - Retail Banking | PUNB_R |
|
|
|
-| RBL Bank | RATN |
|
|
|
-| State Bank of Bikaner and Jaipur | SBBJ |
|
|
|
-| State Bank of Hyderabad | SBHY |
|
|
|
-| State Bank of India | SBIN |
|
|
|
-| State Bank of Mysore | SBMY |
|
|
|
-| State Bank of Travancore | SBTR |
|
|
|
-| Standard Chartered Bank | SCBL |
|
|
|
-| South Indian Bank | SIBL |
|
|
|
-| Saraswat Co-operative Bank | SRCB |
|
|
|
-| State Bank of Patiala | STBP |
|
|
|
-| Shamrao Vithal Co-operative Bank | SVCB |
|
|
|
-| Syndicate Bank | SYNB |
|
|
|
-| Tamilnadu Mercantile Bank | TMBL |
|
|
|
-| Tamilnadu State Apex Co-operative Bank | TNSC |
|
|
|
-| Union Bank of India | UBIN |
|
|
|
-| UCO Bank | UCBA |
|
|
|
-| United Bank of India | UTBI |
|
|
|
-| Axis Bank | UTIB |
|
|
|
-| Vijaya Bank | VIJB |
|
|
|
-| Yes Bank | YESB |
|
|
|
-
|
|
|
## 6.RespCode
|
|
|
|
|
|
| RespCode | Description |
|
