> ## Documentation Index
> Fetch the complete documentation index at: https://docs.ebrc.in/llms.txt
> Use this file to discover all available pages before exploring further.

# Fetch IRM List

> Refresh inward remittances (IRMs) for a platform customer and return the latest records, the first step before mapping them and generating an eBRC.

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](/api-reference/irm/list) instead.

### Request example

```bash theme={"dark"}
curl --location --request POST 'https://ebrcapi.eximfiles.io/api/v1/irm/refresh?platformCustomerId=ee849a90-7a28-49b4-8cb2-8e31041650a2&page=1&limit=10' \
  --header 'x-api-key: <YOUR_API_KEY>' \
  --header 'Content-Type: application/json' \
  --data ''
```

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

### Response example

```json theme={"dark"}
{
  "success": true,
  "data": {
    "data": [
      {
        "id": "3d1f7a2b-8c4e-4f5a-9b6d-2e1c0f9a8b7c",
        "irmNumber": "IRM0000012345",
        "irmIssueDate": "2024-04-01",
        "irmStatus": "fresh",
        "ifscCode": "HDFC0000123",
        "remittanceAdCode": "6390005",
        "remittanceDate": "2024-04-01",
        "remittanceFCC": "USD",
        "remittanceFCCAmount": 25000,
        "irmAvailableAmt": 25000,
        "irmUtilizedAmt": 0,
        "iecCode": "0123456789",
        "remitterName": "Acme Trading LLC",
        "remitterCountry": "US",
        "platformCustomerId": "ee849a90-7a28-49b4-8cb2-8e31041650a2",
        "createdAt": "2026-07-22T10:30:00.000Z",
        "updatedAt": "2026-07-22T10:30:00.000Z"
      }
    ],
    "meta": {
      "total": 1,
      "page": 1,
      "limit": 10,
      "totalPages": 1
    }
  },
  "statusCode": 200,
  "timestamp": "2026-07-22T10:30:01.000Z"
}
```

### Errors

* `422` / `409` when the customer's DGFT credentials are missing or stale. See [DGFT credential error codes](/errors#dgft-credential-error-codes).
* `429` beyond 6 calls per minute. See [rate limits](/authentication#rate-limits).

### Next steps

* [List saved IRMs](/api-reference/irm/list) for reads without a live refresh.
* [Submit IRMs for generation](/api-reference/genebrc/push-irm).
* [Download IRMs as Excel](/api-reference/irm/bulk-template) to work in a spreadsheet.


## OpenAPI

````yaml POST /irm/refresh
openapi: 3.1.0
info:
  title: eBRC API
  description: >-
    REST API for generating and managing electronic Bank Realization
    Certificates (eBRC) through DGFT's GenEBRC module. Onboard exporters,
    validate their DGFT credentials, pull inward remittance (IRM) data, submit
    certificate generation requests singly or in bulk, and track them to
    completion. All JSON responses are wrapped in the standard envelope {
    success, data, statusCode, timestamp }; the schemas on each endpoint
    describe the data field.
  contact:
    name: Eximfiles support
    email: amin@eximfiles.io
  version: 1.0.0
servers:
  - url: https://ebrcapi.eximfiles.io/api/v1
    description: Production
  - url: https://ebrcapi.dev.eximfiles.com/api/v1
    description: Sandbox
security:
  - x-api-key: []
paths:
  /irm/refresh:
    post:
      summary: Fetch IRM list
      description: >-
        Refresh and fetch the latest inward remittances (IRMs) from DGFT for the
        given platform customer, then return paginated results. The response is
        returned in the data field of the standard envelope.
      operationId: fetchIrmList
      parameters:
        - name: platformCustomerId
          in: query
          required: true
          schema:
            type: string
        - name: page
          in: query
          schema:
            type: integer
            minimum: 1
            default: 1
        - name: limit
          in: query
          schema:
            type: integer
            minimum: 1
            default: 10
        - name: irmNumber
          in: query
          schema:
            type: string
        - name: fromDate
          in: query
          schema:
            type: string
            format: date
        - name: toDate
          in: query
          schema:
            type: string
            format: date
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties: {}
      responses:
        '200':
          description: Paginated IRMs
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/IRM'
                  meta:
                    type: object
                    properties:
                      total:
                        type: integer
                      page:
                        type: integer
                      limit:
                        type: integer
                      totalPages:
                        type: integer
components:
  schemas:
    IRM:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier (UUID)
        irmNumber:
          type: string
        irmIssueDate:
          type: string
        irmStatus:
          type: string
          enum:
            - fresh
            - amended
            - pending_amendment
            - canceled
            - ready_for_processing
        ifscCode:
          type: string
        remittanceAdCode:
          type: string
        remittanceDate:
          type: string
        remittanceFCC:
          type: string
        remittanceFCCAmount:
          type: number
        ormAmountFCC:
          type: number
        irmAvailableAmt:
          type: number
        irmUtilizedAmt:
          type: number
        iecCode:
          type: string
        panNumber:
          type: string
        remitterName:
          type: string
        remitterCountry:
          type: string
        purposeOfRemittance:
          type: string
          nullable: true
        subjectType:
          type: string
          enum:
            - USER
            - PLATFORM_CUSTOMER
        userId:
          type: string
          nullable: true
        platformCustomerId:
          type: string
          nullable: true
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
  securitySchemes:
    x-api-key:
      type: apiKey
      name: x-api-key
      in: header

````