The object is everything inside data. The field names below are relative to it: attributes.amount is data.attributes.amount in the response.
Fields
string
required
Card payment ID (cpy_*).
string
required
Resource type. Always cardPayment.
object
required
The card payment’s details.
Hide attributes
integer
required
Attempted amount in US cents.
string
required
Currency code. Always USD.
string
required
Payment attempt status. A succeeded payment was accepted, but funds may not be settled yet. Early access (holds): authorized, canceled. One of: processing, authorized, succeeded, failed, canceled. See Statuses.
string | null
required
Card brand, when known.
string | null
required
Last four card digits, when known.
string
required
Where the payer submitted the payment. Early access (subscriptions, mandates): api. One of: link, voice, api.
object
Early access (subscriptions). The subscription this payment pays, and which of its payments it is. Only on a subscription’s payments.
Hide subscription
string
required
Subscription ID (sub_*).
integer
required
Which payment of the subscription this is. Payment 1 is paid in checkout.
integer | null
required
How many payments the subscription has. Null when it has no end.
string | null
required
Hosted receipt page for the payer. Null until the payment succeeds.
object | null
required
Failure details. Null unless the attempt failed.
Hide failure
string | null
required
Failure code, when known. New codes may be added.
string | null
required
Explanation of the failure.
string | null
required
Recommended payer action, when known. One of: doNotRetry, tryAgainLater, confirmCardData.
object | null
required
Fee deducted from your proceeds as the recipient. Null when no fee applies, the payment failed, the fee was voided, or your party is not the fee payer.
Hide fee
integer
required
Fee amount in cents.
string
required
Currency of the fee. Always USD.
string
required
Party role charged the fee. Always recipient.
string
required
The fee is subtracted from the principal amount before the recipient receives it. Always deducted.
integer
required
Cents returned by successful refunds.
integer
required
Amount in US cents remaining after pending and successful refunds. Zero unless the payment succeeded. Other refund restrictions may apply.
string | null
required
RFC 3339 timestamp when the funds reached your wallet, or null while the payout is still settling.
string
required
RFC 3339 creation timestamp.
string
required
RFC 3339 update timestamp. Refund changes may not advance this timestamp.
object
required
Related resources, each by type and ID.
Hide relationships
object
required
The payment intent this attempt belongs to.
Hide paymentIntent
object
required
Related resource identifier.
Hide data
string
required
Resource type. Always paymentIntent.
string
required
Payment intent ID (pmi_*).
object
required
Up to 25 newest refund references, including pending and failed refunds. List refunds by cardPaymentId for the full history.
Hide refunds
object[]
required
Related resource identifiers.
Hide data
string
required
Resource type. Always refund.
string
required
Refund ID (rfd_*).
object
required
The same payment in GET /transactions. Null until the payment first changes status.
Hide transaction
object | null
required
Related resource identifier.
Hide data
string
required
Resource type. Always transaction.
string
required
Transaction ID (txn_*).
Statuses
Status
Meaning
Can become
processing
The charge, hold or capture was sent and no final answer is recorded yet.
authorized, succeeded, failed, canceled
authorized
The issuer approved a hold. The card isn’t charged until you capture its payment intent.
processing, succeeded, canceled
succeeded
The card payment was accepted. This does not mean funds have settled: settledAt says when they did.
Final
failed
The attempt ended unsuccessfully. failure contains the available code, reason, and advice.
Final
canceled
The hold was released, because you canceled its payment intent or it lapsed at its payment intent’s captureBefore. Nothing was charged.
Final
Permissions
List and get need cardPayments.read.
Failure codes
Use failure.advice to decide what to do next: doNotRetry, tryAgainLater, or confirmCardData. Do not infer advice from the code alone. failure.code is one of: genericDecline, insufficientFunds, limitExceeded, issuerUnavailable, processorError, cardExpired, incorrectCardNumber, incorrectCvc, incorrectAddress, authenticationRequired, cardNotSupported, cardInactiveOrClosed, stopPayment, cardLostStolen, suspectedFraud, duplicateTransaction. failure.reason explains each one.
Events
cardPayment.created: A card payment was submitted and is processing. The fee is assessed when the card is authorized, so it’s always null on cardPayment.created. Read it from cardPayment.succeeded. A charge or hold you create with mandateId on POST /payment-intents doesn’t send it. Its only card payment events are cardPayment.succeeded and cardPayment.failed.