Order Reconciliation File Download
Download link interface for reconciliation files.
Request URL
Will be provided via email. The same download task can only be initiated once in 30 minutes.
Download Reconciliation File Request Parameters
Header
| Field Name | Type | Value | Required |
|---|---|---|---|
| Content-Type | String(30) | Fixed value "application/json;charset=utf-8" | Yes |
| X-TIMESTAMP | String(29) | Current time, format 2022-09-16T16:58:47.964+07:00 | Yes |
| X-SIGNATURE | String(64) | Signature. For details please check Data Signing Rules | Yes |
| X-PARTNER-ID | String(20) | Merchant ID | Yes |
| X-REQUEST-ID | String(64) | Unique ID for each request | Yes |
Body
| Parameter | Type | Required | Remarks |
|---|---|---|---|
| requestId | String(64) | Yes | Unique ID for each request |
| merchantId | String(20) | Yes | Unique ID provided by the payment gateway to the merchant |
| transactionType | String(2) | Yes | 10: Payment |
| payDate | String(10) | Yes | Date, format 2022-09-01 |
Download Reconciliation File Response Parameters
Header
| Field Name | Type | Value | Required |
|---|---|---|---|
| Content-Type | String(30) | Fixed value "application/json;charset=utf-8" | Yes |
Body
| Parameter | Type | Required | Remarks |
|---|---|---|---|
| requestId | String(64) | Yes | Unique ID for each request |
| errCode | String(32) | No | See Error Code section |
| errCodeDes | String(128) | No | Error details based on error code |
| merchantId | String(20) | Yes | Unique ID provided by the payment gateway to the merchant |
| fileName | String(200) | No | File name |
| fileUrl | String(200) | No | File download URL (valid for 10 minutes) |
| fileSize | Number | No | File size |
| status | String(1) | No | 0: Creating Task 1: Generating 2: Generated 3: Failed to Generate Note: If status is 0 or 1, please try again later; if status is 3, please contact technical support. |
fileUrl notes
File is a zip archive. After extraction, you will get one or more CSV files named merchantId_payDate_xxx_xxx.csv (xxx are 4-digit numbers).
CSV File Format
delimiter = ",";
quote = '"';
RecordSeparator = "\r\n";CSV Columns (API v2.4)
MerchantNo,PaymentType,SettlementNo,SettlementType,SettlementStatus,RequestAmount,Amount,FeeType,TransFeeRate,TransFeeAmount,TotalTransFee,PaylabsOrderNo,MerchantOrderNo,RequestTime,PayTime,PayCode,VatFee,TotalFeeWithTax| Field Name | Description |
|---|---|
MerchantNo | Merchant partner identifier / Merchant ID |
PaymentType | Payment channel or method used |
SettlementNo | Settlement batch reference number |
SettlementType | Settlement type (channel or paylabs) |
SettlementStatus | Settlement status |
RequestAmount | Requested transaction amount |
Amount | Final processed transaction amount |
FeeType | Fee type calculation |
TransFeeRate | Transaction fee percentage rate |
TransFeeAmount | Fixed transaction fee amount |
TotalTransFee | Total transaction fee |
PaylabsOrderNo | Paylabs transaction order number |
MerchantOrderNo | Merchant order reference number |
RequestTime | Timestamp when request was initiated |
PayTime | Timestamp when payment succeeded |
PayCode | Payment code or VA number |
VatFee | VAT fee amount |
TotalFeeWithTax | Total transaction fee inclusive of VAT / tax |