PaymentIntent, Payment, and Refund. Each resource moves through a set of
states as the payin progresses.
PaymentIntent states
APaymentIntent is created when you request a deposit address. Its state shows
whether the address is ready and whether funds have settled.
Transient intents expire when the
expiresOn timestamp is reached with no
payment received. Continuous intents do not expire.
Payment states
APayment is created each time funds arrive at the deposit address. Its state
shows whether the payment settled.
Refund states
ARefund is created when funds from a Payment are returned to the sender.
Its state shows whether the refund was delivered.
Status reasons
ThestatusReason field provides additional context for certain Payment
states. Values relate to Personally Identifiable Information (PII) and Virtual
Asset Service Provider (VASP) data required for Travel Rule compliance. All
values in the following table apply to Circle Singapore (CIRCLE_SG) merchants.
States with a link in the Payment states table have a corresponding webhook
event.
failed has no webhook.