get https://api.fiuu.com/RMS/API/settlement/report.php
PG Settlement Report provides merchants the fund transfer or balance clearance and settlement reconciliation for a specific date.
Version 1.0, 2.0 and 3.0 will be obsoleted and the following is the latest specification of version 4.0, 5.0 and 6.0. Version 4.0, 5.0 and 6.0 will include refund and chargeback records that are excluded from the settlement batch. Version 5.0 supports pagination for big merchants.
Formula of token
token = md5( merchantID + verify_key + date )Response
| Value | Type Format / Max Length | Description / Example |
|---|---|---|
| RecordIdentifier | 1 character | H: Header |
| SettlementCurrency | 3 chars ISO-4217 currency code | Default is MYR, Settlement currency |
| SettlementNetAmount | numeric without decimal and comma | total settlement amount, 5331674 is equal to 53,316.74 in that currency |
| SettlementCommissionAmount | numeric without decimal and comma | total settlement fees, sum of the transfer fees and 3rd party costs |
| NumberOfTransactions | numeric | total transaction number of settled transaction or D data type in the report, not including R and G type |
| BatchReferenceNumber | alphanumeric | Reference number of this settlement |
| SettlementDate | YYYYMMDD | The settlement date |
| SettlementGSTAmount | numeric without decimal and comma | Sum of settled transactions GST amount |
| BankAccount | alphanumeric | Bank swift code and bank account number |
| RefundNetAmount | numeric without decimal and comma | Sum of the refund fees |
| RefundGSTAmount | numeric without decimal and comma | Taxes : GST/VAT on the RefundNetAmount |
| Variable / Parameter | Type Format / Max Length | Description / Example |
|---|---|---|
| RecordIdentifier | 1 character | D: Data or the content, R: Refund / Chargeback Data, G: Data (Original txn data - Txn fully refunded before settlement) |
| MerchantId | alphanumeric | Merchant ID in PG system |
| OrderId | alphanumeric | Order references for merchant system |
| Channel | alphanumeric | Payment channel / method |
| AcquirerReference | alphanumeric | PG transaction ID |
| RefundID | n(1..11) | Refund ID provided by PG |
| MerchantRefID | ans(1..100) | Unique refund tracking/reference ID by merchant |
| RefundFees | numeric without decimal and comma | PG refund fees., D: Always Zero '0' value, R: PG refund fees (positive value) |
| TransactionNetAmount | numeric without decimal and comma | D: amount after deducting MDR/fees. Formula: TransactionGrossAmount - TransactionCommissionAmount, R: amount refunded to the buyer (full/partial) after adding Refund fees. Formula: TransactionGrossAmount + RefundFees |
| TransactionCommissionAmount | numeric without decimal and comma | The MDR or transaction fee or commission, D: MDR, R: Recalculate MDR for partial refund during captured and charging model have %. Otherwise the value is 0. |
| TransactionDate | YYYYMMDD | The date of transaction been created |
| TransactionTime | HHmmss | The time of transaction been requested/created |
| TransactionGrossAmount | numeric without decimal and comma | D: Payment amount, R: amount refunded to the buyer (full/partial) |
| TransactionCurrency | 3 chars ISO-4217 currency code | The currency sent in by merchant or most of the time, paid by the buyer |
| TransactionGST | numeric without decimal and comma | Taxes : GST/VAT/WHT/EWT |
| TransactionGatewayFee | numeric without decimal and comma | Gateway fee |
| TransactionGatewayFeeCurrency | 3 chars ISO-4217 currency code | MYR, SGD, USD, ... |
| SettlementNetAmountInProcessingCurrency | numeric without decimal and comma | D: TransactionNetAmount after deducting GST. Formula: TransactionGrossAmount - TransactionCommissionAmount - TransactionGST, R: TransactionNetAmount after deducting GST. Formula: NEGATIVE (TransactionGrossAmount + RefundFees + TransactionGST - TransactionCommissionAmount) |
| SettlementNetAmount | numeric without decimal and comma | Net amount in settlement currency, after forex conversion (round to 2 decimal place)., Formula: SettlementNetAmountInProcessingCurrency times Forex |
| SettlementCurrency | 3 chars ISO-4217 currency code | MYR, SGD, USD, ... |
| Forex | numeric without 8 digit decimal and comma | Forex rate for multi currency transactions. Eg: 1.00000000 = 10000000 |
| Status | alphanumeric | The transaction status., Usually SETTLED for D, REFUND for R, CANCELLED for G |
| Variable / Parameter | Type Format / Max Length | Description / Example |
|---|---|---|
| RecordIdentifier | 1 character | F: Record summary |
| NumberOfTransactionsTotal | integer | Total number of D records |
| NumberOfTransactionsShown | integer | Total number of D records been display |
| FilterTransactionsTotalPages | integer | Total available pages for D records |
| FilterTransactionsLimitPerPage | integer | Limit record been display for D records |
Note: F row only available in version 5.0 and when page value is more than 0. To speed up the response on the subsequence pages, row R and G will be excluded and may only appear at page 1.
Error (always in JSON format)
| Variable / Parameter | Description / Example |
|---|---|
| success | false |
| token | invalid token |
| date | invalid date format, eg. yyyy-mm-dd |