Skip to main content
GET
Retrieve a transaction
Use this operation to get the actual status of a transaction, rather than relying on the status returned at creation. This operation (or a webhook) is what must trigger the delivery of an order, never the response of Create a transaction.
  • Reference. It accepts two interchangeable values: the internal reference returned at creation, or your own transaction_id (found under the name external_reference). There is no need to store both if you only keep transaction_id on the merchant side.
  • Status. A pending transaction can still become succeeded, failed or refunded. Wait for a final status (or a webhook) before considering the check complete.
  • Unknown reference. A reference that does not match any transaction of the authenticated account returns 404, even if it exists for another account or another environment (Sandbox/Live).
The full list of common error messages is in Errors.

Authorizations

Authorization
string
header
required

Secret key of the Sandbox or Live account

Headers

Content-Type
string
required

Required by the API authentication, including on GET requests, even though they have no body.

Allowed value: "application/json"
Ipay-Target-Environment
enum<string>
required
Available options:
sandbox,
live
Ipay-Payment-Type
string
required

Payment method. POST /payments only supports mobile (mobile money). Other payment methods (bank card and other channels) are not used here: they are available through payment links (POST /external_payments). Full list: payment methods.

Allowed value: "mobile"
Example:

"mobile"

Path Parameters

reference
string
required

Response

Transaction found for the authenticated account

public_reference
string
required
external_reference
string
required
reference
string
required
status
enum<string>
required
Available options:
initiated,
pending,
succeeded,
failed,
refunded
msisdn
string
required
amount
integer
required
validated_at
string<date-time> | null