Get Deposits by Account

Get all deposits for a specific virtual account.

Retrieves all deposits received by a specific virtual account number.

Endpoint

GET /v1/deposits/account/:accountNumber

Authentication

Header

Value

x-api-key

Your API key

Path parameters

Parameter

Type

Description

accountNumber

string

Virtual account number

Example request

curl -X GET https://ramp-api.ivorypay.io/api/v1/deposits/account/9900123456 \
  -H "x-api-key: your_api_key"

const response = await fetch("https://ramp-api.ivorypay.io/api/v1/deposits/account/9900123456", {
  method: "GET",
  headers: {
    "x-api-key": "your_api_key",
  },
});

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

import requests

response = requests.get(
    "https://ramp-api.ivorypay.io/api/v1/deposits/account/9900123456",
    headers={
        "x-api-key": "your_api_key",
    },
)

print(response.json())

package main

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

func main() {
	req, _ := http.NewRequest("GET", "https://ramp-api.ivorypay.io/api/v1/deposits/account/9900123456", nil)
	req.Header.Set("x-api-key", "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

{
  "statusCode": 200,
  "success": true,
  "message": "Query successful",
  "data": [
    {
      "id": "dep-uuid-1",
      "reference": "dep_abc123",
      "accountNumber": "9900123456",
      "currency": "NGN",
      "receivedAmount": 100000,
      "settledAmount": 99500,
      "status": "SUCCESS",
      "sourceAccountName": "Sender Name",
      "paymentDate": "2026-03-26T14:30:00.000Z"
    }
  ]
}

PreviousGet Deposit by ID NextList Settlements

Last updated 1 month ago

hashtagEndpoint

hashtagAuthentication

hashtagPath parameters

hashtagExample request

hashtagExample response

Endpoint

Authentication

Path parameters

Example request

Example response