Settlement section
The settlement section contains two files that include transactions during the selected settlement date range:- Payment Report - Contains all payment records with their current status. This report does not include any refund records, only payment records.
- Settlement Report - Provides comprehensive settlement information for all source types. This report only includes transactions that have already been settled.
Payment Report
The report header displays account information, report date range, and timezone settings:- Time Zone: Defaults to Asia/Singapore
- Date Type: Create Date/Completed Date
- Date Range: From 00:00:00 to 23:59:59 of the selected date range
File structure
| Field name | Description |
|---|---|
| Merchant Order Id | Unique identifier for the merchant’s order system |
| Payment Method | Payment method used for the transaction |
| Transaction Status | Current payment status: Created, Processing, Succeeded, Failed, Cancelled, Requires Customer Action, Requires Capture |
| Create Date | Timestamp when the payment was created |
| Completed Date | Timestamp when the payment was completed |
| Currency | Three-letter ISO currency code for the transaction |
| Amount | Payment amount |
| Fee | Fee amount charged for the transaction |
| Description | Payment description provided by the merchant |
| Cancellation Reason | Reason for payment cancellation, if applicable |
| Payment Intent Id | Unique identifier for the payment intent (PI) |
| Payment Attempt Id | Unique identifier for the latest payment attempt (PA) |
| Refunded Amount | Total amount refunded for this payment |
Settlement Report
The report header displays account information, report date range, and timezone settings:- Time Zone: Defaults to Asia/Singapore
- Date Type: Create Date/Settlement Date
- Date Range: From 00:00:00 to 23:59:59 of the selected date range
File structure
| Field name | Description |
|---|---|
| Settlement Id | Unique identifier for the settlement transaction |
| Source Type | one of: PAYMENT, REFUND |
| Transaction Type | one of: PAYMENT, REFUND |
| Refund Account | Indicates the balance source from which the refund is processed. one of: available, pending |
| Merchant Order Id | Unique identifier from the merchant’s order system |
| Payment Intent Id | Unique identifier for the payment intent (PI) |
| Payment Method | Payment method used for the transaction |
| Transaction Create Date | Timestamp when the transaction was created |
| Transaction Amount | Original transaction amount |
| Transaction Currency | Three-letter ISO currency code for the original transaction |
| Settlement Amount | Amount settled in settlement currency |
| Settlement Currency | Three-letter ISO currency code for settlement |
| Net Settlement Amount | Net amount after fees in settlement currency |
| Exchange Rate | Exchange rate used for currency conversion (6 decimal places) |
| Fee Currency | Three-letter ISO currency code for fees |
| Interchange Fee | Interchange fee amount |
| Scheme Fee | Card scheme fee amount |
| Transaction Fee | Transaction fee amount |
| Return Fee | Return fee amount |
| Total Fee Amount | Total fee amount including all fees |
| Settlement Status | Current settlement status |
| Settlement Batch Id | Unique identifier for the settlement batch |
| Settlement Create Date | Timestamp when settlement was created |
| Settlement Date | Timestamp when settlement was completed |
API Settlement Data
In addition to downloadable reports, you can also retrieve settlement data programmatically through our API endpoints. This provides real-time access to settlement information and enables integration with your systems.Available Endpoints
- Get list of settlements:
GET /api/v2/payment/settlements