Get Bank Branches

get

https://api.instantcashworldwide.ae/sandbox/api/v1/banks/branches

Gets bank branches available for Delivery Mode (04) Account Transfer to other Bank.

Receiving Countries

To get all available receiving countries use GET /receiving-counties endpoint.

Delivery Modes

To get all avaliable delivery modes use GET /types?filter=delivery-modes endpoint.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

receivingCountry

string

required

length ≥ 1

Receiving Country (Required)

Format: ISO-3166 alpha-2 code

deliveryMode

int32

required

Delivery Mode. (Required)

Use the '/types?filter=delivery-modes' endpoint to get a list of allowed types.

receivingAgentHeadOfficeCode

string

required

length ≥ 1

Receiving Agent Head Office Code. (Required)

Six characters Code (IN1458, PK1011 etc.)

bankName

string | null

Searches for bank branches by name using the contains operation. (Optional)

bankCode

string | null

Bank code or Routing number. (Optional)

When a bank code is used in conjunction with a receiving head office code,
keep in mind that the bank code must belong to that head office. Otherwise, you will get an empty result.

branchLocation

string | null

Searches for bank branches at Address Line 1 using the contains operation. (Optional)

address

string | null

Searches for bank branches at Address Line 2 using the contains operation. (Optional)

district

string | null

Searches for bank branches at District using the contains operation. (Optional)

Applicable if the receiving country is Bangladesh.

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