Report payment attempt guaranteed
POST / v1 / payment_records /:id / report_payment_attempt_guaranteed
Report that the most recent payment attempt on the specified Payment Record was guaranteed.
Parameters
- guaranteed _ at timestamp Required When the reported payment was guaranteed. Measured in seconds since the Unix epoch.
- id string Required The ID of the Payment Record.
- 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to
metadata.
Returns
The updated Payment Record object with its most recent payment attempt guaranteed, or an error (for example, if the latest Payment Attempt Record is already guaranteed).
Response
{ "id": "pr_5RV730PrHyAEi", "object": "payment_record", "amount_canceled": { "currency": "usd", "value": 0 }, "amount_failed": { "currency": "usd", "value": 0 }, "amount_guaranteed": { "currency": "usd", "value": 1000 }, "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}
Report payment attempt informational
POST / v1 / payment_records /:id / report_payment_attempt_informational
Report informational updates on the specified Payment Record.
Parameters
- id string Required The ID of the Payment Record.
- customer _ details object Customer information for this payment.
- description 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to
metadata. - shipping _ details object Shipping information for this payment.
Returns
The updated Payment Record object.
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": { "name": "Jenny Rosen", "email": "jenny.rosen@example.com", "phone": "+15551234567" }, "customer_presence": "on_session", "description": "Updated payment description with additional context", "latest_payment_attempt_record": "par_1ArV730PrHyQuG", "livemode": true, "metadata": { "order_id": "order_12345", "updated_by": "customer_service", "update_reason": "customer_inquiry" }, "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": { "name": "Jenny Rosen", "address": { "line1": "123 Main Street", "line2": "Apt 4B", "city": "San Francisco", "state": "CA", "postal_code": "94111", "country": "US" } }}