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
x-api-key	Your API key

Query parameters

Parameter	Type	Required	Description
status	string	No	Filter by status (e.g., SUCCESS)
currency	string	No	Filter by fiat currency (e.g., NGN)
accountNumber	string	No	Filter by virtual account number
startPeriodDatetime	string	No	Start of date range (ISO 8601)
endPeriodDatetime	string	No	End of date range (ISO 8601)
page	number	No	Page number (default: 1)
limit	number	No	Items per page (default: 20)

Example request

cURL

curl -X GET "https://ramp-api.ivorypay.io/api/v1/deposits?currency=NGN&status=SUCCESS&page=1&limit=10" \
  -H "x-api-key: your_api_key"

Node.js

Python

Go

Example response

{
  "statusCode": 200,
  "success": true,
  "message": "Query successful",
  "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"
    }
  ],
  "meta": {
    "total": 42,
    "page": 1,
    "limit": 10,
    "totalPages": 5
  }
}