Skip to main content

Retrieve list of banks

GET /api/v1/BankStatement/banks?country=<string>

Description

This endpoint is used to get the list of banks that are supported for bank statement verifications.

Headers:

  • Accept-Language: optional, allows changing default response message language, type: string

Content-Type:

  • text/plain
  • application/json
  • text/json

ApiKey:

  • No API key required

Request Body:

  • Not applicable

URL: /api/v1/BankStatement/banks

Query Parameters:

  • country (optional): Country code of the bank

params:

  jsonCopy code{
"country": "USA"
}

Response:

  • The response is a "Success" status with a code of 200.

Schema:

  cssCopy code[  {    "bank_id": "123",    "name": "Chase Bank",    "country": "USA",    "type": "retail"  },  {    "bank_id": "124",    "name": "Bank of America",    "country": "USA",    "type": "retail"  },  {    "bank_id": "125",    "name": "Wells Fargo",    "country": "USA",    "type": "retail"  }]

Error Codes:

  • 404: Resource not found
  • 500: Internal server error

Example:

  bashCopy codeGET /api/v1/BankStatement/banks?country=USA

Response:

  jsonCopy codeHTTP/1.1 200 OK
{
"bank_id": "123",
"name": "Chase Bank",
"country": "USA",
"type": "retail"
},
{
"bank_id": "124",
"name": "Bank of America",
"country": "USA",
"type": "retail"
},
{
"bank_id": "125",
"name": "Wells Fargo",
"country": "USA",
"type": "retail"
}

Headers

Content-typeValue
Accepttext/plain

PARAMS

Content-typeValue
country<string>