- Get Started
- Guides
- Integrations
- References
- API Reference
- Basic Payment
- Forex
- Authentication
- Card Account
- Apple Pay
- Virtual Account
- Bank Account
- Token Account
- Customer
- Billing Address
- Merchant Billing Address
- Shipping Address
- Merchant Shipping Address
- Corporate
- Sender
- Recipient
- Merchant
- Marketplace & Cart
- Airline
- Lodging
- Passenger
- Tokenization
- Recurring Migration
- 3D Secure
- Custom Parameters
- Async Payments
- Webhook notifications
- Job
- Risk
- Point of Sale
- Response Parameters
- Card On File
- Chargeback
- Result Codes
- Payment Methods
- Transaction Flows
- Regression Testing
- Data Retention Policy
- API Reference
- Support
Settlement Reports
Settlement reports provide settlement data from your connector (where supported), contributing to your reconciliation processes.
You can retrieve data at both summary and detail / detail with pagination levels.
Summary Level
You can get summary level information for a certain date and/or settlement currency by sending a HTTP GET request to the /reconiliations/aggregrations
endpoint.
Detail Level
You can get further details for a particular aggregation id by sending a HTTP GET request to the /reconciliations/aggregrations/{id}
endpoint.
If sortValue and sortOrder parameters are sent in the request, the result will be sorted by settlement transaction date. These 2 parameters only work for Detail Level report.
Parameter | Value |
---|---|
sortValue | SettlementTxDate |
sortOrder | ASC|DESC|asc|desc |
Detail Level with Pagination
You can get further details for a particular aggregation id by sending a HTTP GET request to the /v2/reconiliations/aggregrations/{id}
endpoint. The records of the result will be split into pages containing 100 records each, and the response will contain a parameter named pages
, representing the number of pages for that particular aggregation.
If the pageNo
parameter is sent in the request, the result will display the records from that specific page. If the pageNo
parameter is not sent in the request, the result will display by default the records from the first page, page number 1.
Possible reconciliationType
include:
- SETTLED
- FEE
- CHARGEBACK
- CHARGEBACK REVERSAL
Settlement Matching
matchedTransactions
contains the UUID's of the transactions that match the record in the settlement report. The functionality can be enabled in your account. Please contact your account manager for further information.
matchedTransactions
contains a field status
which can have the following possible values :
- NOT_MATCHED : when there are no matches for the record
- MATCHED : when there is exactly one match for the record
- MULTIPLE_MATCHES : when there are multiple potential matches for the record
Dummy Report Data
If the API parameter testMode
is sent and set to INTERNAL
, the API will return dummy data.