Skip to main content
GET
Verify the status of a payin invoice

Headers

Apikey
string
required
API key of the LigdiCash project.
Authorization
string
required
Bearer {API_TOKEN}
Accept
string
required
application/json

Query parameter

invoiceToken
string
required
Token returned by the create endpoint at invoice creation. Do not use the callback token — they are different.

Response

response_code
string
"00" = call succeeded, "01" = technical error.
status
string
Payment status: completed, pending, or notcompleted.
token
string
Empty in the confirm response.
response_text
string
Error sub-code if response_code = "01", empty otherwise.
description
string
Free-form description. Can be empty.
operator_id
string
Identifier of the operator used. Empty if status = pending.
operator_name
string
Operator name. Empty if status = pending.
customer
string
Payer’s number. null if status = pending.
montant
integer
Amount in XOF.
amount
integer
Same as montant.
date
string
Transaction date. Format: YYYY-MM-DD HH:MM:SS+TZ.
external_id
string
Concatenation of valueof_customdata values whose key contains "id". Matches the transaction_id if the pattern is respected.
oreference
string
Operator reference. Can be empty.
request_id
string
Unique LigdiCash identifier. Useful for support.
custom_data
array
Metadata enriched by LigdiCash.
customer_details
object
wiki
string
URL to the sub-codes documentation.
statusMeaning
completedPayment confirmed
pendingAwaiting operator processing
notcompletedPayment did not go through

Error codes

Wiki: https://client.ligdicash.com/wiki/confirmInvoice — see Sub-codes per endpoint.