v52

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-015891,4406.1 MB

Report a payment attempt

Report a new payment attempt on the specified Payment Record. A new payment attempt can only be specified if all other payment attempts are canceled or failed.

post/v1/payment_records/{id}/report_payment_attempt

Path parameters

idstring required

The ID of the Payment Record.

Response

Successful response.

applicationstring nullable

ID of the Connect application that created the PaymentRecord.

createdinteger required

Time at which the object was created. Measured in seconds since the Unix epoch.

customer_presence'off_session' | 'on_session' nullable

Indicates whether the customer was present in your checkout flow during this payment.

descriptionstring nullable

An arbitrary string attached to the object. Often useful for displaying to users.

idstring required

Unique identifier for the object.

latest_payment_attempt_recordstring nullable

ID of the latest Payment Attempt Record attached to this Payment Record.

livemodeboolean required

If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.

metadataobject required

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.

object'payment_record' required

String representing the object's type. Objects of the same type share the same value.

reported_by'self' | 'stripe' required

Indicates who reported the payment.