Skip to main content
Components of CPN send webhook notifications when events occur, typically for a change in state. These webhook notifications are sent to the OFI so that they can track and manage payments in CPN. The webhooks described in this topic are specific to OFIs only. All webhook notifications follow the same payload structure. The notificationType field indicates the event type, and the notification field contains the event-specific data object. The notification object schema matches the data field returned by the corresponding API endpoint (see the API reference for details).
JSON
{
  "subscriptionId": "cd198ca6-9fc4-41d6-b6b1-8e2a9c975352",
  "notificationId": "0761b030-0c75-472a-b471-74d90a7e796c",
  // Event type, determines the structure of the notification object
  "notificationType": "cpn.payment.cryptoFundsPending",
  // Event-specific data object, structure varies by notificationType
  // See corresponding section below for the object schema (Payment, RFI, Transaction, or Refund)
  "notification": {
    // Object matching the event type
  },
  "timestamp": "2024-09-30T17:48:05.420577158Z",
  "version": 2
}
The following sections describe the webhook events by component.

​
Payment events

The notification object has the same schema as the data field returned by Get Payment.
Event nameDescriptionTrigger when
cpn.payment.cryptoFundsPendingThe payment has been created and is waiting for funds to be depositedThe payment is ready to accept crypto funds
cpn.payment.fiatPaymentInitiatedThe BFI has initiated the fiat payment to the receiver’s bank accountThe onchain transaction is confirmed by the BFI and the BFI initiated the fiat payment
cpn.payment.completedThe payment is fully processedThe fiat payment has been sent.

Depending on the payment method, the receiver may or may not have received the transfer. At this point, the CPN payment is complete.
cpn.payment.failedThe payment failed due to errors in processing, insufficient funds, or compliance rejectionThe payment can’t proceed due to an issue
cpn.payment.delayedThere is a delay to the estimate of payment settlement time. No status has changed but an updated settlement time is included in the payloadThe BFI has an internal issue such that fiat settlement takes longer to process than originally stated
cpn.payment.inManualReviewA manual review has been placed on the payment. The payment status itself remains CREATED.A payment is created but placed under manual review

​
RFI events

The notification object has the same schema as the data field returned by Get RFI.
Event nameDescriptionTrigger when
cpn.rfi.informationRequiredAdditional compliance information is needed before the payment can proceedThe BFI requests more information to proceed with the payment
cpn.rfi.inReviewThe submitted RFI response is under review by the BFIThe OFI submits the required information through the API endpoint
cpn.rfi.approvedThe RFI has been reviewed and approved, the payment can proceedThe BFI approves the submitted information
cpn.rfi.rejectedThe RFI has been reviewed and rejected, the payment is failedThe BFI rejects the submitted information

​
Transaction events

The notification object has the same schema as the data field returned by Get Transaction.
Event nameDescriptionTrigger when
cpn.transaction.broadcastedThe signed transaction is sent to the blockchain for confirmationThe signed transaction has been broadcast
cpn.transaction.completedThe transaction was successfully included in a blockThe blockchain confirms the transaction
cpn.transaction.failedThe transaction failed due to issues such as incorrect parameters or insufficient gas feesThe blockchain failed to confirm the transaction

​
Refund events

The notification object has the same schema as the data field returned by Get Refund.
Event nameDescriptionTrigger when
cpn.refund.createdThe BFI created a refund for the associated paymentThe BFI initiated the refund.

Note: Not all BFIs send this event.
cpn.refund.failedThe refund failedThe refund failed
cpn.refund.completedThe refund is completeThe BFI confirms that the refund was successfully returned to the refund address