|
|
@@ -20,7 +20,7 @@ GoAllPay provides customers with unified API access to help them implement fast,
|
|
|
|
|
|
Common interface includes notification, asynchronous notification of transactions, transaction inquiry, refund, refund inquiry interface.
|
|
|
|
|
|
-### 4.1 General API access address
|
|
|
+### 4.1 General API access URL
|
|
|
|
|
|
| Interface Name | Test URL | Production URL |
|
|
|
| ------- | ------------------------------------------- | --------------------------------------- |
|
|
|
@@ -42,7 +42,7 @@ Common interface includes notification, asynchronous notification of transaction
|
|
|
|
|
|
This interface provides the function of purchase transaction for access merchants.
|
|
|
|
|
|
-**2.Request message format**
|
|
|
+**2.Request parameters**
|
|
|
|
|
|
It consists of general fields and channel-specific fields. All upload fields must be signed. The consumption interface is divided into a jump type and a parameter return type. The default is a jump type, and the parameter return type will be described in the channel-specific field.
|
|
|
|
|
|
@@ -56,7 +56,7 @@ It consists of general fields and channel-specific fields. All upload fields mus
|
|
|
| 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 |
|
|
|
+| orderAmount | String(12) | M | Order amount: if 100CNY, 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" |
|
|
|
| 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 |
|
|
|
@@ -72,7 +72,7 @@ It consists of general fields and channel-specific fields. All upload fields mus
|
|
|
|
|
|
**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 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".
|
|
|
+ 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 by POST method, 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，GoAllPay will resend the response message to merchant.Time interval is[15, 15, 30, 180, 1800, 3600, 7200, 14400, 14400], the unit is second.
|
|
|
|
|
|
@@ -84,10 +84,10 @@ Parameters as follows:
|
|
|
| charSet | String(6) | M | "UTF-8" |
|
|
|
| transType | String(4) | M | "PURC" |
|
|
|
| orderNum | String(60) | M | Order number |
|
|
|
-| orderAmount | String(12) | M | Order amount: if 100 yuan, it will be 100 or 100.00 |
|
|
|
+| orderAmount | String(12) | M | Order amount: if 100CNY, 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" |
|
|
|
+| merID | String(15) | M | Merchant ID, assigned by GoAllPay |
|
|
|
+| acqID | String(11) | M | "99020344" |
|
|
|
| paymentSchema | String(10) | M | Channel ID |
|
|
|
| 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 |
|
|
|
@@ -95,8 +95,8 @@ Parameters as follows:
|
|
|
| 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 |
|
|
|
+| signType | String(10) | M | "MD5" or "SHA256" |
|
|
|
+| signature | String(32) | M | MD5 or SHA256 signature |
|
|
|
|
|
|
### 4.3 Inqiury interface
|
|
|
|
|
|
@@ -112,7 +112,7 @@ Parameters as follows:
|
|
|
|
|
|
</div>
|
|
|
|
|
|
-**2.Request message format**
|
|
|
+**2.Request parameters**
|
|
|
|
|
|
| Parameter | Type | Required | Description |
|
|
|
| ------------- | ---------- | ---- | ------------------------------------------------------------ |
|
|
|
@@ -127,7 +127,7 @@ Parameters as follows:
|
|
|
| signType | String(10) | M | "MD5" or "SHA256" |
|
|
|
| signature | String(32) | M | MD5 or SHA256 signature |
|
|
|
|
|
|
-**3.Response message format**
|
|
|
+**3.Response parameters**
|
|
|
|
|
|
| Parameter | Type | Required | Description |
|
|
|
| ------------- | ---------- | ---- | ------------------------------------------------------------ |
|
|
|
@@ -162,7 +162,7 @@ Parameters as follows:
|
|
|
|
|
|
</div>
|
|
|
|
|
|
-**2.Request message format**
|
|
|
+**2.Request parameters**
|
|
|
|
|
|
| Parameter | Type | Required | Description |
|
|
|
| ------------- | ---------- | ---- | ------------------------------------------------------------ |
|
|
|
@@ -171,7 +171,7 @@ Parameters as follows:
|
|
|
| transType | String(4) | M | "REFD" |
|
|
|
| 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 |
|
|
|
+| returnAmount | String(12) | M | Refund amount: if 100CNY, 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 GoAllPay |
|
|
|
| paymentSchema | String(10) | M | Channel ID:[Click Here](paymentSchema.md) |
|
|
|
@@ -180,7 +180,7 @@ Parameters as follows:
|
|
|
| signType | String(3) | M | "MD5" or "SHA256" |
|
|
|
| signature | String(32) | M | MD5 or SHA256 signature |
|
|
|
|
|
|
-**3.Response message format**
|
|
|
+**3.Response parameters**
|
|
|
|
|
|
| Parameter | Type | Required | Description |
|
|
|
| --------- | ---------- | ---- | ---------------------------------------------- |
|
|
|
@@ -213,7 +213,7 @@ Parameters as follows:
|
|
|
|
|
|
</div>
|
|
|
|
|
|
-**2.Request message format**
|
|
|
+**2.Request parameters**
|
|
|
|
|
|
| Parameter | Type | Required | Description |
|
|
|
| ------------- | ---------- | ---- | ------------------------------------------------------------ |
|
|
|
@@ -228,10 +228,10 @@ Parameters as follows:
|
|
|
| signType | String(10) | M | "MD5" or "SHA256" |
|
|
|
| signature | String(32) | M | MD5 or SHA256 signature |
|
|
|
|
|
|
-**3.Response message format**
|
|
|
+**3.Response parameters**
|
|
|
|
|
|
-| Parameter | Type | Required | Description |
|
|
|
-| ------------- | ---------- | ---- | ------------------------------------------------------------ |
|
|
|
+| Parameter | Type | Required | Description |
|
|
|
+| ------------- | ---------- | ---- | ------------------ |
|
|
|
| version | String(12) | M | "VER000000005" |
|
|
|
| charSet | String(6) | M | "UTF-8" |
|
|
|
| transType | String(4) | M | "RFQY" |
|
|
|
@@ -242,8 +242,8 @@ Parameters as follows:
|
|
|
| paymentSchema | String(10) | M | Channel ID |
|
|
|
| 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 |
|
|
|
-| transTime | String(14) | M | Transaction time, format :" yyyyMMddHHmmss" |
|
|
|
-| GWTime | String(14) | M | yyyyMMddHHmmss this should be a GWtime, currently is local transaction time |
|
|
|
+| 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 |
|
|
|
|
|
|
@@ -253,7 +253,7 @@ Parameters as follows:
|
|
|
|
|
|
The pre-authorization interface is applicable to foreign card (including VISA, MasterCard, JCB and other card brands) and UnionPay card transactions. Pre-authorized transactions will not participate in liquidation, and the issuing bank will temporarily freeze user funds.
|
|
|
|
|
|
-**2.Request message format**
|
|
|
+**2.Request parameters**
|
|
|
|
|
|
It consists of general fields and channel-specific fields. All upload fields must be signed.
|
|
|
|
|
|
@@ -267,7 +267,7 @@ Parameters as follows:
|
|
|
| charSet | String(6) | M | "UTF-8" |
|
|
|
| transType | String(4) | M | "PAUT" |
|
|
|
| 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 |
|
|
|
+| orderAmount | String(12) | M | Order amount: if 100CNY, 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" |
|
|
|
| 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 |
|
|
|
@@ -283,7 +283,7 @@ 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 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".
|
|
|
+ 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 by POST method, 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，GoAllPay will resend the response message to merchant.Time interval is[15, 15, 30, 180, 1800, 3600, 7200, 14400, 14400], the unit is second.
|
|
|
|
|
|
@@ -295,7 +295,7 @@ Parameters as follows:
|
|
|
| charSet | String(6) | M | "UTF-8" |
|
|
|
| transType | String(4) | M | "PAUT" |
|
|
|
| orderNum | String(60) | M | Order number |
|
|
|
-| orderAmount | String(12) | M | Order amount: if 100 yuan, it will be 100 or 100.00 |
|
|
|
+| orderAmount | String(12) | M | Order amount: if 100CNY, 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" |
|
|
|
@@ -325,7 +325,7 @@ Parameters as follows:
|
|
|
|
|
|
</div>
|
|
|
|
|
|
-**2.Request message format**
|
|
|
+**2.Request parameters**
|
|
|
|
|
|
| Parameter | Type | Required | Description |
|
|
|
| ------------- | ---------- | ---- | ------------------------------------------------------ |
|
|
|
@@ -334,7 +334,7 @@ Parameters as follows:
|
|
|
| transType | String(4) | M | "PAUC" |
|
|
|
| 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 | Pre-authorized order number |
|
|
|
-| orderAmount | String(12) | M | Order amount: if 100 yuan, it will be 100 or 100.00 |
|
|
|
+| orderAmount | String(12) | M | Order amount: if 100CNY, 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" |
|
|
|
@@ -343,7 +343,7 @@ Parameters as follows:
|
|
|
| signType | String(10) | M | "MD5" or "SHA256" |
|
|
|
| signature | String(32) | M | MD5 or SHA256 signature |
|
|
|
|
|
|
-**3.Response message format**
|
|
|
+**3.Response parameters**
|
|
|
|
|
|
| Parameter | Type | Required | Description |
|
|
|
| ------------- | ---------- | ---- | ---------------------------------------------- |
|
|
|
@@ -377,10 +377,10 @@ Parameters as follows:
|
|
|
|
|
|
</div>
|
|
|
|
|
|
-**2.Request message format**
|
|
|
+**2.Request parameters**
|
|
|
|
|
|
| Parameter | Type | Required | Description |
|
|
|
-| ------------- | ---------- | ---- | ------------------------------------------------------------ |
|
|
|
+| ------------- | ---------- | ---- | ---------- |
|
|
|
| version | String(12) | M | "VER000000005" |
|
|
|
| charSet | String(6) | M | "UTF-8" |
|
|
|
| transType | String(4) | M | "VOID" |
|
|
|
@@ -393,10 +393,10 @@ Parameters as follows:
|
|
|
| signType | String(10) | M | "MD5" or "SHA256" |
|
|
|
| signature | String(32) | M | MD5 or SHA256 signature |
|
|
|
|
|
|
-**3.Response message format**
|
|
|
+**3.Response parameters**
|
|
|
|
|
|
| Parameter | Type | Required | Description |
|
|
|
-| ------------- | ---------- | ---- | ---------------------------------------------- |
|
|
|
+| ------------- | ---------- | ---- | --------------- |
|
|
|
| version | String(12) | M | "VER000000005" |
|
|
|
| charSet | String(6) | M | "UTF-8" |
|
|
|
| transType | String(4) | M | "VOID" |
|
|
|
@@ -418,7 +418,7 @@ Parameters as follows:
|
|
|
|
|
|
To refund the transaction before 90 days, the merchant can't process the online refund interface, but need to call the interface to initiate the refund application. After the application is successful, our business staff will handle it manually. The processing period is about 3 to 5 working days. The refund application transaction will be successfully refunded after manual processing, and the transaction will be liquidated.
|
|
|
|
|
|
-**2.Request message format**
|
|
|
+**2.Request parameters**
|
|
|
|
|
|
| Parameter | Type | Required | Description |
|
|
|
| ------------- | ---------- | ---- | ------------------------------------------------------------ |
|
|
|
@@ -427,7 +427,7 @@ To refund the transaction before 90 days, the merchant can't process the online
|
|
|
| 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 |
|
|
|
+| returnAmount | String(12) | M | Refund amount: if 100CNY, 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 GoAllPay |
|
|
|
| paymentSchema | String(10) | M | Channel ID: [Click Here](paymentSchema.md) |
|
|
|
@@ -436,7 +436,7 @@ To refund the transaction before 90 days, the merchant can't process the online
|
|
|
| signType | String(3) | M | "MD5" or "SHA256" |
|
|
|
| signature | String(32) | M | MD5 or SHA256 signature |
|
|
|
|
|
|
-**3.Response message format**
|
|
|
+**3.Response parameters**
|
|
|
|
|
|
| Parameter | Type | Required | Description |
|
|
|
| --------- | ---------- | ---- | ---------------------------------------------- |
|
|
|
@@ -461,7 +461,7 @@ To refund the transaction before 90 days, the merchant can't process the online
|
|
|
|
|
|
Provide users with card binding function, suitable for foreign card transactions.
|
|
|
|
|
|
-**2.Request message format**
|
|
|
+**2.Request parameters**
|
|
|
|
|
|
| Parameter | Type | Required | Description |
|
|
|
| ------------- | ----------- | ---- | ---------------------------------------------------------- |
|
|
|
@@ -478,7 +478,7 @@ 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 |
|
|
|
|
|
|
-**3.Response message format**
|
|
|
+**3.Response parameters**
|
|
|
|
|
|
| Parameter | Type | Required | Description |
|
|
|
| ------------- | ---------- | ---- | ---------------------------------------------------------- |
|
|
|
@@ -504,7 +504,7 @@ To refund the transaction before 90 days, the merchant can't process the online
|
|
|
|
|
|
Unbound card
|
|
|
|
|
|
-**2.Request message format**
|
|
|
+**2.Request parameters**
|
|
|
|
|
|
| Parameter | Type | Required | Description |
|
|
|
| ------------- | ---------- | ---- | ---------------------------------------------------------- |
|
|
|
@@ -520,7 +520,7 @@ 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 |
|
|
|
|
|
|
-**3.Response message format**
|
|
|
+**3.Response parameters**
|
|
|
|
|
|
| Parameter | Type | Required | Description |
|
|
|
| ------------- | ---------- | ---- | ---------------------------------------------------------- |
|
|
|
@@ -546,7 +546,7 @@ To refund the transaction before 90 days, the merchant can't process the online
|
|
|
|
|
|
Card-tied consumer payment, debits the user based on the token returned when the card was tied.
|
|
|
|
|
|
-**2.Request message format**
|
|
|
+**2.Request parameters**
|
|
|
|
|
|
It consists of general fields and channel-specific fields. All upload fields must be signed.
|
|
|
|
|
|
@@ -560,7 +560,7 @@ To refund the transaction before 90 days, the merchant can't process the online
|
|
|
| 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 |
|
|
|
+| orderAmount | String(12) | M | Order amount: if 100CNY, 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. |
|
|
|
@@ -574,21 +574,21 @@ 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 |
|
|
|
|
|
|
-**3.Response message format**
|
|
|
+**3.Response parameters**
|
|
|
|
|
|
- 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".
|
|
|
+ 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 by POST method, 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，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:
|
|
|
|
|
|
-| Parameter | Type | Required | Description |
|
|
|
-| ------------- | ------------ | ---- | ------------------------------------------------------------ |
|
|
|
+| 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 |
|
|
|
+| orderAmount | String(12) | M | Order amount: if 100CNY, 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" |
|
