# The Payment Record object

### The Payment Record object

```json
{
  "id": "pr_5RV730PrHyAEi",
  "object": "payment_record",
  "amount_canceled": {
    "currency": "usd",
    "value": 0
  },
  "amount_failed": {
    "currency": "usd",
    "value": 0
  },
  "amount_guaranteed": {
    "currency": "usd",
    "value": 0
  },
  "amount_refunded": {
    "currency": "usd",
    "value": 0
  },
  "amount_requested": {
    "currency": "usd",
    "value": 1000
  },
  "created": 1730211363,
  "customer_details": null,
  "customer_presence": "on_session",
  "description": "computer software",
  "latest_payment_attempt_record": "par_1ArV730PrHyQuG",
  "livemode": true,
  "payment_method_details": {
    "billing_details": null,
    "custom": {
      "display_name": "newpay",
      "type": "custom"
    },
    "payment_method": null,
    "type": "custom"
  },
  "payment_reference": "npp2358872734k",
  "shipping_details": null
}
```

## Attributes

- `id` (string)
  Unique identifier for the object.

- `object` (string)
  String representing the object’s type. Objects of the same type share the same value.

- [`amount_canceled`](https://docs.stripe.com/api/payment-record/object.md?query=amount_canceled&api-version=2025-05-28.basil) (object)
  The portion of the requested amount that has been canceled by the user, or that you no longer intend to collect.

- [`amount_failed`](https://docs.stripe.com/api/payment-record/object.md?query=amount_failed&api-version=2025-05-28.basil) (object)
  The portion of the requested amount that failed to be collected.

- [`amount_guaranteed`](https://docs.stripe.com/api/payment-record/object.md?query=amount_guaranteed&api-version=2025-05-28.basil) (object)
  The portion of the requested amount that has been guaranteed by the payment provider.

- [`amount_requested`](https://docs.stripe.com/api/payment-record/object.md?query=amount_requested&api-version=2025-05-28.basil) (object)
  The amount you initially requested for this payment.

- `created` (timestamp)
  Time at which the object was created. Measured in seconds since the Unix epoch.

- [`customer_details`](https://docs.stripe.com/api/payment-record/object.md?query=customer_details&api-version=2025-05-28.basil) (object, nullable)
  Customer information for this payment.

- `customer_presence` (enum, nullable)
  Indicates whether the customer was present in your checkout flow during this payment.
Possible enum values:
  - `off_session`
    The customer was not present during the transaction.

  - `on_session`
    The customer was present during the transaction.

- `description` (string, nullable)
  An arbitrary string attached to the object. Often useful for displaying to users.

- `latest_payment_attempt_record` (string, nullable)
  ID of the latest Payment Attempt Record attached to this Payment Record.

- `livemode` (boolean)
  Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.

- `metadata` (object)
  Set of [key-value pairs](https://docs.stripe.com/docs/api/metadata.md?api-version=2025-05-28.basil) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

- [`payment_method_details`](https://docs.stripe.com/api/payment-record/object.md?query=payment_method_details&api-version=2025-05-28.basil) (object, nullable)
  Information about the Payment Method debited for this payment.

- `payment_reference` (string, nullable)
  An opaque string for manual reconciliation of this payment, for example a check number or a payment processor ID.

- [`shipping_details`](https://docs.stripe.com/api/payment-record/object.md?query=shipping_details&api-version=2025-05-28.basil) (object, nullable)
  Shipping information for this payment.