checkout.paid
Sent when a customer pays a hosted checkout. A single-use checkout sends it once, with status paid. A reusable checkout sends it for every payment and stays open. payment is the payment that settled. The same payment also sends the usual collection.* events when it was paid with mobile money. Subscribe to it on a webhook endpoint; it is also in GET /v1/events for keys with collections.read. Answer with any 2xx within 10 seconds. Anything else, a timeout or a redirect is retried up to 6 times over about a day.
checkout.paidWebhookWebhook-IdstringrequiredThe event id. The same event can arrive more than once; use this to ignore repeats.
Webhook-TimestampstringrequiredUnix seconds when this attempt was signed. Reject a delivery older than 5 minutes.
Webhook-Signaturestringrequiredv1, then a comma, then the base64 HMAC-SHA256 of "{Webhook-Id}.{Webhook-Timestamp}.{raw body}" keyed with your endpoint's signing secret. Compare in constant time.
application/jsonidstringrequiredThe event id, the same as the Webhook-Id header.
typestringrequiredcreatedAtstring<date-time>requiredWhen the change happened.
dataCheckoutEventDatarequiredThe checkout after the change.
Show propertiesHide properties
idstringrequiredThe checkout's id.
referencestringrequiredThe reference you gave the checkout.
statusstringrequiredThe checkout's status after the change.
openpaidexpiredcancelledusagestringrequiredsinglereusablemetadataobjectrequiredThe metadata you set on the checkout, or {}.
paymentCheckoutEventPaymentThe payment, on checkout.paid and checkout.payment_failed only.
Show propertiesHide properties
collectionReferencestringrequiredThe payment's reference, the same as on the checkout's attempts and, for mobile money, on its collection.
statusstringrequiredsucceededfailedamountstringrequiredWhat the customer paid or tried to pay. A decimal string in major units.
currencystringrequiredproviderstringrequiredmtn, telecel, ismartpay for an iSmartPay request, or ismart_wallet for a wallet transfer.
payerstringThe payer's number with all but the last four digits masked, or @handle for an iSmartPay request. Absent for a wallet transfer.
failureReasonstringWhy the payment failed. Present only when status is failed.
moneyReceivedbooleanrequiredWhether the money reached your wallet. true on a failed payment means you hold money that did not pay the checkout and should be refunded.
walletIdstring<uuid>The wallet the money went into or came out of, when one was named.
Received. Any 2xx stops retries.