Skip to main content
Query the status of a previously initiated bank transfer. Pass the TransferCode returned when you called Send Transfer.

​
Authentication

x-api-key: your_api_key
x-api-secret: your_api_secret

​
Endpoint

This endpoint accepts both GET (query parameter) and POST (JSON body) requests. 
GET  https://api.hyparrow.com/api/v1/transfers/status?reference={transferCode}
POST https://api.hyparrow.com/api/v1/transfers/status

​
Parameters

​
reference
string
required
The TransferCode returned when the transfer was initiated.
When using POST, send reference as a JSON field in the request body instead of a query parameter.

​
Response

​
success
boolean
true when the status check request succeeds.
​
data
object
Current status details for the transfer.

​
Examples

curl -X GET "https://api.hyparrow.com/api/v1/transfers/status?reference=14531707684123456" \
  -H "x-api-key: your_api_key" \
  -H "x-api-secret: your_api_secret"

​
Success response

{
  "success": true,
  "data": {
    "responseCode": "00",
    "responseDescription": "Approved",
    "transferCode": "14531707684123456",
    "amount": "100000",
    "recipientAccount": "0123456789",
    "recipientName": "ADA CHIOMA OKAFOR",
    "recipientBankCode": "058"
  }
}

​
Error response

{
  "success": false,
  "error": "Transfer status check failed: reference not found",
  "data": null
}