Skip to main content
GET
List all deposits

Overview

Retrieve a paginated list of deposits for the authenticated merchant. Deposits are inbound NGN and crypto funds received through funding accounts, such as NGN virtual accounts and crypto addresses.
Use USD account deposits for payments into USD virtual accounts.

Authentication

string
required
Your merchant API key

Query Parameters

string
Filter by deposit typeAllowed values: NGN_DEPOSIT | CRYPTO_DEPOSIT
string
Filter by deposit statusAllowed values: PENDING | RECEIVED | PROCESSING | REQUIRES_REVIEW | COMPLETED | FLAGGED | FAILED | REVERSEDFLAGGED is accepted for older integrations and maps to REQUIRES_REVIEW.
string
Filter by exact payment reference. Only applies to NGN deposits.
string
Filter by legacy onramp ID (UUID). Only applies to migrated NGN deposits.Example: 550e8400-e29b-41d4-a716-446655440000
string
Filter by legacy offramp ID (UUID). Only applies to migrated crypto deposits.Example: 550e8400-e29b-41d4-a716-446655440000
string
Filter deposits created from this time (RFC 3339, inclusive).Example: 2026-01-01T00:00:00Z
string
Filter deposits created before this time (RFC 3339, exclusive).Example: 2026-01-31T23:59:59Z
integer
Results per pageDefault: 50 | Max: 200
integer
Page number to retrieveDefault: 1

Request Examples

Response

array
required
Array of deposit objects.
integer
required
Current page number.
integer
required
Results per page.
integer
required
Total number of deposits matching filters.
integer
required
Total number of pages available.

Success Response

Next Steps

Get Deposit

Get a specific deposit by ID

Deposits Concept

Learn about deposit lifecycle