API Documentation
After payer authorized a payment, Merchant’s system has to call this Capture Payment API to collect fund. It’s strongly recommended to do this action within 3 - 5 days after payment authorization. Otherwise, the authorization will be cancelled automatically.
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.capture |
| 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". |
| Platform Order Number | transaction_id | No | String(32) | Either passing "out_trade_no" or "transaction_id". |
| Currency Type | fee_type | Yes | String(8) | ISO-4217 standard compliant and be described by three characters based code. |
| Order Amount | total_fee | Yes | Int | Specifies the total order amount. The units are expressed in cents as integers. The default currency is HKD. |
| Capture Amount | capture_fee | Yes | Int | Specifies the order amount to be captured. The units are expressed in cents as integers. The default currency is HKD. |
| 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 |
| 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. | ||||
| Platform Order Number | transaction_id | Yes | String(32) | An unique order number within the payment system. |
| Order Number | out_trade_no | Yes | String(32) | An internal order number within the Merchant’s system. |
| Payment Channel | trade_channel | Yes | String(32) | CREDICARD - Credit Card |
| Trade Type | trade_type | Yes | String(32) | ionline.pay.firstdata.creditcard |
| Item Description | body | Yes | String(127) | Item Description |
| Currency Type | fee_type | Yes | String(8) | ISO-4217 standard compliant and be described by three characters based code. |
| Order Amount | total_fee | Yes | Int | Specifies the total order amount. The units are expressed in cents as integers. The default currency is HKD. |
| Captured Amount | captured_fee | Yes | Int | Specifies the captured amount. The units are expressed in cents as integers. |