Skip to main content

Get Banks

GET /openbanking/banks

Description​

Retrieves a list of banks available through the open banking system. This endpoint requires the tenantId and countryCode headers to filter the banks by tenant and region.

Headers:

NameTypeDescription
tenantIdstring(Required) The tenant ID associated with the request.
countryCodestring(Required) The country code to filter banks.

Example Request:

curl -X GET "{{baseURL}}/openbanking/banks" \
     -H "tenantId: [tenantId]" \
     -H "countryCode: [countryCode]" \
     -H "Authorization: Bearer [access_token]"

Sample Response

{
  "status": true,
  "statusCode": 0,
  "message": "Banks retrieved successfully",
  "data": {
    // List of banks and their details
  },
  "errors": [
    {
      "message": "string",
      "data": {},
      "descriptiveMessage": "string"
    }
  ]
}

LANGUAGE

AUTHORIZATION

Bearer

CURL REQUEST

curl --request GET \ 
 --url  /openbanking/banks \ 
 --header 'accept: application/json' \ 
 --header 'content-type: application/json'

RESPONSE

Click Try It! to start a request and see the response here!