ZUzuper

Create Invoice Payment Intent

Changed on

Creates a Stripe PaymentIntent for an invoice (currently Stripe-only — requires an active Stripe PaymentProvider and the company's collect-payment policy enabled). This only creates the intent; it does not mark the invoice paid or record a payment — confirm completion via Update Invoice Payment after the client confirms the intent with Stripe.

post/invoices/payment_intent

Request

  • Base URL
    https://dc-region.zuperpro.com/api
  • URL
    https://dc-region.zuperpro.com/api/invoices/payment_intent
  • Auth
    API key in header x-api-key

Request body

invoice_uidstring required
amountnumber

Optional override. Must not exceed the invoice's amount due.

Response

200

typestring
publicKeystring
paymentIntentIdstring
clientSecretstring
ephemeralKeystring
customerstring

Example response

{
  "type": "success"
}

Changes