Payment Records

A Payment Record is a resource that allows you to represent payments that occur on- or off-Stripe. For example, you can create a Payment Record to model a payment made on a different payment processor, in order to mark an Invoice as paid and a Subscription as active. Payment Records consist of one or more Payment Attempt Records, which represent individual attempts made on a payment network.

Was this section helpful? Yes No

Retrieve a Payment Record

GET / v1 / payment_records /:id

Report a payment

POST / v1 / payment_records / report_payment

Report a payment attempt

POST / v1 / payment_records /:id / report_payment_attempt

Report a refund

POST / v1 / payment_records /:id / report_refund

Report payment attempt canceled

POST / v1 / payment_records /:id / report_payment_attempt_canceled

Report payment attempt failed

POST / v1 / payment_records /:id / report_payment_attempt_failed

Report payment attempt guaranteed

POST / v1 / payment_records /:id / report_payment_attempt_guaranteed

Report payment attempt informational

POST / v1 / payment_records /:id / report_payment_attempt_informational

The Payment Record object

Attributes

• id string Unique identifier for the object.
• amount object The amount you intend to collect for this payment.
• amount _ authorized object The portion of the requested amount that has been authorized to be guaranteed by the payment provider.
• amount _ canceled object The portion of the requested amount that has been canceled by the user, or that you no longer intend to collect.
• amount _ failed object The portion of the requested amount that failed to be collected.
• amount _ guaranteed object The portion of the requested amount that has been guaranteed by the payment provider.
• amount _ refunded object The amount that has been refunded to the customer on this payment.
• amount _ requested object The amount you initially requested for this payment.
• customer _ details nullable object Customer information for this payment.
• customer _ presence nullable enum 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 nullable string An arbitrary string attached to the object. Often useful for displaying to users.
• metadata map Set of key-value pairs 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 nullable object Information about the Payment Method debited for this payment.
• processor _ details object Processor information for this payment.
• shipping _ details nullable object Shipping information for this payment.

More attributes

• object string, value is "payment_record"
• application nullable string
• created timestamp
• latest _ payment _ attempt _ record nullable string
• livemode boolean
• reported _ by enum

The Payment Record object

{ "id": "pr_5RV730PrHyAEi", "object": "payment_record", "amount_authorized": { "currency": "usd", "value": 1000 }, "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, "metadata": {}, "payment_method_details": { "billing_details": null, "custom": { "display_name": "newpay", "type": "custom" }, "payment_method": null, "type": "custom" }, "processor_details": { "type": "custom", "custom": { "payment_reference": "npp2358872734k" } }, "shipping_details": null}

Retrieve a Payment Record

GET / v1 / payment_records /:id

Retrieves a Payment Record with the given ID

Parameters

• id string Required The ID of the Payment Record.

Returns

Returns a Payment Record object if a valid ID was provided. Otherwise, this call raises an error.

Response

{ "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, "metadata": {}, "payment_method_details": { "billing_details": null, "custom": { "display_name": "newpay", "type": "custom" }, "payment_method": null, "type": "custom" }, "processor_details": { "type": "custom", "custom": { "payment_reference": "npp2358872734k" } }, "shipping_details": null}