> 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-deposits/list.md).

# List Deposits

List all fiat deposits received by your business.

Returns all fiat deposits received across your virtual accounts.

## Endpoint

```
GET /v1/deposits
```

## Authentication

| Header          | Value        |
| --------------- | ------------ |
| `Authorization` | Your API key |

## Query parameters

None currently supported (subject to change).

## Example request

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

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

{% endtab %}

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

```javascript
const response = await fetch("https://ramp-api.ivorypay.io/api/v1/deposits", {
  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/deposits",
    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/deposits", 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": "Deposits retrieved",
  "data": [
    {
      "id": "dep-uuid-1",
      "reference": "dep_abc123",
      "accountNumber": "9900123456",
      "accountName": "IvoryPay - User One",
      "currency": "NGN",
      "receivedAmount": 100000,
      "settledAmount": 99500,
      "status": "SUCCESS",
      "sourceAccountNumber": "0987654321",
      "sourceAccountName": "Sender Name",
      "sourceBankName": "GTBank",
      "paymentDate": "2026-03-26T14:30:00.000Z",
      "createdAt": "2026-03-26T14:30:00.000Z"
    }
  ]
}
```
