Skip to main content
Accept is in early access and subject to change. To request Accept access, contact hi@natural.com.
A card payment (cpy_*) records one attempt to pay a payment intent. List attempts with GET /card-payments. Filter by paymentIntentId to follow one intent. Read an attempt with GET /card-payments/{cardPaymentId}. These operations require card_payments.read.

​
Payment status

  • processing: the outcome is not yet confirmed.
  • succeeded: the card payment was accepted. This does not mean funds have settled.
  • failed: the attempt ended unsuccessfully. failure contains the available code, reason, and advice.
brand and last4 are nullable card display details. channel is link or voice. receiptUrl is nullable.

​
Refunds

refundedAmount totals succeeded refunds. refundableAmount accounts for pending and succeeded refunds. Failed and processing payments have no refundable amount. Other eligibility checks can still prevent a refund. relationships.refunds.data contains up to the 25 newest refund identifiers, including pending, succeeded, and failed refunds. The totals use all refunds. Use GET /refunds?cardPaymentId=cpy_... for the complete paginated history. The paymentIntent relationship identifies the original intent. Each related resource enforces its own read permission.