POST /v1/invoices/{invoice}/attach_payment
Attaches a PaymentIntent or an Out of Band Payment to the invoice, adding it to the list of payments.
For the PaymentIntent, when the PaymentIntent’s status changes to succeeded, the payment is credited
to the invoice, increasing its amount_paid. When the invoice is fully paid, the
invoice’s status becomes paid.
If the PaymentIntent’s status is already succeeded when it’s attached, it’s
credited to the invoice immediately.
See: Partial payments to learn more.
Servers
- https://api.stripe.com/
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
invoice |
String | Yes |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/x-www-form-urlencoded" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
payment_intent |
String | No |
The ID of the PaymentIntent to attach to the invoice. |
expand[] |
Array | No |
Specifies which fields in the response should be expanded. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.