For the complete documentation index, see llms.txt. This page is also available as Markdown.

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

curl -X GET "https://ramp-api.ivorypay.io/api/v1/deposits" \
  -H "Authorization: your_api_key"
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);
import requests

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

print(response.json())

Example response

{
  "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"
    }
  ]
}

Last updated