Fetch IRM list
curl --request POST \
--url https://api.ebrc.in/api/v1/irm/refresh \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '{}'import requests
url = "https://api.ebrc.in/api/v1/irm/refresh"
payload = {}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({})
};
fetch('https://api.ebrc.in/api/v1/irm/refresh', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.ebrc.in/api/v1/irm/refresh",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.ebrc.in/api/v1/irm/refresh"
payload := strings.NewReader("{}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.ebrc.in/api/v1/irm/refresh")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.ebrc.in/api/v1/irm/refresh")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{}"
response = http.request(request)
puts response.read_body{
"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
}
}IRM
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.
POST
/
irm
/
refresh
Fetch IRM list
curl --request POST \
--url https://api.ebrc.in/api/v1/irm/refresh \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '{}'import requests
url = "https://api.ebrc.in/api/v1/irm/refresh"
payload = {}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({})
};
fetch('https://api.ebrc.in/api/v1/irm/refresh', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.ebrc.in/api/v1/irm/refresh",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.ebrc.in/api/v1/irm/refresh"
payload := strings.NewReader("{}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.ebrc.in/api/v1/irm/refresh")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.ebrc.in/api/v1/irm/refresh")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{}"
response = http.request(request)
puts response.read_body{
"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
}
}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.
Optional filters:
Request example
curl --location --request POST 'https://api.ebrc.in/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 ''
irmNumber, fromDate, toDate (ISO dates), and page / limit for pagination.
Response example
remitterCountry is an ISO 3166-1 alpha-3 code — see Country Codes.
{
"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": "USA",
"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/409when the customer’s DGFT credentials are missing or stale. See DGFT credential error codes.409DGFT_IP_ACTIVATION_PENDINGwith aretryAftertimestamp during the 24 hours after linking an exporter who already held DGFT API credentials. The refresh is remembered and runs automatically once DGFT opens access. See the 24-hour activation.429beyond 6 calls per minute. See rate limits.
Next steps
- List saved IRMs for reads without a live refresh.
- Submit IRMs for generation.
- Download IRMs as Excel to work in a spreadsheet.
Authorizations
Query Parameters
Required range:
x >= 1Required range:
x >= 1Body
application/json
The body is of type object.