> For the complete documentation index, see [llms.txt](https://ivorypay.gitbook.io/ivorypay-on-off-ramp-documentation/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://ivorypay.gitbook.io/ivorypay-on-off-ramp-documentation/api-reference-banks/list-banks.md).

# List All Banks

Retrieve all supported banks.

Returns a list of all banks supported by IvoryPay across all currencies.

## Endpoint

```
GET /v1/banks
```

## Authentication

Accepts either a merchant API key or a business-user JWT.

| Header          | Value                             |
| --------------- | --------------------------------- |
| `Authorization` | `<api_key>` **or** `Bearer <jwt>` |

## Example request

{% tabs %}
{% tab title="cURL" %}

```bash
curl -X GET https://ramp-api.ivorypay.io/api/v1/banks \
  -H "Authorization: your_api_key"
```

{% endtab %}

{% tab title="Node.js" %}

```javascript
const response = await fetch("https://ramp-api.ivorypay.io/api/v1/banks", {
  method: "GET",
  headers: {
    "Authorization": "your_api_key",
  },
});

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

{% endtab %}

{% tab title="Python" %}

```python
import requests

response = requests.get(
    "https://ramp-api.ivorypay.io/api/v1/banks",
    headers={
        "Authorization": "your_api_key",
    },
)

print(response.json())
```

{% endtab %}

{% tab title="Go" %}

```go
package main

import (
	"fmt"
	"io"
	"net/http"
)

func main() {
	req, _ := http.NewRequest("GET", "https://ramp-api.ivorypay.io/api/v1/banks", nil)
	req.Header.Set("Authorization", "your_api_key")

	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()

	body, _ := io.ReadAll(resp.Body)
	fmt.Println(string(body))
}
```

{% endtab %}
{% endtabs %}

## Example response

```json
{
  "success": true,
  "message": "Query successful",
  "data": [
    {
      "bankName": "Access Bank",
      "bankId": "uuid-here",
      "bankCode": "044"
    },
    {
      "bankName": "GTBank",
      "bankId": "uuid-here",
      "bankCode": "058"
    },
    {
      "bankName": "First Bank",
      "bankId": "uuid-here",
      "bankCode": "011"
    }
  ]
}
```

## Response fields

| Field      | Type   | Description                                    |
| ---------- | ------ | ---------------------------------------------- |
| `bankName` | string | Display name of the bank                       |
| `bankId`   | string | IvoryPay's bank UUID                           |
| `bankCode` | string | Bank code (used in API requests like off-ramp) |