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

Retrieve a Payment Record

Retrieves a Payment Record by its identifier. Use id to select the record and expand to request additional fields in the response. The response contains the record's payment amounts, processing details, reporting information, and lifecycle metadata.

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

2 parameters
idstringrequired
The identifier of the Payment Record to retrieve, with a maximum length of 5,000 characters.
expandarray<string>optional
Names of fields to expand in the Payment Record response. Each value can contain up to 5,000 characters.

2 status codes
200Returns the requested Payment Record, including its identifiers, payment amounts, creation time, customer details, processor details, and reporting status.
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 PaymentRecord.
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.
latest_payment_attempt_recordstringoptional
ID of the latest Payment Attempt Record attached to this Payment Record.
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_record
payment_method_detailsobjectoptional
Information about the Payment Method debited for this payment.
processor_detailsobjectrequired
Processor information associated with this payment.
reported_bystringrequired
Indicates who reported the payment.
Allowed:selfstripe
shipping_detailsobjectoptional
Shipping information for this payment.
defaultError response.
errorobjectrequired

Error handling

id must identify the Payment Record to retrieve and can contain up to 5,000 characters. Each value in expand must be a string no longer than 5,000 characters.