Skip to main content
POST
Fetch IRM list
Pull the customer’s latest inward remittances (IRMs) and return them paginated. This performs a live refresh on every call and is limited to 6 calls per minute; for everyday reads of already-fetched data, use List saved IRMs instead.

Request example

Optional filters: irmNumber, fromDate, toDate (ISO dates), and page / limit for pagination.

Response example

Errors

Next steps

Authorizations

x-api-key
string
header
required

Query Parameters

platformCustomerId
string
required
page
integer
default:1
Required range: x >= 1
limit
integer
default:10
Required range: x >= 1
irmNumber
string
fromDate
string<date>
toDate
string<date>

Body

application/json

The body is of type object.

Response

200 - application/json

Paginated IRMs

data
object[]
meta
object