Catch up on events you missed
Returns the events sent to your webhooks, in the order we received them, each exactly as it was delivered. An event that arrived late comes after the ones before it, even if its createdAt is earlier, so after never skips it. Events show up here a few seconds after they arrive. Pass the id of the last event you processed as after to get everything since; leave it out to start from the first event. Keep calling with nextAfter until it is absent, then resume later from the id of the last item. Collection events and payment request events need the collections.read permission, payout and utility purchase events need disbursements.read, settlement events need settlements.read, transfer events need wallettransfer.read hold events need holds.read, wallet freeze events need wallets.read and subscription events need mandates.read; you only see the types your key holds. Events only arrive once your business has a webhook endpoint, and utility purchase, settlement, transfer hold, wallet freeze and subscription events start after an endpoint is created or edited in the console. Events are kept for 90 days. An after older than that is refused with 400; start again without it.
/v1/eventsAuthorizationBearer token (JWT) · headerrequiredA token from POST /v1/oauth/token on the iSmartPay identity service, obtained with an API credential's client id and secret.
afterstringThe id of the last event you processed. An id that is not one of your events, or one older than 90 days, is refused.
limitintegerHow many events to return, 1 to 200. Defaults to 50.
A page of events.
itemsCollectionAcceptedEvent | CollectionStatusChangedEvent | PayoutAcceptedEvent | PayoutStatusChangedEvent | UtilityPurchaseAcceptedEvent | UtilityPurchaseStatusChangedEvent | SettlementStatusChangedEvent | TransferStatusChangedEvent | TransferReceivedEvent | PaymentRequestReceivedEvent | CheckoutPaidEvent | CheckoutPaymentFailedEvent | CheckoutExpiredEvent | CheckoutCancelledEvent | HoldStatusChangedEvent | WalletFrozenEvent | WalletUnfrozenEvent | SubscriptionCreatedEvent | SubscriptionStatusChangedEvent | SubscriptionChargeUpcomingEvent | SubscriptionChargeSucceededEvent | SubscriptionChargeFailedEvent[]requiredShow propertiesHide properties
CollectionAcceptedEvent | CollectionStatusChangedEvent | PayoutAcceptedEvent | PayoutStatusChangedEvent | UtilityPurchaseAcceptedEvent | UtilityPurchaseStatusChangedEvent | SettlementStatusChangedEvent | TransferStatusChangedEvent | TransferReceivedEvent | PaymentRequestReceivedEvent | CheckoutPaidEvent | CheckoutPaymentFailedEvent | CheckoutExpiredEvent | CheckoutCancelledEvent | HoldStatusChangedEvent | WalletFrozenEvent | WalletUnfrozenEvent | SubscriptionCreatedEvent | SubscriptionStatusChangedEvent | SubscriptionChargeUpcomingEvent | SubscriptionChargeSucceededEvent | SubscriptionChargeFailedEventidstringrequiredThe event id, the same as the Webhook-Id header.
typestringrequiredcreatedAtstring<date-time>requiredWhen the change happened.
dataCollectionrequiredThe collection as it stood when the event was sent. Fields the event did not carry are left out, so fetch the collection by reference when you need the full record.
Show propertiesHide properties
referencestringrequiredThe reference you chose.
amountstringThe requested amount. A decimal string in major units.
currencystringThree-letter currency code.
statusstringrequiredWhere the request stands, reported as it is: accepted, dispatched, in_review, held, settled, failed or expired. Others can appear, so do not treat this list as closed. A payment request ends failed when the payer declines or you cancel it, and expired when nobody answers in time.
providerstringThe provider used.
feestringThe fee charged. Left out when none was recorded. A decimal string in major units.
feeBearerstringWho pays the fee. initiator: the party who starts the request pays the amount plus the fee, and the recipient gets the full amount. non_initiator: the fee comes out of what the recipient gets.
initiatornon_initiatorpayerAmountstringWhat the payer is charged. Left out when the fee bearer is not known. A decimal string in major units.
recipientAmountstringWhat the recipient receives. Left out when the fee bearer is not known. A decimal string in major units.
notestringThe note you sent.
failureReasonstringWhy it failed. For a payment request: declined, cancelled or expired. For other providers, the provider's own reason when there is one. Left out otherwise.
createdAtstring<date-time>completedAtstring<date-time>When it reached its final status. Left out while it is still moving, and on older movements where the time was not recorded.
expiresAtstring<date-time>Payment requests only. When an open request ends expired. Left out on other collections.
channelstringHow it was started. api is the only value today.
apisettlementStatusstringWhere the money stands with settlement: not_eligible, eligible, claimed or settled.
not_eligibleeligibleclaimedsettledreconciliationReconciliationWhat the platform's check against the provider concluded.
Show propertiesHide properties
statusstringrequiredunchecked (not checked yet), matched (the provider agrees) or mismatched (the provider disagrees; the platform is looking into it).
uncheckedmatchedmismatchedcheckedAtstring<date-time>When it was last checked. Left out until it has been.
parentLineageLinkThe movement this one undoes, when it is a reversal. Left out otherwise.
Show propertiesHide properties
typestringrequiredWhat kind of movement it is.
collectionpayoutwallet_transferreferencestringrequiredIts reference.
compensationLineageLinkThe reversal recorded against this movement. Left out when there is none.
walletIdstring<uuid>The wallet the money went into or came out of, when one was named.
idstringrequiredThe event id, the same as the Webhook-Id header.
typestringrequiredcreatedAtstring<date-time>requiredWhen the change happened.
dataCollectionrequiredThe collection as it stood when the event was sent. Fields the event did not carry are left out, so fetch the collection by reference when you need the full record.
Show propertiesHide properties
referencestringrequiredThe reference you chose.
amountstringThe requested amount. A decimal string in major units.
currencystringThree-letter currency code.
statusstringrequiredWhere the request stands, reported as it is: accepted, dispatched, in_review, held, settled, failed or expired. Others can appear, so do not treat this list as closed. A payment request ends failed when the payer declines or you cancel it, and expired when nobody answers in time.
providerstringThe provider used.
feestringThe fee charged. Left out when none was recorded. A decimal string in major units.
feeBearerstringWho pays the fee. initiator: the party who starts the request pays the amount plus the fee, and the recipient gets the full amount. non_initiator: the fee comes out of what the recipient gets.
initiatornon_initiatorpayerAmountstringWhat the payer is charged. Left out when the fee bearer is not known. A decimal string in major units.
recipientAmountstringWhat the recipient receives. Left out when the fee bearer is not known. A decimal string in major units.
notestringThe note you sent.
failureReasonstringWhy it failed. For a payment request: declined, cancelled or expired. For other providers, the provider's own reason when there is one. Left out otherwise.
createdAtstring<date-time>completedAtstring<date-time>When it reached its final status. Left out while it is still moving, and on older movements where the time was not recorded.
expiresAtstring<date-time>Payment requests only. When an open request ends expired. Left out on other collections.
channelstringHow it was started. api is the only value today.
apisettlementStatusstringWhere the money stands with settlement: not_eligible, eligible, claimed or settled.
not_eligibleeligibleclaimedsettledreconciliationReconciliationWhat the platform's check against the provider concluded.
parentLineageLinkThe movement this one undoes, when it is a reversal. Left out otherwise.
compensationLineageLinkThe reversal recorded against this movement. Left out when there is none.
walletIdstring<uuid>The wallet the money went into or came out of, when one was named.
idstringrequiredThe event id, the same as the Webhook-Id header.
typestringrequiredcreatedAtstring<date-time>requiredWhen the change happened.
dataPayoutrequiredThe payout as it stood when the event was sent. Fields the event did not carry are left out, so fetch the payout by reference when you need the full record.
Show propertiesHide properties
referencestringrequiredThe reference you chose.
amountstringThe requested amount. A decimal string in major units.
currencystringThree-letter currency code.
statusstringrequiredWhere the request stands, reported as it is: accepted, dispatching, in_review, held, delivered, failed or refunded. Others can appear, so do not treat this list as closed.
providerstringThe provider used.
feestringThe fee charged. Left out when none was recorded. A decimal string in major units.
feeBearerstringWho pays the fee. initiator: the party who starts the request pays the amount plus the fee, and the recipient gets the full amount. non_initiator: the fee comes out of what the recipient gets.
initiatornon_initiatorpayerAmountstringWhat the payer is charged. Left out when the fee bearer is not known. A decimal string in major units.
recipientAmountstringWhat the recipient receives. Left out when the fee bearer is not known. A decimal string in major units.
notestringThe note you sent.
failureReasonstringThe provider's own reason when the request failed. Left out otherwise.
createdAtstring<date-time>completedAtstring<date-time>When it reached its final status. Left out while it is still moving, and on older movements where the time was not recorded.
channelstringHow it was started. api is the only value today.
apireconciliationReconciliationWhat the platform's check against the provider concluded.
parentLineageLinkThe movement this one undoes, when it is a reversal. Left out otherwise.
compensationLineageLinkThe reversal recorded against this movement. Left out when there is none.
walletIdstring<uuid>The wallet the money went into or came out of, when one was named.
idstringrequiredThe event id, the same as the Webhook-Id header.
typestringrequiredcreatedAtstring<date-time>requiredWhen the change happened.
dataPayoutrequiredThe payout as it stood when the event was sent. Fields the event did not carry are left out, so fetch the payout by reference when you need the full record.
Show propertiesHide properties
referencestringrequiredThe reference you chose.
amountstringThe requested amount. A decimal string in major units.
currencystringThree-letter currency code.
statusstringrequiredWhere the request stands, reported as it is: accepted, dispatching, in_review, held, delivered, failed or refunded. Others can appear, so do not treat this list as closed.
providerstringThe provider used.
feestringThe fee charged. Left out when none was recorded. A decimal string in major units.
feeBearerstringWho pays the fee. initiator: the party who starts the request pays the amount plus the fee, and the recipient gets the full amount. non_initiator: the fee comes out of what the recipient gets.
initiatornon_initiatorpayerAmountstringWhat the payer is charged. Left out when the fee bearer is not known. A decimal string in major units.
recipientAmountstringWhat the recipient receives. Left out when the fee bearer is not known. A decimal string in major units.
notestringThe note you sent.
failureReasonstringThe provider's own reason when the request failed. Left out otherwise.
createdAtstring<date-time>completedAtstring<date-time>When it reached its final status. Left out while it is still moving, and on older movements where the time was not recorded.
channelstringHow it was started. api is the only value today.
apireconciliationReconciliationWhat the platform's check against the provider concluded.
parentLineageLinkThe movement this one undoes, when it is a reversal. Left out otherwise.
compensationLineageLinkThe reversal recorded against this movement. Left out when there is none.
walletIdstring<uuid>The wallet the money went into or came out of, when one was named.
idstringrequiredThe event id, the same as the Webhook-Id header.
typestringrequiredcreatedAtstring<date-time>requiredWhen the change happened.
dataUtilityPurchaserequiredThe purchase as it stood when the event was sent. The beneficiary's number and the payer are not carried, and other fields the event did not carry are left out, so fetch the purchase by reference when you need the full record.
Show propertiesHide properties
referencestringrequiredThe reference you chose.
statusstringrequiredWhere the purchase stands, reported as it is: accepted, awaiting_payment, vending, delivered, failed, refunding, refunded, refund_failed or outcome_unknown. delivered, failed and refunded are final. outcome_unknown and refund_failed are resolved by iSmartPay: do not buy again with a new reference.
productobjectShow propertiesHide properties
idstringcategorystringnetworkstringnamestringbeneficiaryobjectShow propertiesHide properties
msisdnstringaccountNumberstringamountstringThe amount bought. A decimal string in major units.
currencystringThree-letter currency code. Only GHS is sold.
feestringThe fee charged. Left out when none was recorded. A decimal string in major units.
grossstringThe amount plus the fee. Left out when no fee was recorded. A decimal string in major units.
fundingobjectShow propertiesHide properties
typestringwalletcollectionpayerobjectShow propertiesHide properties
providerstringmsisdnstringfailureReasonstringWhy the purchase failed, for example vend_failed or insufficient_balance. Left out otherwise.
createdAtstring<date-time>walletIdstring<uuid>The wallet the money went into or came out of, when one was named.
idstringrequiredThe event id, the same as the Webhook-Id header.
typestringrequiredcreatedAtstring<date-time>requiredWhen the change happened.
dataUtilityPurchaserequiredThe purchase as it stood when the event was sent. The beneficiary's number and the payer are not carried, and other fields the event did not carry are left out, so fetch the purchase by reference when you need the full record.
Show propertiesHide properties
referencestringrequiredThe reference you chose.
statusstringrequiredWhere the purchase stands, reported as it is: accepted, awaiting_payment, vending, delivered, failed, refunding, refunded, refund_failed or outcome_unknown. delivered, failed and refunded are final. outcome_unknown and refund_failed are resolved by iSmartPay: do not buy again with a new reference.
productobjectShow propertiesHide properties
idstringcategorystringnetworkstringnamestringbeneficiaryobjectShow propertiesHide properties
msisdnstringaccountNumberstringamountstringThe amount bought. A decimal string in major units.
currencystringThree-letter currency code. Only GHS is sold.
feestringThe fee charged. Left out when none was recorded. A decimal string in major units.
grossstringThe amount plus the fee. Left out when no fee was recorded. A decimal string in major units.
fundingobjectShow propertiesHide properties
typestringwalletcollectionpayerobjectShow propertiesHide properties
providerstringmsisdnstringfailureReasonstringWhy the purchase failed, for example vend_failed or insufficient_balance. Left out otherwise.
createdAtstring<date-time>walletIdstring<uuid>The wallet the money went into or came out of, when one was named.
idstringrequiredThe event id, the same as the Webhook-Id header.
typestringrequiredcreatedAtstring<date-time>requiredWhen the change happened.
dataSettlementRunEventDatarequiredA settlement run as carried by its event. The event has no run id; list runs with GET /v1/settlements and match on reference when you need it.
Show propertiesHide properties
referencestringrequiredstatusstringrequiredrunning or completed. Others can appear, so do not treat this list as closed.
outcomestringSet once completed: settled, failed_partial or failed_all. Others can appear.
itemCountintegerrequiredHow many payments the run made.
totalstringrequiredThe amount settled. A decimal string in major units.
currencystringrequiredstartedAtstring<date-time>requiredcompletedAtstring<date-time>idstringrequiredThe event id, the same as the Webhook-Id header.
typestringrequiredcreatedAtstring<date-time>requiredWhen the change happened.
dataTransferrequiredThe transfer as it stood when the event was sent. The recipient's handle and name are not carried; fetch the transfer by reference when you need them.
Show propertiesHide properties
referencestringrequiredamountstringrequiredA decimal string in major units.
currencystringrequiredstatusstringrequiredWhere the transfer stands: pending, held, completed, declined or failed. Others can appear, so do not treat this list as closed.
recipientHandlestringReturned when you send.
recipientNamestringThe handle's display name, else the recipient's trading name, else registered name, when known.
failureReasonstringWhy a declined or failed transfer did not go through. Left out otherwise.
createdAtstring<date-time>walletIdstring<uuid>The wallet the money went into or came out of, when one was named.
idstringrequiredThe event id, the same as the Webhook-Id header.
typestringrequiredcreatedAtstring<date-time>requiredWhen the change happened.
dataTransferReceivedrequiredThe transfer that reached your wallet.
Show propertiesHide properties
referencestringrequiredThe reference the sending business chose.
amountstringrequiredWhat reached your wallet. A decimal string in major units.
currencystringrequiredsenderNamestringThe sending business's trading name, else registered name, when known.
completedAtstring<date-time>walletIdstring<uuid>The wallet the money went into or came out of, when one was named.
idstringrequiredThe event id, the same as the Webhook-Id header.
typestringrequiredcreatedAtstring<date-time>requiredWhen the change happened.
dataPaymentRequestReceivedrequiredThe request that was sent to you.
Show propertiesHide properties
requestIdstringrequirediSmartPay's id for the request.
referencestringrequiredThe reference the requester chose.
requesterNamestringrequiredWho is asking: a person's full name, or for a business its display name, which is its @handle when it set none.
requesterKindstringrequiredWhether the requester is a customer or a business.
consumerbusinessamountstringrequiredWhat is being asked for. A decimal string in major units.
currencystringrequirednotestringThe requester's note, when they sent one.
expiresAtstring<date-time>requiredWhen the request expires if nobody answers.
idstringrequiredThe 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.
idstringrequiredThe 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.
walletIdstring<uuid>The wallet the money went into or came out of, when one was named.
idstringrequiredThe 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.
walletIdstring<uuid>The wallet the money went into or came out of, when one was named.
idstringrequiredThe 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.
walletIdstring<uuid>The wallet the money went into or came out of, when one was named.
idstringrequiredThe event id, the same as the Webhook-Id header.
typestringrequiredcreatedAtstring<date-time>requiredWhen the change happened.
dataHoldrequiredThe hold as it stood when the event was sent, as the receiving business sees it. The placing business's copy has no id, decidedAt or createdAt, and the beneficiary's has no createdAt; read the hold for them.
Show propertiesHide properties
idstring<uuid>The hold's id. A beneficiary business reads and returns the hold with it.
referencestringrequiredThe placing business's reference.
statusstringrequiredheld until someone decides. paying_out while a payout to an external beneficiary is on the rail; if it fails, the hold is held again. paid_out and returned are final.
heldpaying_outpaid_outreturnedamountstringrequiredA decimal string in major units.
currencystringrequiredfeestringOn an external hold, the payout fee in major units, priced when the hold is placed. The beneficiary still receives the full amount.
totalHeldstringOn an external hold, amount plus fee: what left your wallet, and what a return gives back.
reasonstringwalletIdstring<uuid>For the placing business, the wallet the money is held from. For the beneficiary, the wallet it would land in.
beneficiaryHoldPartyShown to the placing business. A business beneficiary carries businessName, never an id.
Show propertiesHide properties
typestringsub_accountbusinessexternalwalletIdstring<uuid>businessNamestringThe business's display name, when known.
providerstringOn an external beneficiary.
destinationobjectOn an external beneficiary.
Show propertiesHide properties
typestringrequiredmsisdnaccountvaluestringrequiredThe mobile money number or bank account number.
accountNamestringOn an external beneficiary, the account name the provider returned when the hold was placed. Absent where the rail cannot look names up, as with banks.
payoutobjectOn an external hold once a pay-out has been asked for: the latest payout attempt.
Show propertiesHide properties
attemptintegerstatusstringfailureReasonstringplacedByHoldPartyShown to the beneficiary business instead of beneficiary.
expiresAtstring<date-time>onExpirystringreturnpay_outdecidedBystringWho decided a final hold. ismartpay is a decision by iSmartPay support.
payerbeneficiaryexpiryismartpaydecidedAtstring<date-time>createdAtstring<date-time>idstringrequiredThe event id, the same as the Webhook-Id header.
typestringrequiredcreatedAtstring<date-time>requiredWhen the change happened.
dataWalletFreezerequiredThe wallet that was frozen.
Show propertiesHide properties
walletIdstring<uuid>requiredThe wallet's id.
typestringrequiredThe wallet's type, as on a sub-account.
primarysub_accountoperationalpersonallabelstringrequiredreferencestringThe reference you gave the wallet. Left out for wallets made without one.
statusstringrequiredThe wallet's status after the change. After wallet.unfrozen it is frozen while another freeze is still in place.
activefrozenfrozenBystringrequiredWho froze the wallet, or who lifted the freeze for wallet.unfrozen: your business, or iSmartPay. iSmartPay's reason is never sent.
ownerstaffidstringrequiredThe event id, the same as the Webhook-Id header.
typestringrequiredcreatedAtstring<date-time>requiredWhen the change happened.
dataWalletFreezerequiredThe wallet that was unfrozen.
Show propertiesHide properties
walletIdstring<uuid>requiredThe wallet's id.
typestringrequiredThe wallet's type, as on a sub-account.
primarysub_accountoperationalpersonallabelstringrequiredreferencestringThe reference you gave the wallet. Left out for wallets made without one.
statusstringrequiredThe wallet's status after the change. After wallet.unfrozen it is frozen while another freeze is still in place.
activefrozenfrozenBystringrequiredWho froze the wallet, or who lifted the freeze for wallet.unfrozen: your business, or iSmartPay. iSmartPay's reason is never sent.
ownerstaffidstringrequiredThe event id, the same as the Webhook-Id header.
typestringrequiredcreatedAtstring<date-time>requiredWhen the change happened.
dataSubscriptionEventDatarequiredA subscription as it stood when the event happened. It carries the fields that changed with it; read the subscription for the rest, such as fee and totalAmount.
Show propertiesHide properties
idstringrequiredreferencestringrequiredstatusstringrequiredincompleteincomplete_expiredtrialingactivepast_duepausedcanceledcompletedpreviousStatusstringAbsent on subscription.created.
incompleteincomplete_expiredactivepast_duepausedcanceledcompletedpaymentMethodstringrequiredmobile_moneywalletcustomerobjectrequiredShow propertiesHide properties
networkstringmtntelecelamountstringrequiredA decimal string in major units, before the fee.
currencystringrequirednextChargeAtstring<date-time> | nullrequiredcyclesChargedintegerrequiredcancelAtPeriodEndbooleanrequiredcancelAtstring<date-time>cancelReasonstringbusinessnetworkplatformdeclineReasonstringdeclinedno_responsepausedBystringbusinessplatformidstringrequiredThe event id, the same as the Webhook-Id header.
typestringrequiredcreatedAtstring<date-time>requiredWhen the change happened.
dataSubscriptionEventDatarequiredA subscription as it stood when the event happened. It carries the fields that changed with it; read the subscription for the rest, such as fee and totalAmount.
Show propertiesHide properties
idstringrequiredreferencestringrequiredstatusstringrequiredincompleteincomplete_expiredtrialingactivepast_duepausedcanceledcompletedpreviousStatusstringAbsent on subscription.created.
incompleteincomplete_expiredactivepast_duepausedcanceledcompletedpaymentMethodstringrequiredmobile_moneywalletcustomerobjectrequiredShow propertiesHide properties
networkstringmtntelecelamountstringrequiredA decimal string in major units, before the fee.
currencystringrequirednextChargeAtstring<date-time> | nullrequiredcyclesChargedintegerrequiredcancelAtPeriodEndbooleanrequiredcancelAtstring<date-time>cancelReasonstringbusinessnetworkplatformdeclineReasonstringdeclinedno_responsepausedBystringbusinessplatformidstringrequiredThe event id, the same as the Webhook-Id header.
typestringrequiredcreatedAtstring<date-time>requiredWhen the change happened.
dataSubscriptionChargeUpcomingDatarequiredThe charge that is coming up.
Show propertiesHide properties
subscriptionIdstringrequiredsubscriptionReferencestringrequiredcycleintegerrequireddueAtstring<date-time>requiredamountstringrequiredWhat the customer is charged, fee included. A decimal string in major units.
currencystringrequiredidstringrequiredThe event id, the same as the Webhook-Id header.
typestringrequiredcreatedAtstring<date-time>requiredWhen the change happened.
dataSubscriptionChargeEventDatarequiredThe charge that was paid.
Show propertiesHide properties
idstringrequiredsubscriptionIdstringrequiredsubscriptionReferencestringrequiredcycleintegerrequireddueAtstring<date-time>requiredamountstringrequiredWhat the customer is charged, fee included. A decimal string in major units.
currencystringrequiredattemptintegerrequiredstatusstringrequiredpaidfaileduncollectiblefailureReasonstringnextAttemptAtstring<date-time> | nullrequiredWhen a failed attempt will be tried again. Null when there is no further attempt this cycle.
idstringrequiredThe event id, the same as the Webhook-Id header.
typestringrequiredcreatedAtstring<date-time>requiredWhen the change happened.
dataSubscriptionChargeEventDatarequiredThe charge attempt that failed.
Show propertiesHide properties
idstringrequiredsubscriptionIdstringrequiredsubscriptionReferencestringrequiredcycleintegerrequireddueAtstring<date-time>requiredamountstringrequiredWhat the customer is charged, fee included. A decimal string in major units.
currencystringrequiredattemptintegerrequiredstatusstringrequiredpaidfaileduncollectiblefailureReasonstringnextAttemptAtstring<date-time> | nullrequiredWhen a failed attempt will be tried again. Null when there is no further attempt this cycle.
nextAfterstringPass as after to get the next page. Absent on the last page.
The request is not valid. message says which field.
errorobjectrequiredShow propertiesHide properties
codestringrequiredA stable, machine-readable code. Branch on this, not on the message. Codes include invalid_input, unauthenticated, forbidden, environment_mismatch, not_found, rate_limited, idempotency_key_reused, request_in_flight, limits_missing, limits_unusable, tier_ineligible, transaction_limit_exceeded, daily_limit_exceeded, monthly_limit_exceeded, new_destination_limit, business_suspended, business_deactivated, environment_unknown, duplicate_reference, provider_error, provider_timeout, destination_not_verified, destination_verification_unavailable, upstream_timeout and internal.
messagestringrequiredReadable detail for a person. For any 5xx it is always the fixed text internal server error.
The token is missing, expired or not valid. Get a new one from the token endpoint.
errorobjectrequiredShow propertiesHide properties
codestringrequiredA stable, machine-readable code. Branch on this, not on the message. Codes include invalid_input, unauthenticated, forbidden, environment_mismatch, not_found, rate_limited, idempotency_key_reused, request_in_flight, limits_missing, limits_unusable, tier_ineligible, transaction_limit_exceeded, daily_limit_exceeded, monthly_limit_exceeded, new_destination_limit, business_suspended, business_deactivated, environment_unknown, duplicate_reference, provider_error, provider_timeout, destination_not_verified, destination_verification_unavailable, upstream_timeout and internal.
messagestringrequiredReadable detail for a person. For any 5xx it is always the fixed text internal server error.
The request was understood and refused. Common causes: the token is not an API credential's (forbidden); the credential is for the other environment (environment_mismatch); it does not have the permission this operation needs (forbidden); a limit was reached (limits_missing, limits_unusable, tier_ineligible, transaction_limit_exceeded, daily_limit_exceeded, monthly_limit_exceeded, new_destination_limit); or iSmartPay has suspended or deactivated the business (business_suspended, business_deactivated). A suspended business's API credentials stop exchanging for tokens, so a request made with a token issued just before the suspension is refused with business_suspended.
errorobjectrequiredShow propertiesHide properties
codestringrequiredA stable, machine-readable code. Branch on this, not on the message. Codes include invalid_input, unauthenticated, forbidden, environment_mismatch, not_found, rate_limited, idempotency_key_reused, request_in_flight, limits_missing, limits_unusable, tier_ineligible, transaction_limit_exceeded, daily_limit_exceeded, monthly_limit_exceeded, new_destination_limit, business_suspended, business_deactivated, environment_unknown, duplicate_reference, provider_error, provider_timeout, destination_not_verified, destination_verification_unavailable, upstream_timeout and internal.
messagestringrequiredReadable detail for a person. For any 5xx it is always the fixed text internal server error.
Too many requests for this credential. Wait the number of seconds in the Retry-After header, then try again.
errorobjectrequiredShow propertiesHide properties
codestringrequiredA stable, machine-readable code. Branch on this, not on the message. Codes include invalid_input, unauthenticated, forbidden, environment_mismatch, not_found, rate_limited, idempotency_key_reused, request_in_flight, limits_missing, limits_unusable, tier_ineligible, transaction_limit_exceeded, daily_limit_exceeded, monthly_limit_exceeded, new_destination_limit, business_suspended, business_deactivated, environment_unknown, duplicate_reference, provider_error, provider_timeout, destination_not_verified, destination_verification_unavailable, upstream_timeout and internal.
messagestringrequiredReadable detail for a person. For any 5xx it is always the fixed text internal server error.
Something failed on our side. The message is fixed. If the request was a POST, retry with the same Idempotency-Key and body.
errorobjectrequiredShow propertiesHide properties
codestringrequiredA stable, machine-readable code. Branch on this, not on the message. Codes include invalid_input, unauthenticated, forbidden, environment_mismatch, not_found, rate_limited, idempotency_key_reused, request_in_flight, limits_missing, limits_unusable, tier_ineligible, transaction_limit_exceeded, daily_limit_exceeded, monthly_limit_exceeded, new_destination_limit, business_suspended, business_deactivated, environment_unknown, duplicate_reference, provider_error, provider_timeout, destination_not_verified, destination_verification_unavailable, upstream_timeout and internal.
messagestringrequiredReadable detail for a person. For any 5xx it is always the fixed text internal server error.