List Deposits

curl --request GET \
  --url https://api.hopnow.io/ads/v1/accounts/{account_id}/deposits \
  --header 'X-API-Key: <api-key>'

import requests

url = "https://api.hopnow.io/ads/v1/accounts/{account_id}/deposits"

headers = {"X-API-Key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.hopnow.io/ads/v1/accounts/{account_id}/deposits', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.hopnow.io/ads/v1/accounts/{account_id}/deposits",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://api.hopnow.io/ads/v1/accounts/{account_id}/deposits"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.hopnow.io/ads/v1/accounts/{account_id}/deposits")
  .header("X-API-Key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.hopnow.io/ads/v1/accounts/{account_id}/deposits")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "items": [
    {
      "object": "deposit",
      "id": "api_14tch14q4n4nuqnev5e4h3si",
      "account_id": "acct_l2qk703k8k0b3snmtscacozu",
      "virtual_account_id": "va_hx8p1s44n47agkbev7umkkyu",
      "amount": "2500.00",
      "currency": "USD",
      "status": "completed",
      "bank_reference": "BREF-20260530-88421",
      "sender_name": "Acme Trading Ltd",
      "sender_reference": "INV-1042",
      "reason": null,
      "value_date": "2026-05-30",
      "completed_at": "2026-05-30T09:16:41Z",
      "failed_at": null,
      "failed_reason": null,
      "created": "2026-05-30T09:14:02Z",
      "updated": "2026-05-30T09:16:41Z"
    }
  ],
  "page": 1,
  "size": 10,
  "total": 1,
  "pages": 1
}

GET

ads

accounts

{account_id}

deposits

List Deposits

curl --request GET \
  --url https://api.hopnow.io/ads/v1/accounts/{account_id}/deposits \
  --header 'X-API-Key: <api-key>'

import requests

url = "https://api.hopnow.io/ads/v1/accounts/{account_id}/deposits"

headers = {"X-API-Key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.hopnow.io/ads/v1/accounts/{account_id}/deposits', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.hopnow.io/ads/v1/accounts/{account_id}/deposits",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://api.hopnow.io/ads/v1/accounts/{account_id}/deposits"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.hopnow.io/ads/v1/accounts/{account_id}/deposits")
  .header("X-API-Key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.hopnow.io/ads/v1/accounts/{account_id}/deposits")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "items": [
    {
      "object": "deposit",
      "id": "api_14tch14q4n4nuqnev5e4h3si",
      "account_id": "acct_l2qk703k8k0b3snmtscacozu",
      "virtual_account_id": "va_hx8p1s44n47agkbev7umkkyu",
      "amount": "2500.00",
      "currency": "USD",
      "status": "completed",
      "bank_reference": "BREF-20260530-88421",
      "sender_name": "Acme Trading Ltd",
      "sender_reference": "INV-1042",
      "reason": null,
      "value_date": "2026-05-30",
      "completed_at": "2026-05-30T09:16:41Z",
      "failed_at": null,
      "failed_reason": null,
      "created": "2026-05-30T09:14:02Z",
      "updated": "2026-05-30T09:16:41Z"
    }
  ],
  "page": 1,
  "size": 10,
  "total": 1,
  "pages": 1
}

Deposits are incoming credits to an account — funds received into one of the account’s virtual accounts (for example via a virtual-account deposit), plus other incoming account credits. Deposit endpoints are nested under the owning account (/accounts/{account_id}/deposits), consistent with the other money-domain resources. Deposits are addressed by an id with the api_ prefix.

Enum	Values
`DepositStatus`	`pending`, `completed`, `failed`, `reversed`

Returns a paginated list of incoming payments for the authenticated account, newest first. Results can be filtered by virtual account, status, currency, bank reference, and date range.

Path Parameters

string

required

Id of the owning account (e.g. acct_...).

Query Parameters

integer

Page number. Defaults to 1; must be ≥ 1.

integer

Items per page. Defaults to 10; allowed range 1–100.

string

Filter by virtual account id (va_…).

string

Filter by deposit id (api_…).

DepositStatus

Filter by status: pending, completed, failed, or reversed.

Currency

Filter by deposit currency (e.g. USD, EUR).

datetime

Created on or after this date (inclusive).

datetime

Created before this date (exclusive).

string

Exact match on the bank reference.

Response

Returns 200 with a paginated list of deposit objects.

object[]

required

Deposits in the current page. See the deposit object attributes under Get Deposit.

integer

required

Current page number.

integer

required

Items per page.

integer

required

Total items across all pages.

integer

required

Total number of pages.

{
  "items": [
    {
      "object": "deposit",
      "id": "api_14tch14q4n4nuqnev5e4h3si",
      "account_id": "acct_l2qk703k8k0b3snmtscacozu",
      "virtual_account_id": "va_hx8p1s44n47agkbev7umkkyu",
      "amount": "2500.00",
      "currency": "USD",
      "status": "completed",
      "bank_reference": "BREF-20260530-88421",
      "sender_name": "Acme Trading Ltd",
      "sender_reference": "INV-1042",
      "reason": null,
      "value_date": "2026-05-30",
      "completed_at": "2026-05-30T09:16:41Z",
      "failed_at": null,
      "failed_reason": null,
      "created": "2026-05-30T09:14:02Z",
      "updated": "2026-05-30T09:16:41Z"
    }
  ],
  "page": 1,
  "size": 10,
  "total": 1,
  "pages": 1
}

Disable Virtual Account Get Deposit

Getting Started

Integration Flows

Webhooks

Endpoints

List Deposits

Path Parameters

Query Parameters

Response

​Path Parameters

​Query Parameters

​Response

Path Parameters

Query Parameters

Response