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
Authorization	Your API key

Path parameters

Parameter	Type	Description
id	string	Deposit UUID (validated by ParseUUIDPipe — must be a valid UUID)

Example request

cURL

curl -X GET https://ramp-api.ivorypay.io/api/v1/deposits/dep-uuid-1 \
  -H "Authorization: your_api_key"

Node.js

const response = await fetch("https://ramp-api.ivorypay.io/api/v1/deposits/dep-uuid-1", {
  method: "GET",
  headers: {
    "Authorization": "your_api_key",
  },
});

const data = await response.json();
console.log(data);

Python

import requests

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

print(response.json())

Go

package main

import (
	"fmt"
	"io"
	"net/http"
)

func main() {
	req, _ := http.NewRequest("GET", "https://ramp-api.ivorypay.io/api/v1/deposits/dep-uuid-1", nil)
	req.Header.Set("Authorization", "your_api_key")

	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()

	body, _ := io.ReadAll(resp.Body)
	fmt.Println(string(body))
}

Example response

{
  "success": true,
  "message": "Deposit retrieved",
  "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"
  }
}