Endpoint:
Authorization
Example:Authorization | Bearer Paste-Your-API-Key-Here
Path Parameters
A unique identifier obtained when creating an invoice. If accessed through the dashboard, it can be found at the URL on the invoice details page.Example:6f8c19ff-5b97-4792-aa89-d2a12797b356
Response
Successful Response
Main Structure (Root)
Status message that describes the status code.
The invoice detail object.
data Structure (Object)
Invoice price or nominal value.
Invoice status (e.g. paid, unpaid, closed).
Identifier of the merchant that owns this invoice.
Invoice expiration time in timestamp form (epoch millis).
List of invoice related transactions.
Details of the customer associated with this invoice.
The primary transaction ID for this invoice.
URL for the invoice payment page.
Unique ID of the payment link (usually the same as invoice ID).
transactions Structure (Array Of Object)
Additional custom data attached to the transaction, can be null.
customer Structure (Object)
Customer’s email address.
Customer’s mobile phone number.
Errors
Returned when the API key is missing or invalid:
{ "statusCode": 401, "messages": "Unauthorized" }.
Returned when no invoice matches the provided ID:
{ "statusCode": 404, "messages": "Not Found" }.