provider POST /v1/invoices/{invoice}/attach_payment
@utdk/stripe /v1/invoices/{invoice}/attach_payment
Attach a payment to an Invoice
<p>Attaches a PaymentIntent or an Out of Band Payment to the invoice, adding it to the list of <code>payments</code>.</p> <p>For the PaymentIntent, when the PaymentIntent’s status changes to <code>succeeded</code>, the payment is credited to the invoice, increasing its <code>amount_paid</code>. When the invoice is fully paid, the invoice’s status becomes <code>paid</code>.</p> <p>If the PaymentIntent’s status is already <code>succeeded</code> when it’s attached, it’s credited to the invoice immediately.</p> <p>See: <a href="/docs/invoicing/partial-payments">Partial payments</a> to learn more.</p>
invoice path required
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.

postinvoicesinvoiceattachpayment
POST/v1/invoices/{invoice}/attach_payment
<p>Attaches a PaymentIntent or an Out of Band Payment to the invoice, adding it to the list of <code>payments</code>.</p> <p>For the PaymentIntent, when the PaymentIntent’s status changes to <code>succeeded</code>, the payment is credited to the invoice, increasing its <code>amount_paid</code>. When the invoice is fully paid, the invoice’s status becomes <code>paid</code>.</p> <p>If the PaymentIntent’s status is already <code>succeeded</code> when it’s attached, it’s credited to the invoice immediately.</p> <p>See: <a href="/docs/invoicing/partial-payments">Partial payments</a> to learn more.</p>

Parameters

required

Input

Specifies which fields in the response should be expanded.

The ID of the PaymentIntent to attach to the invoice.

The ID of the PaymentRecord to attach to the invoice.

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.postinvoicesinvoiceattachpayment()