Sample - Stripe API
GET/v1/payment_attempt_records/{id}

Retrieve a Payment Attempt Record

Retrieves a Payment Attempt Record by its identifier. Use id to select the individual payment attempt and expand to request additional fields in the returned record.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.

2 parameters
idstringrequired
The unique identifier of the Payment Attempt Record, limited to 5000 characters.
expandarray<string>optional
Fields to expand in the response; each value can contain up to 5000 characters.

2 status codes
200Returns the Payment Attempt Record, including requested, authorized, canceled, failed, guaranteed, and refunded amounts, payment context, metadata, and reporting details.
amountobjectrequired
A representation of an amount of money, consisting of an amount and a currency.
amount_authorizedobjectrequired
A representation of an amount of money, consisting of an amount and a currency.
amount_canceledobjectrequired
A representation of an amount of money, consisting of an amount and a currency.
amount_failedobjectrequired
A representation of an amount of money, consisting of an amount and a currency.
amount_guaranteedobjectrequired
A representation of an amount of money, consisting of an amount and a currency.
amount_refundedobjectrequired
A representation of an amount of money, consisting of an amount and a currency.
amount_requestedobjectrequired
A representation of an amount of money, consisting of an amount and a currency.
applicationstringoptional
ID of the Connect application that created the PaymentAttemptRecord.
createdintegerrequired
Time at which the object was created. Measured in seconds since the Unix epoch.
customer_detailsobjectoptional
Customer information for this payment.
customer_presencestringoptional
Indicates whether the customer was present in your checkout flow during this payment.
Allowed:off_sessionon_session
descriptionstringoptional
An arbitrary string attached to the object. Often useful for displaying to users.
idstringrequired
Unique identifier for the object.
livemodebooleanrequired
If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
metadataobjectrequired
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.
objectstringrequired
String representing the object's type. Objects of the same type share the same value.
Allowed:payment_attempt_record
payment_method_detailsobjectoptional
Information about the Payment Method debited for this payment.
payment_recordstringoptional
ID of the Payment Record this Payment Attempt Record belongs to.
processor_detailsobjectrequired
Processor information associated with this payment.
reported_bystringrequired
Indicates who reported the payment.
Allowed:selfstripe
shipping_detailsobjectoptional
Shipping information for this payment.
defaultReturned when the API reports an error; the response contains an `error` object with a `type` field.
errorobjectrequired

Error handling

id must be a string no longer than 5000 characters identifying the Payment Attempt Record to retrieve. Each value in expand must be a string no longer than 5000 characters.