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}
List Payment Attempt Records
GET / v1 / payment_attempt_records
List all the Payment Attempt Records attached to the specified Payment Record.
Parameters
- payment _ record string Required The ID of the Payment Record.
- limit integer A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- starting _ after string A cursor for use in pagination.
starting_afteris an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending withobj_foo, your subsequent call can includestarting_after=obj_fooin order to fetch the next page of the list.
Returns
A dictionary with a data property that contains an array of Payment Attempt Records.
Response
{ "object": "list", "url": "/v1/payment_attempt_records", "has_more": false, "data": [ { "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 } ]}