Types of events

Calypso supports a number of different event types, and you can filter your notification requests depending on types or group of events you send in the request.

There are two ways to subscribe to notifications. You can send values in one of following fields (or in both) using a POST request to the create webhook endpoint:

  • notificationServiceTypes - groups of possible event types: [INVOICE, PAYOUT, RECURRENT]. Send values in this field to subscribe to all events of chosen group. See list of events in each group below in the section Events by group.
  • notificationEventTypes - event types for which you can receive notifications. Send values in this field to subscribe to particular events. See list of events below in the section Events by group.

Events by group

INVOICE

Event typeDescription
INVOICE_CREATE_INVOICENew single invoice has been created
INVOICE_CREATE_UNLIMITED_INVOICENew unlimited invoice has been created
INVOICE_FUNDS_RECEIVED_FOR_INVOICEFunds have been received to invoice wallet
INVOICE_TRANSLATION_TO_ACCOUNT_COMPLETEDFunds have been received from invoice wallet to the merchant balance.
INVOICE_PENDING_INTERVENTIONInvoice has changed state to INVOICE_PENDING_INTERVENTION. Either more or less funds was received to the invoice wallet than required.
INVOICE_EXPIREDInvoice expiration date has expired.
INVOICE_PAIDInvoice successfully paid. All required amount has been received to invoice wallet.
INVOICE_MEMPOOL_FOUNDInvoice transaction has been found in mempool but still not confirmed in blockchain.
INVOICE_PENDING_COMPLIANCEInvoice transaction is being reviewed by our compliance service
INVOICE_COMPLIANCE_DECLINEDInvoice has been suspended due to our compliance policy

PAYOUT

Event typeDescription
PAYOUT_CHANGE_STATUSPayout has changed state to In Progress, Canceled, Failed or Completed
PAYOUT_CONFIRMEDPayout has changed state to Confirmed
PAYOUT_VALIDATION_ERRORValidation error has occurred during payout processing

TOP-UP

Event typeDescription
TOP_UP_PENDING_COMPLIANCETop-up transaction is being reviewed by our compliance service
TOP_UP_COMPLIANCE_DECLINEDTop-up has been suspended due to our compliance policy
WALLET_FUNDS_DELIVERED_ACCOUNTThe funds have been successfully received