Stripe: Payment attempt records schemas
1 Stripe schema with complete fields and constraints.
← Payment attempt records operations · All schemas
Retrieve a Payment Attempt Record — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A Payment Attempt Record represents an individual attempt at making a payment, on or off Stripe. Each payment attempt tries to collect a fixed amount of money from a fixed customer and payment method. Payment Attempt Records are attached to Payment Records. Only one attempt per Payment Record can have guaranteed funds. |
amount | Model | Required within parent | Expand Report a refund — response body — amount |
amount_authorized | Model | Required within parent | Expand Report a refund — response body — amount |
amount_canceled | Model | Required within parent | Expand Report a refund — response body — amount |
amount_failed | Model | Required within parent | Expand Report a refund — response body — amount |
amount_guaranteed | Model | Required within parent | Expand Report a refund — response body — amount |
amount_refunded | Model | Required within parent | Expand Report a refund — response body — amount |
amount_requested | Model | Required within parent | Expand Report a refund — response body — amount |
application | JSON | Optional | |
application (anyOf 1) | string | Alternative | ID of the Connect application that created the PaymentAttemptRecord. Maximum length: 5000 |
application (anyOf 2) | null | Alternative | |
created | JSON | Required within parent | |
created (anyOf 1) | integer | Alternative | Time at which the object was created. Measured in seconds since the Unix epoch. Format: unix-time |
created (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
customer_details | JSON | Optional | |
customer_details (anyOf 1) | JSON | Alternative | Customer information for this payment. |
customer_details (anyOf 1) (anyOf 1) | Model | Alternative | Expand Report a refund — response body — customer details Customer information for this payment Information about the customer for this payment |
customer_details (anyOf 2) | null | Alternative | |
customer_presence | JSON | Optional | |
customer_presence (anyOf 1) | string | Alternative | Indicates whether the customer was present in your checkout flow during this payment. Known values: off_session, on_session |
customer_presence (anyOf 2) | null | Alternative | |
description | JSON | Optional | |
description (anyOf 1) | string | Alternative | An arbitrary string attached to the object. Often useful for displaying to users. Maximum length: 5000 |
description (anyOf 2) | null | Alternative | |
id | string | Required within parent | Unique identifier for the object. Maximum length: 5000 |
livemode | boolean | Required within parent | If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`. |
metadata | object | Required within parent | Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Additional keys: see wildcard field |
metadata.* | string | Additional keys | Maximum length: 500 |
object | string | Required within parent | String representing the object's type. Objects of the same type share the same value. Known values: payment_attempt_record |
payment_method_details | JSON | Optional | |
payment_method_details (anyOf 1) | JSON | Alternative | Information about the Payment Method debited for this payment. |
payment_method_details (anyOf 1) (anyOf 1) | Model | Alternative | Expand Report a refund — response body — payment method details value ach credit transfer, ach debit, acss debit, affirm, afterpay clearpay, alipay, alma, amazon pay, au becs debit, bacs debit, bancontact, billie, billing details, bizum, blik, boleto, card, card present, cashapp, crypto, custom, customer balance, eps, fpx, giropay, grabpay, ideal, interac present, kakao pay, klarna, konbini, kr card, link, mb way, mobilepay, momo, multibanco, naver pay, nz bank account, oxxo, p24, pay by bank, payco, payment method, paynow, paypal, paypay, payto, pix, promptpay, revolut pay, samsung pay, satispay, scalapay, sepa debit, sequra, sofort, stripe account, sunbit, swish, twint, type, upi, us bank account, wechat, wechat pay, zip |
payment_method_details (anyOf 2) | null | Alternative | |
payment_record | JSON | Optional | |
payment_record (anyOf 1) | string | Alternative | ID of the Payment Record this Payment Attempt Record belongs to. Maximum length: 5000 |
payment_record (anyOf 2) | null | Alternative | |
processor_details | Model | Required within parent | Expand Report a refund — response body — processor details |
reported_by | string | Required within parent | Indicates who reported the payment. Known values: self, stripe |
shipping_details | JSON | Optional | |
shipping_details (anyOf 1) | JSON | Alternative | Shipping information for this payment. |
shipping_details (anyOf 1) (anyOf 1) | Model | Alternative | Expand Report a refund — response body — shipping details Shipping information for this payment address, name, phone |
shipping_details (anyOf 2) | null | Alternative |
Referenced models: Report a refund — response body — amount, Report a refund — response body — customer details Customer information for this payment Information about the customer for this payment, Report a refund — response body — payment method details value ach credit transfer, ach debit, acss debit, affirm, afterpay clearpay, alipay, alma, amazon pay, au becs debit, bacs debit, bancontact, billie, billing details, bizum, blik, boleto, card, card present, cashapp, crypto, custom, customer balance, eps, fpx, giropay, grabpay, ideal, interac present, kakao pay, klarna, konbini, kr card, link, mb way, mobilepay, momo, multibanco, naver pay, nz bank account, oxxo, p24, pay by bank, payco, payment method, paynow, paypal, paypay, payto, pix, promptpay, revolut pay, samsung pay, satispay, scalapay, sepa debit, sequra, sofort, stripe account, sunbit, swish, twint, type, upi, us bank account, wechat, wechat pay, zip, Report a refund — response body — processor details, Report a refund — response body — shipping details Shipping information for this payment address, name, phone