Payment Attempt Records

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.

Was this section helpful? Yes No

Retrieve a Payment Attempt Record

GET / v1 / payment_attempt_records /:id

List Payment Attempt Records

GET / v1 / payment_attempt_records

The Payment Attempt 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.
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_attempt_record"
application nullable string
created timestamp
customer _ presence nullable enum
livemode boolean
payment _ record nullable string
reported _ by enum

The Payment Attempt Record object

{ "id": "par_4sdDKj23235s", "object": "payment_attempt_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", "livemode": true, "metadata": {}, "payment_method_details": { "billing_details": null, "custom": { "display_name": "newpay", "type": "custom" }, "payment_method": null, "type": "custom" }, "payment_record": "pr_5RV730PrHyAEi", "processor_details": { "type": "custom", "custom": { "payment_reference": "npp2358872734k" } }, "shipping_details": null}

Retrieve a Payment Attempt Record

GET / v1 / payment_attempt_records /:id

Retrieves a Payment Attempt Record with the given ID

Parameters

id string Required The ID of the Payment Attempt Record.

Returns

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

Response

{ "id": "par_4sdDKj23235s", "object": "payment_attempt_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", "livemode": true, "metadata": {}, "payment_method_details": { "billing_details": null, "custom": { "display_name": "newpay", "type": "custom" }, "payment_method": null, "type": "custom" }, "payment_record": "pr_5RV730PrHyAEi", "processor_details": { "type": "custom", "custom": { "payment_reference": "npp2358872734k" } }, "shipping_details": null}