provider POST /v1/payment_records/{id}/report_payment_attempt
@utdk/stripe /v1/payment_records/{id}/report_payment_attempt
Report a payment attempt
<p>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.</p>
id path required
The ID of the Payment Record.
string

Try it

Authentication
Configure credentials for Stripe API
Gateway
The gateway proxies requests and injects credentials server-side. Configure credentials above, then enter your gateway URL.

Saved automatically to browser storage.

postpaymentrecordsidreportpaymentattempt
POST/v1/payment_records/{id}/report_payment_attempt
<p>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.</p>

Parameters

required

The ID of the Payment Record.

Input

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

Specifies which fields in the response should be expanded.

Information about the payment attempt failure.

Information about the payment attempt guarantee.

required

When the reported payment was initiated. Measured in seconds since the Unix epoch.

Set of [key-value pairs](https://docs.stripe.com/api/metadata) 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`.

The outcome of the reported payment.

Information about the Payment Method debited for this payment.

Shipping information for this payment.

Enter a gateway URL above to enable sending.

Code snippet
Updates live as you fill in the form above.

TypeScript

import stripe from '@utdk/stripe';

await stripe.postpaymentrecordsidreportpaymentattempt()