Release notes - Circle Payments Network - 2025

​

Documentation additions

• Added a topic on detailed payment failure codes to help explain why a payment failed and how to resolve the issue

​

Documentation updates

• Updated payment failure reasons with new values
• Added new magic values for testing refund workflows
• Added a new payment error code (290207) for missing required parameters
• Added new RFI error codes (290302, 290303, 290304, 290305) for RFI verification failures

​

API updates

• Added the optional quoteOptions field to the POST /v1/cpn/quotes endpoint to support additional quote options when creating a quote.
• Updated the allowed values for failureReason for payments and transactions to reflect new failure reasons.
• Added failureCode to the response of the following endpoints:
  • POST /v1/cpn/payments
  • GET /v1/cpn/payments
  • GET /v1/cpn/payments/{paymentId}

​

Documentation additions

• CPN overview
• API Integration Concepts
• Quickstart: Integrate with CPN as an OFI
• How-to: Set up a webhook endpoint
• How-to: Verify webhook signatures
• How-to: Request Payment Configurations and Routes
• How-to: Integrate with JSON Schema
• How-to: Encrypt Travel Rule and Beneficiary Data
• How-to: Create an Onchain Transaction
• How-to: Encrypt Files for RFI Transmission
• How-to: Create a Support Ticket
• Supported blockchains
• Wallet provider compatibility
• Component states and workflows
• Magic values for testing
• Webhook events
• Webhook retries
• Payment and transaction failure reasons
• Error codes
• JSON Schema
• RFI levels
• Travel rule requirements
• Payment reference
• Validating Brazilian tax ID and bank account numbers

​

API additions

• GET /v1/cpn/configurations/overview
• GET /v1/cpn/configurations/routes
• POST /v1/cpn/quotes
• GET /v1/cpn/quotes/{quoteId}
• GET /v1/cpn/payments
• POST /v1/cpn/payments
• GET /v1/cpn/payments/{paymendId}
• GET /v1/cpn/payments/{paymentId}/refunds/{refundId}
• GET /v1/cpn/payments/requirements
• POST /v1/cpn/payments/{paymentId}/transactions
• GET /v1/cpn/payments/{paymentId}/transactions/{transactionId}
• POST /v1/cpn/payments/{paymentId}/transactions/{transactionId}/submit
• POST /v1/cpn/payments/{paymentId}/transactions/accelerate
• GET /v1/cpn/payments/{paymentId}/rfis/{rfiId}
• POST /v1/cpn/payments/{paymentId}/rfis/{rfiId}/submit
• POST /v1/cpn/payments/{paymentId}/rfis/{rfiId}/files
• POST /v1/cpn/supportTickets