Skip to main content
This guide will walk you through the process.

​
Pre-requisites

Before you begin, make sure you have:
  1. An API key from the Eximfiles team
  2. Basic understanding of RESTful APIs

​
Steps to generate eBRC

1

Create platform customer

First, create new platform customer
  curl --location 'BASE_URL/api/v1/platform-customers/' \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: API_KEY' \
  --data-raw '{
    "name": "Leo Messi",
    "email": "[email protected]",
    "type": "customer",
    "companyName": "STS",
    "address": "Pune"
  }'
2

Validate platform customer

Validate platform customer using DGFT credentials.
  curl --location 'BASE_URL/api/v1/platform-customers/ebd6142f-600d-4379-8379-b9b5cae3f64d/check-dgft-credentials' \
  --header 'x-api-key: API_KEY' \
  --header 'Content-Type: application/json' \
  --data-raw '{
    "dgftUsername": "[email protected]",
    "dgftPassword": "User@@10"
  }'
3

Fetch IRM

Fetch IRM data
curl --location --request POST 'BASE_URL/api/v1/irm/refresh?platformCustomerId=ebd6142f-600d-4379-8379-b9b5cae3f64d' \
--header 'x-api-key: API_KEY' \
--header 'Content-Type: application/json' \
--data ''
4

Push IRM to GenEBRC

Send an IRM request to generate an eBRC for processing.
This endpoint runs in sandbox mode.
  curl --location 'BASE_URL/api/v1/genebrc/push-irm' \
  --header 'x-api-key: API_KEY' \
  --header 'Content-Type: application/json' \
  --data-raw '{
    "platformCustomerId": "ebd6142f-600d-4379-8379-b9b5cae3f64d",
    "recordResCount": 1,
    "uploadType": "BULK",
    "decalarationFlag": "Y",
    "ebrcBulkGenDtos": [
      {
        "serialNo": 1,
        "uploadType": 1,
        "branchSlNo": 1,
        "irmIfscCode": "HDFC0000123",
        "irmAdCode": "0123456",
        "irmNumber": "IRM-0001",
        "irmDt": "2024-04-01",
        "irmFCC": "USD",
        "irmPurposeCode": "P0101",
        "irmRemitAmtFCC": 1000,
        "sbCumInvoiceNumber": "INV-0001",
        "sbCumInvoiceDate": "2024-04-01",
        "portCode": "INBOM4",
        "billNo": "BILL-0001",
        "sbCumInvoiceFCC": "USD",
        "sbCumInvoiceValueinFCC": 1000,
        "mappedIRMAmountFCC": 1000,
        "isVostro": "N",
        "sacCode1": "998311"
      }
    ]
  }'
5

Check request status

Check processing status for the submitted IRM request
This endpoint runs in sandbox mode.
  curl --location --request POST 'BASE_URL/api/v1/genebrc/status' \
  --header 'x-api-key: API_KEY' \
  --header 'Content-Type: application/json' \
  --data-raw '{
    "platformCustomerId": "ebd6142f-600d-4379-8379-b9b5cae3f64d",
    "requestId": "REQ-123"
  }'

​
Need Help?

Contact Support

For help with the API, email us at [email protected]