TuitionPayVersion 1.0.0
Create a Domestic Bank Transfer Order (Only for cross-border tuition payment)
https://pay.globepay.co/api/v1.0/zl_gateway/partners/{partner_code}/order/{order_id}This API provides an integration interface for cross-border tuition remittance. It is specifically designed for student tuition payment scenarios. The student or payer submits order details, identity information of the remitter and actual payer, along with the admission offer document. Based on this information, the system will generate the designated receiving account and reference code required for the remittance. Due to compliance and foreign exchange regulations, the admission offer and valid identification documents of the remitter are required to ensure the authenticity and legitimacy of the transaction.
Header
| Field | Description |
|---|---|
Accept | application/json |
Content-Type | application/json |
Path Variable
| Field | Type | Description |
|---|---|---|
partner_code | String | Required, Partner code |
order_id | String | Required, Partner order ID, require to be unique for the same merchant (maximum length is 50 characters) |
JSON keys
| Field | Type | Description |
|---|---|---|
description | String | Required, order subject (maximum length is 128 characters, will be cut if exceeds) |
price | int | Required, Price of the order. Use the base unit of the currency(e.g. 100 for GBP1.00). |
payerName | String | Required, Name of the payer |
payerPhone | String | Required, Payer’s phone number |
payerIdCard | String | Required, Payer’s ID number |
payerUrl | String | Required, Front side image of the payer’s ID card |
payerBackUrl | String | Required, Back side image of the payer’s ID card |
realPayerName | String | Required, Name of the actual payer (if different from payer) |
emergencyPhone | String | Required, Emergency contact phone number (must be domestic) |
realPayerIdCard | String | Required, Actual payer’s ID number |
realPayerUrl | String | Required, Front side image of the actual payer’s ID card |
realPayerBackUrl | String | Required, Back side image of the actual payer’s ID card |
relationship | String | Required, Relationship: 01 - Parent; 02 - Other; 03 - Self |
offerUrl | String | Required, Offer (admission) document file URL |
remittanceAmt | String | Required, Actual foreign currency remittance amount |
Query Params
| Field | Type | Description |
|---|---|---|
time | Long | Required, UTC timestamp in milliseconds |
nonce_str | String | Required, Random string |
sign | String | Required, Sign |
Success 200
| Field | Type | Description |
|---|---|---|
reference | String | Payment reference. Must be included by student when transferring funds |
amount | String | Actual amount required to be paid |
order_id | String | GlobePay Order ID, which is also WeChat order ID. The final order ID which is paid may be different from this one. |
accountName | String | Receiving account name |
accountNo | String | Receiving account number |
currency | String | Currency |
Error Code
| Name | Description |
|---|---|
ORDER_MISMATCH | Order is not belong to this partner |
ORDER_PAID | Order has already been paid |
SYSTEMERROR | Exception inside system |
INVALID_SHORT_ID | Partner code is invalid or there is no partner associated with this code |
SIGN_TIMEOUT | Sign expired, the difference between time and the server time is more than 5 minutes |
INVALID_SIGN | Invalid sign |
PARAM_INVALID | Parameters are invalid. See return_msg for more details. |
NOT_PERMITTED | Gateway payment permission has not been enabled for this partner |
INVALID_CHANNEL | Channel name is not available, check the Capitalize |
ERROR
| Name | Description |
|---|---|
return_code | Error Code |
return_msg | Error Description |