Skip to main content
POST
/
irm
/
refresh
cURL
curl --request POST \
  --url https://ebrcapi.dev.eximfiles.com/api/v1/irm/refresh \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{}'
{
  "data": [
    {
      "id": "<string>",
      "irmNumber": "<string>",
      "irmIssueDate": "<string>",
      "irmStatus": "fresh",
      "ifscCode": "<string>",
      "remittanceAdCode": "<string>",
      "remittanceDate": "<string>",
      "remittanceFCC": "<string>",
      "remittanceFCCAmount": 123,
      "ormAmountFCC": 123,
      "irmAvailableAmt": 123,
      "irmUtilizedAmt": 123,
      "iecCode": "<string>",
      "panNumber": "<string>",
      "remitterName": "<string>",
      "remitterCountry": "<string>",
      "purposeOfRemittance": "<string>",
      "subjectType": "USER",
      "userId": "<string>",
      "platformCustomerId": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "meta": {
    "total": 123,
    "page": 123,
    "limit": 123,
    "totalPages": 123
  }
}

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