Skip to content
HitchPay API Docs

VIRTUAL ACCOUNTS

Get Collection by Reference

Fetch a single collection by its provider transaction reference.

GET /v1/customer/collections/:reference

Use this endpoint to

  • Look up one specific inflow, e.g., after receiving a virtual_account.credit webhook
  • Confirm the exact amount credited for a single transaction
  • Reconcile a specific payment reported by a customer

Request

Path parameters

Parameter Type Required Description
reference string Yes The collection's reference (provider transaction id)

Code Samples

const response = await fetch(
  "https://sandbox.hitchpay.ng/v1/customer/collections/COLLECTION_REFERENCE",
  { headers: { Authorization: "Bearer YOUR_ACCESS_TOKEN" } }
);

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

$ch = curl_init();

curl_setopt_array($ch, [
  CURLOPT_URL => "https://sandbox.hitchpay.ng/v1/customer/collections/COLLECTION_REFERENCE",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer YOUR_ACCESS_TOKEN"
  ]
]);

$response = curl_exec($ch);
curl_close($ch);

echo $response;
import requests

url = "https://sandbox.hitchpay.ng/v1/customer/collections/COLLECTION_REFERENCE"
headers = {"Authorization": "Bearer YOUR_ACCESS_TOKEN"}

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

Response

{
  "status": "success",
  "message": "Collection retrieved successfully.",
  "data": {
    "reference": "<provider transaction id>",
    "customer_uuid": "…",
    "tracking_id": "EXTACCT…",
    "account_number": "…",
    "account_name": "John Doe",
    "provider": "",
    "currency": "USD",
    "amount": 500.00,
    "fee": 0,
    "amount_credited": 500.00,
    "status": "successful",
    "sender_name": "ACME LTD",
    "sender_bank": "…",
    "created_at": "2026-07-10T10:15:00.000Z"
  }
}

Errors

Code Meaning
UNAUTHORIZED Business not found or inactive
NOT_FOUND Collection not found

Questions? Email [email protected]. Also on GitBook.