AsyncAPI channel · Circle
· Circle Webhook Notifications
/circle/cpn
Subscriber endpoint that receives Circle Payments Network notifications
for an OFI. A single subscription delivers payment lifecycle, RFI,
onchain transaction and refund events. Subscribe with
`notificationTypes: ["*"]` to receive every CPN event.
Provider:CircleAsyncAPI: v2.6.0Spec: Circle Webhook NotificationsOperations: 1Messages: 16
Channel address
/circle/cpn
Operations
publish
receiveCpnNotification
Receive a CPN webhook notification
Messages
CpnPaymentCryptoFundsPending
The payment has been created and is waiting for funds to be deposited.
Content-Type: application/json
CpnPaymentFiatPaymentInitiated
The BFI has initiated the fiat payment to the receiver's bank account.
Content-Type: application/json
CpnPaymentCompleted
The payment is fully processed.
Content-Type: application/json
CpnPaymentFailed
The payment failed due to errors in processing, insufficient funds,
or compliance rejection.
Content-Type: application/json
CpnPaymentDelayed
There is a delay to the estimate of payment settlement time.
Content-Type: application/json
CpnPaymentInManualReview
A manual review has been placed on the payment.
Content-Type: application/json
CpnRfiInformationRequired
Additional compliance information is needed before the payment can
proceed.
Content-Type: application/json
CpnRfiInReview
The submitted RFI response is under review by the BFI.
Content-Type: application/json
CpnRfiApproved
The RFI has been reviewed and approved; the payment can proceed.
Content-Type: application/json
CpnRfiRejected
The RFI has been reviewed and rejected; the payment is failed.
Content-Type: application/json
CpnTransactionBroadcasted
The signed transaction is sent to the blockchain for confirmation.
Content-Type: application/json
CpnTransactionCompleted
The transaction was successfully included in a block.
Content-Type: application/json
CpnTransactionFailed
The transaction failed due to issues such as incorrect parameters or
insufficient gas fees.
Content-Type: application/json
CpnRefundCreated
The BFI created a refund for the associated payment.
Content-Type: application/json
CpnRefundFailed
The refund could not be processed.
Content-Type: application/json
CpnRefundCompleted
The refund is complete.
Content-Type: application/json
About AsyncAPI
The AsyncAPI specification describes event-driven APIs the way OpenAPI describes request/response APIs. A channel is the named pipe — a webhook URL, a Kafka topic, a WebSocket route, an MQTT subject — that producers and consumers publish or subscribe to. Each channel carries one or more messages with structured payloads, and an operation declares whether a given party sends or receives on that channel.
Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.