Skip to main content
POST
/
payment
/
api
/
v1
/
transfers
/
get-institutes
curl --request POST \
  --url https://api.carbnconnect.com/payment/api/v1/transfers/get-institutes \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "country_codes": [
    "IRL",
    "DEU"
  ],
  "count": 10,
  "offset": 0
}
'
{
  "institutions": [
    {
      "institution_id": "ins_116580",
      "name": "Allied Irish Bank (IE) - Personal",
      "country_codes": [
        "IE"
      ],
      "oauth": true,
      "routing_numbers": [],
      "products": [
        "auth",
        "balance",
        "pay_by_bank",
        "payment_initiation",
        "transactions"
      ],
      "payment_initiation_metadata": {
        "supports_sepa_instant": false,
        "supports_international_payments": false,
        "supports_refund_details": false,
        "supports_payment_consents": false,
        "standing_order_metadata": {
          "supports_standing_order_end_date": false,
          "supports_standing_order_negative_execution_days": false,
          "valid_standing_order_intervals": null
        }
      }
    }
  ],
  "total": 1032,
  "request_id": "2c6567ae44fa3f7"
}

Authorizations

​
x-api-key
string
header
required

API key for authentication. Must be included in the x-api-key header.

Body

application/json
​
country_codes
string[]
required

One or more ISO 3166-1 alpha-3 country codes to filter institutions by.

Example:
["IRL", "DEU"]
​
count
integer
required

Number of institutions to return per page. Min 1, max 500.

Required range: 1 <= x <= 500
Example:

10

​
offset
integer
required

Zero-based pagination offset.

Required range: x >= 0
Example:

0

Response

Institutions retrieved successfully

​
institutions
object[]

List of matching banking institutions.

​
total
integer

Total number of institutions matching the request. Useful for calculating pagination in browse mode.

Example:

1032

​
request_id
string

Unique identifier for this request, for support and debugging.

Example:

"2c6567ae44fa3f7"