Get Deposit by ID

Get a specific deposit by its ID.

Retrieves the details of a specific deposit.

Endpoint

GET /v1/deposits/:id

Authentication

Header	Value
x-api-key	Your API key

Path parameters

Parameter	Type	Description
id	string	Deposit UUID

Example request

cURL

curl -X GET https://ramp-api.ivorypay.io/api/v1/deposits/dep-uuid-1 \
  -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",
    "processorReference": "prov_xyz789",
    "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"
  }
}