Remittance Processed Transaction Export
- 30 Nov 2023
- 1 Minute to read
- Print
- DarkLight
Remittance Processed Transaction Export
- Updated on 30 Nov 2023
- 1 Minute to read
- Print
- DarkLight
Article summary
Did you find this summary helpful?
Thank you for your feedback
This endpoint returns the details of all paid transactions between given from and to dates, and additional filters as specified in query parameters.
URL
GET /api/Remittance/{merchantId}/runs/processed
Path Parameters
Name | Type |
|---|---|
merchantId Required | String [0..10] characters The merchant ID |
Query Parameters
Name | Description | Example |
|---|---|---|
page | (optional) Page number. (starting 0) | ?page=0 |
size | (optional) Page size (starting 1) | ?size=1 |
bankAccountId | (optional) Bank account guid collection | ?bankAccountId=0c6a36ba-10e4-438f-ba86-0d5b68a2bb15&bankAccountId=13270dcb-1e80-428e-a3c3-2bd5d1e0428d |
dateFrom | (optional) From date | ?dateFrom=2022-12-15 |
dateTo | (optional) To date | ?dateTo=2023-07-15 |
Page and Size Query Parameters
Page and size parameters can be used for navigating across large records.
Size query parameter restricts number of records that Api can return for a given request. Page number can be increased to get next set of records.
Total number of pages required can be calculated based on the total record count returned in response header “X-Total-Count”.
Page number starts from 0. Pagination would be applied only when both page and size parameter are provided.
Example
If page size is 200, and total records to be returned are 650, then records can be accessed by increasing page number from 0 to 3.
Total required pages can be calculated from formula like “(650/200) + (650%200) > 0? 1 :0 = 4”
page = 0, size = 200 => returns 200 records
page = 1, size = 200 => returns 200 records
page = 2, size = 200 => returns 200 records
page = 3, size = 200 => returns 50 records
Was this article helpful?