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 type	Description
INVOICE_CREATE_INVOICE	New single invoice has been created
INVOICE_CREATE_UNLIMITED_INVOICE	New unlimited invoice has been created
INVOICE_FUNDS_RECEIVED_FOR_INVOICE	Funds have been received to invoice wallet
INVOICE_TRANSLATION_TO_ACCOUNT_COMPLETED	Funds have been received from invoice wallet to the merchant balance.
INVOICE_PENDING_INTERVENTION	Invoice has changed state to INVOICE_PENDING_INTERVENTION. Either more or less funds was received to the invoice wallet than required.
INVOICE_EXPIRED	Invoice expiration date has expired.
INVOICE_PAID	Invoice successfully paid. All required amount has been received to invoice wallet.
INVOICE_MEMPOOL_FOUND	Invoice transaction has been found in mempool but still not confirmed in blockchain.
INVOICE_PENDING_COMPLIANCE	Invoice transaction is being reviewed by our compliance service
INVOICE_COMPLIANCE_DECLINED	Invoice has been suspended due to our compliance polic

FIAT_DEPOSIT (Onramp)

Event type	Description
FIAT_DEPOSIT_ORDER_CREATED	Fiat order created
FIAT_DEPOSIT_ORDER_CONFIRM	Fiat order confirmed
FIAT_DEPOSIT_FIAT_FUNDS_RECEIVED	Fiat order already paid
FIAT_DEPOSIT_ORDER_EXPIRED	Fiat order expired and was not paid
FIAT_DEPOSIT_ORDER_FAILED	Fiat order payment failed, status not changed

FIAT_WITHDRAWAL (Offramp)

Event type	Description
FIAT_WITHDRAWAL_ORDER_CREATED	Withdrawal order created
FIAT_WITHDRAWAL_ORDER_CONFIRM	Withdrawal order comfirmed
FIAT_WITHDRAWAL_SUCCESS	Withdrawal order already success
FIAT_WITHDRAWAL_ORDER_EXPIRED	Withdrawal order expired and withdrawal was not fulfilled
FIAT_WITHDRAWAL_ORDER_FAILED	Withdrawal failed

FIAT_APPLIER (Onramp old)

Event type	Description
FIAT_APPLIER_FIAT_FUNDS_RECEIVED	Fiat order already paid
FIAT_APPLIER_ORDER_UNPAID	Fiat order expired and was not paid
FIAT_APPLIER_PAYMENT_FAILED	Fiat order payment failed, status not changed
FIAT_APPLIER_ADJUSTMENT	Fiat order has been adjusted

FIAT_APPLIER (Offramp old)

Event type	Description
FIAT_APPLIER_WITHDRAWAL_SUCCESS	C2F withdrawal order already success
FIAT_APPLIER_WITHDRAWAL_FAILED	C2F withdrawal order failed

TOP-UP

Event type	Description
TOP_UP_PENDING_COMPLIANCE	Top-up transaction is being reviewed by our compliance service
TOP_UP_COMPLIANCE_DECLINED	Top-up has been suspended due to our compliance policy
WALLET_FUNDS_DELIVERED_ACCOUNT	The funds have been successfully received

CUSTOMER PURSE

Event type	Description
CUSTOMER_PURSE_EXPIRED	The address was not replenished and expired after 30 days.
CUSTOMER_PURSE_MEM_POOL_FOUND	The transaction pending in the mempool.
CUSTOMER_PURSE_PENDING_COMPLIANCE	Transaction under compliance check.
CUSTOMER_PURSE_COMPLIANCE_DECLINED	The transaction failed compliance check.
CUSTOMER_PURSE_FUNDS_RECEIVED_FOR_PURSE	Transaction received successfully.
CUSTOMER_PURSE_TRANSLATION_TO_ACCOUNT_COMPLETED	Funds have been successfully credited to your account.

PAYOUT

Event type	Description
PAYOUT_CHANGE_STATUS	Payout has changed state to In Progress, Canceled, Failed or Completed
PAYOUT_CONFIRMED	Payout has changed state to Confirmed
PAYOUT_VALIDATION_ERROR	Validation error has occurred during payout processing