Skip to content
HitchPay API Docs

GLOBAL PAYMENT (CROSS-BORDER)

Get Transfer Status

Retrieve the current status and full details of a global transfer.

GET /v1/crossborder/global-transfer/{reference}


Request

Path Parameters

Parameter Type Required Description
reference string ✅ HitchPay transfer reference (e.g. HTCBE5C7CAE5A463)

Code Samples

const axios = require("axios");

const reference = "HTCBE5C7CAE5A463";

const response = await axios.get(
  `https://sandbox.hitchpay.ng/v1/crossborder/global-transfer/${reference}`,
  {
    headers: {
      Authorization: `Bearer ${process.env.ACCESS_TOKEN}`
    }
  }
);

console.log(response.data);
<?php

$reference = "HTCBE5C7CAE5A463";

$ch = curl_init();

curl_setopt_array($ch, [
  CURLOPT_URL => "https://sandbox.hitchpay.ng/v1/crossborder/global-transfer/{$reference}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer YOUR_ACCESS_TOKEN"
  ]
]);

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

echo $response;
import requests

reference = "HTCBE5C7CAE5A463"

url = f"https://sandbox.hitchpay.ng/v1/crossborder/global-transfer/{reference}"

headers = {
    "Authorization": "Bearer YOUR_ACCESS_TOKEN"
}

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

Response

200 — Success

{
  "status": "success",
  "message": "Transfer status retrieved successfully.",
  "data": {
    "reference": "HTCBE5C7CAE5A463",
    "external_reference": "REF_BANK_001",
    "status": "processing",
    "provider_status": "created",
    "provider_reference": "41978d3e-e348-5809-8d06-269efc2c79fe",
    "amount_sent": 100,
    "source_currency": "USD",
    "estimated_amount_received": 12873.28,
    "destination_currency": "KES",
    "failure_reason": null,
    "beneficiary": {
      "account_name": "Jane Doe",
      "country_code": "KE",
      "account_type": "bank"
    }
  }
}
Status Description
processing Transfer is in progress
successful Transfer completed
failed Transfer failed — see failure_reason
reversed Transfer was reversed

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