List Financial Institutions

GET /remittance-middleware/list/financial/institutions

The List Financial Institutions endpoint is used to retrieve a list of financial institutions that are supported by the CSL Pay remittance middleware. A partner would call this endpoint when they need to determine which financial institutions are available for payout transactions. The endpoint returns a list of financial institutions, each with associated country code information.

Request body (optional)

This endpoint accepts a body with no declared schema.

Response 200

An array of objects. Each item has these fields:

financialInstitutionCode string
financialInstitutionName string
countryCode object10 fields
- countryCode string
- countryName string
- status boolean
- isSenderCountry boolean
- isReceiverCountry boolean
- timeMode string
- currencyResponse object5 fields
  - alphabeticCurrencyISOCode string
  - numericCurrencyISOCode string
  - minorUnit integer
  - currencyName string
  - status boolean
- fixedWindowDurationInHours integer
- accountNumberIsFixedLength boolean
- accountNumberLength integer
institutionCode string
status boolean
mobileMoney boolean

Errors

Status	Meaning
400	Failed to Retrieve Financial Institutions

Environment

Request

curl -X GET "https://api.dev.cslpay.io/remittance-middleware/list/financial/institutions" \
  -H "Authorization: Bearer <access-token>"

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
        .url("https://api.dev.cslpay.io/remittance-middleware/list/financial/institutions")
        .get()
        .addHeader("Authorization", "Bearer <access-token>")
        .build();

try (Response response = client.newCall(request).execute()) {
    if (!response.isSuccessful()) {
        throw new IOException("Unexpected status " + response.code());
    }
    System.out.println(response.body().string());
}

const response = await fetch("https://api.dev.cslpay.io/remittance-middleware/list/financial/institutions", {
  method: "GET",
  headers: {
    "Authorization": "Bearer <access-token>"
  }
});

const data = await response.json();
console.log(data);

import requests

response = requests.get(
    "https://api.dev.cslpay.io/remittance-middleware/list/financial/institutions",
    headers={
        "Authorization": "Bearer <access-token>"
    },
)

response.raise_for_status()
print(response.json())

Response

200Successfully Retrieved Financial Institutions

[
  {
    "financialInstitutionCode": "string",
    "financialInstitutionName": "string",
    "countryCode": {
      "countryCode": "string",
      "countryName": "string",
      "status": true,
      "isSenderCountry": true,
      "isReceiverCountry": true,
      "timeMode": "string",
      "currencyResponse": {
        "alphabeticCurrencyISOCode": "string",
        "numericCurrencyISOCode": "string",
        "minorUnit": 0,
        "currencyName": "string",
        "status": true
      },
      "fixedWindowDurationInHours": 0,
      "accountNumberIsFixedLength": true,
      "accountNumberLength": 0
    },
    "institutionCode": "string",
    "status": true,
    "mobileMoney": true
  }
]

400Failed to Retrieve Financial Institutions

[
  {
    "financialInstitutionCode": "string",
    "financialInstitutionName": "string",
    "countryCode": {
      "countryCode": "string",
      "countryName": "string",
      "status": true,
      "isSenderCountry": true,
      "isReceiverCountry": true,
      "timeMode": "string",
      "currencyResponse": {
        "alphabeticCurrencyISOCode": "string",
        "numericCurrencyISOCode": "string",
        "minorUnit": 0,
        "currencyName": "string",
        "status": true
      },
      "fixedWindowDurationInHours": 0,
      "accountNumberIsFixedLength": true,
      "accountNumberLength": 0
    },
    "institutionCode": "string",
    "status": true,
    "mobileMoney": true
  }
]

Authorization

Authorization: Bearer <access-token>

Sent on every request. See Getting Started.

Try it

GET /remittance-middleware/list/financial/institutions

Requests go to your test environment only. Nothing here reaches production, and your token is forwarded once and never stored.

Environment Request URL

GET

Authorization

Sent with this request only and never stored. Use a test credential — if a proxy in front of this site blocks POST, the request is retried as an encoded URL, which edge logs can capture. Get one from Getting Started.

Response

Response headers