Skip to main content
This page contains information about the states that high-level components of the CPN system can be in. Your integration should be able to handle and respond to each of the various states that a given component may present. In some cases, the state of a component requires immediate or rapid action from an OFI. Reference these states as a way to confirm your integration is comprehensive.

Payments

A payment represents the end-to-end CPN payment flow, including the onchain transaction and RFI check. It is initiated by locking in a quote and providing the required recipient details. Payments have the following workflow:

Payment States

A payment can also include an optional statusAddendum field that provides additional context about the current payment status. This field does not represent a separate state — it supplements the main status field. CPN omits statusAddendum from the response when no additional context applies. When a payment is initiated, the BFI performs an initial payment review, which affects the state that the payment is created in:
  • If the BFI approves the initial payment review outright, the payment is created in the CRYPTO_FUNDS_PENDING state.
  • If the BFI rejects the initial payment review outright, the payment is created in the FAILED state.
  • If the BFI needs to take additional steps to review the payment, the payment is created in the CREATED state. Final approval or rejection of the payment is sent asynchronously.

RFIs

Requests for information (RFI) is a process that is initiated by the BFI when more detailed information about the sender is required to meet regulatory or risk compliance checks. RFIs have the following workflow:

RFI states

Refunds

Refunds occur when the BFI can’t complete the transfer of fiat to the receiver. The BFI creates an onchain transaction to transfer the cryptocurrency back to the OFI. Refunds have the following workflow:

Refund states

Transactions

A transaction on CPN is a data object that represents a funds transfer transaction on the blockchain. When the payment is in the CRYPTO_FUNDS_PENDING state, the OFI should initiate the onchain transaction with CPN as soon as possible. Transactions have the following workflow:

Transaction states

Support tickets

The CPN support tickets API allows you to raise and manage transaction-related issues such as settlement delays, missing information, or refunds. These tickets are stored in the CPN platform and routed to the appropriate party for resolution.