Skip to navigation
API ReferenceTransfers and Debits

Check transaction status

Returns the outcome of a transfer or debit your business sent through this API. Send the reference you used, or for debit-user-account the debit_reference or credit_reference Halo returned. Only your own references are found; any other reference answers 404. If the outcome is still unknown and the transfer is at least 3 minutes old, Halo asks the bank before answering; before that it answers pending without asking.

status is success, failed or pending. amount is in kobo. While the status is pending, keep checking and do not send the transfer again.

Authentication

AuthorizationBearer

Your Halo partner API key, sent as Authorization: Bearer <key>.

Request

This endpoint expects an object.
RetrievalReferencestringRequired<=64 characters

The reference of the transfer or debit, at most 64 characters. For debit-user-account, use the debit_reference or credit_reference it returned.

Response

The recorded outcome.
statusboolean
True on success, false otherwise.
messagestring or map from strings to lists of strings
A short message. On a 422 validation failure it is an object of field names to error lists.
status_codeinteger
The HTTP status code.
dataanyOptional
The result. Left out on most errors.

Errors

401
Unauthorized Error
404
Not Found Error
422
Unprocessable Entity Error
429
Too Many Requests Error