API Documentation
Merchant system can query transaction detail by using "out_trade_no" or "transaction_id".
URL: https://pay.ionlinepay.com/gateway/
Request Method: POST Form-Data
| Name | ID | Required | Type | Description |
| API Name | service | Yes | String(32) | ionline.unified.trade.query |
| API Version | version | No | String(8) | Default value: 1.0 |
| Charset | charset | No | String(8) | Default value: UTF-8 |
| Signature Type | sign_type | No | String(8) | Default value: MD5 |
| Merchant ID (MID) | mch_id | Yes | String(32) | Specifies Merchant ID assigned by iOnline Pay |
| Order Number | out_trade_no | No | String(32) | Either passing "out_trade_no" or "transaction_id" for querying. |
| Platform Order Number | transaction_id | No | String(32) | Either passing "out_trade_no" or "transaction_id" for querying. |
| Random String | nonce_str | Yes | String(32) | 32 characters or fewer. |
| Signature | sign | Yes | String(32) | Signature Hash. For more information, see "Security Specification" |
Response Format: JSON
| Name | ID | Required | Type | Description |
| API Version | version | Yes | String(8) | Default value: 1.0 |
| Charset | charset | Yes | String(8) | Default value: UTF-8 |
| Signature Type | sign_type | Yes | String(8) | Default value: MD5 |
| Return Status Code | status | Yes | String(16) | This parameters indicates whether the API call is successful or not but this doesn't indicate to have a successful transaction. If the value is 0, then it indicates sucecssful. Otherwise, it indicates failure. |
| Return Message | message | No | String(128) | The description of the Return Status Code if the value of parameter "status" is not 0. |
| The below parameters will be returned if the value of the parameter "status" is 0. | ||||
| Service Result | result_code | Yes | String(16) | If the value is 0, then it indicates sucecssful. Otherwise, it indicates failure. |
| Merchant ID (MID) | mch_id | Yes | String(32) | Specifies Merchant ID assigned by iOnline Pay |
| Device ID | device_info | No | String(32) | Specifies the ID of the terminal device with from which the Merchant submitted their order |
| Random String | nonce_str | Yes | String(32) | 32 characters or fewer. |
| Error Code | err_code | No | String(32) | Error code |
| Error Message | err_msg | No | String (128) | The description of error code |
| Signature | sign | Yes | String(32) | Signature Hash. For more information, see "Security Specification" |
| The below parameters will be returned if the value of the both parameters "status" and "result_code" are 0. | ||||
| Trade State | trade_state | Yes | String(32) | SUCCESS—Payment is successful REFUND—Payment is refunded NOTPAY—Pending to pay CLOSED—Transaction is closed PAYERROR—Payment fails |
| The below parameters will be returned if the value of the parameter "trade_state" is "SUCCESS" or "REFUND". | ||||
| Payment Channel | trade_channel | Yes | String(32) | WECHATPAY — WeChat Pay ALIPAY — Alipay |
| Trade Type | trade_type | Yes | String(32) | ionline.pay.weixin.native.intl |
| Service Provider’s Offical Account ID | appid | No | String(32) | Service Provider’s Offical Account ID |
| User Tag | openid | No | String(128) | Unique User ID of Service Provider App ID in WeChat |
| Does user follow Offical Account? | is_subscribe | No | String(1) | This indicates whether user has followed Offical Account of Service Provider or not.: Y = Followed N = Not yet follow |
| Platform Order Number | transaction_id | Yes | String(32) | Unique transaction ID in the payment system. |
| Payment Channel Order Number | out_transaction_id | No | String(32) | Unique transaction ID in the payment gateway system.（Return only when transaction is successful） |
| Order Number | out_trade_no | Yes | String(32) | out_trade_no is an internal order number within the Vendor’s system. |
| Total order amount | total_fee | Yes | Int | Specifies the total order amount. The units are expressed in cents as integers. The default currency is HKD. |
| Total order amount | total_rmb_fee | No | Int | Specifies the total order amount. The units are expressed in cents as integers. The default currency is HKD. * Return only when the payment channel is Alipay. |
| Coupon amount | coupon_fee | No | Int | The amount of coupon used by payer in this transaction. |
| Currency Type | fee_type | Yes | String(8) | ISO-4217 standard compliant and be described by three characters based code. |
| Item Description | body | Yes | String(127) | Item Description |
| Payment Completion Time | time_end | Yes | String(14) | Specifies the transaction completion time in the format yyyyMMddHHmmss, such as 20170520094130 for May 20, 2017 09:41:30 (GMT+8). |