List deposits

GET

deposits

List deposits

curl --request GET \
  --url https://api.example.com/v1/deposits \
  --header 'Authorization: Bearer <token>'

{
  "deposits": [
    {
      "amount": "100.50",
      "clientRef": "609eddec-9b97-4f41-8db3-ef9342263418",
      "createdAt": "2024-01-15T10:30:00Z",
      "currency": "EUR",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "method": "manual_deposit",
      "status": "completed",
      "updatedAt": "2024-01-15T10:35:00Z",
      "errorMessage": "Payment declined by bank",
      "providerTransactionId": "TXN-123456789"
    }
  ],
  "hasMore": true,
  "nextCursor": "2024-01-15T10:30:00.000Z__a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}

Authorizations

Authorization

string

header

required

Enter Auth0 JWT token

Query Parameters

status

enum<string>

Filter deposits by status

Available options:

pending,

processing,

completed,

failed,

cancelled,

refunding,

refunded,

in_review

cursor

string

Cursor for pagination (composite: timestamp__uuid)

Example:

"2024-01-15T10:30:00.000Z__a1b2c3d4-e5f6-7890-abcd-ef1234567890"

limit

number

default:20

Number of items per page (1-100, default 20)

Required range: 1 <= x <= 100

Example:

20

Response

List of deposits retrieved successfully

deposits

object[]

required

List of deposits

Show child attributes

hasMore

boolean

required

Whether there are more deposits to load

Example:

true

nextCursor

string

Next cursor for pagination (composite: timestamp__uuid)

Example:

"2024-01-15T10:30:00.000Z__a1b2c3d4-e5f6-7890-abcd-ef1234567890"

Create depositCreate a new deposit. This endpoint supports various payment methods, including generating bank account details (IBAN and BIC) for manual bank transfers, or initiating other provider-specific payin flows based on the provided currency and user details. For NGN currency, additional user details (firstName, lastName, email, phoneNumber) are required to generate dynamic virtual accounts via Payonus.

List deposits

curl --request GET \
  --url https://api.example.com/v1/deposits \
  --header 'Authorization: Bearer <token>'

{
  "deposits": [
    {
      "amount": "100.50",
      "clientRef": "609eddec-9b97-4f41-8db3-ef9342263418",
      "createdAt": "2024-01-15T10:30:00Z",
      "currency": "EUR",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "method": "manual_deposit",
      "status": "completed",
      "updatedAt": "2024-01-15T10:35:00Z",
      "errorMessage": "Payment declined by bank",
      "providerTransactionId": "TXN-123456789"
    }
  ],
  "hasMore": true,
  "nextCursor": "2024-01-15T10:30:00.000Z__a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}