SDKPaymentVersion 1.0.0
Create SDK Order
https://pay.globepay.co/api/v1.0/gateway/partners/{partner_code}/app_orders/{order_id}The method is used for mobile app to call payment channel SDK payment, call API to create order, get SDK call parameter, pass parameters to SDK pull up corresponding channel App (WeChat, Alipay) payment, and return payment result directly from channel App. It is strongly advised to request GlobePay order query Api to confirm that the order has been paid in order to cancelling order by system at the same time.
More information for integration with Alipay: Alipay SDK Document
SDK for Android
SDK for iOS
More information for integration with WechatPay: WechatPay SDK Document
SDK for Android
SDK 1.8.2 for iOS
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 |
JSON keys
| Field | Type | Description |
|---|---|---|
description | String | Required, Order description |
price | int | Required, Price of the order. Use the base unit of the currency. |
currency | String | Currency |
channel | String | payment channel, required, case sensitive |
notify_url | String | System will call the notify url if provided when the payment succeeds |
operator | String | Note for the operator who created this order. |
system | String | os type of client app, optional |
version | String | client app version, optional |
appid | String | wechat appid, required for Wechat, not required for Alipay |
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 |
|---|---|---|
return_code | String | Execution result |
result_code | String | SUCCESS means order created successfully, EXISTS means order has already existed. |
partner_code | String | Partner code |
full_name | String | Partner's full company name when registered |
partner_name | String | Partner's name |
order_id | String | Order id in GlobePay, which is also WeChat order id. The final order id which is paid may be different from this one |
partner_order_id | String | Partner order id |
sdk_params | String | param string for calling SDK |
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 |