Get Agent List

get

https://api.instantcashworldwide.ae/sandbox/api/v1/agents

Gets receiving partners data belonging to a specific country and mode.

Note: For delivery mode "Account Transfer to Other Bank (04)", it is recommended to use the GET /banks/branches endpoint.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

destinationCountry

string

required

length ≥ 1

Receiving country.

Format: ISO-3166 alpha-2 code.

state

string | null

2-3 digits code (Available in the Web base IC system)

For account transfer to India delivery mode "Account Transfer to Other Bank (04)" is only available.
Use the GET /states endpoint to get a list of available states.

deliveryMode

int32

required

Delivery Mode

Use the GET /types?filter=delivery-modes endpoint to get a list of allowed types.
Note: For delivery mode "Account Transfer to Other Bank (04)", it is recommended to use the GET /banks/branches endpoint.

bankName

string | null

Searches for an agent by Head Office Name or Agent Name. The search is performed using the Contains operation, which is case sensitive.

Important:

For delivery mode "Account Transfer to Other Bank (04)", the search for a bank branch must be performed using the pattern: [Bank Name], [Branch Name].
For example: ISLAMI BANK BANGLDESH LTD., AGRABAD

pageNumber

int32

1 to 2147483647

The number of the next page.
(Default is 1)

pageSize

int32

1 to 1000

This is the maximum number of records per page that can be returned to the client.
Must be between 1 and 1000. (Default is 50)

Headers

x-fapi-financial-id

string

required

^[A-Z]{2}[0-9A-Z]{4}$

This is the agent correspondent id provided to the agent by the IC Operations department. It is used to facilitate API management and auditing.

x-correlation-id

string

\w{8}-\w{4}-\w{4}-\w{4}-\w{12}

This header is used to uniquely identify the HTTP request and to facilitate troubleshooting.

x-idempotency-key

string

\w{8}-\w{4}-\w{4}-\w{4}-\w{12}

Unique request identifier to support idempotency. You may generate (UUID v4) value using the programming language.

Responses

200Success

400Bad Request

500Server Error

503Server Error