Get your API credentials

The Invoicing API requires a transaction MID account and API authentication before you can send requests. You need your merchant ID and either an HTTP Signature key pair or a JSON Web Token (JWT) certificate. See the REST Getting Started Guide for credential setup instructions.

Create your first invoice

Send a POST request to /invoicing/v2/invoices to create an invoice. The invoiceInformation.deliveryMode and invoiceInformation.sendImmediately field values together control whether the invoice is saved as a draft, emailed to the customer immediately, or created without being sent. See Invoice Creation Requests for the full list of combinations.

To send your first request, use Create Invoice without Sending It.

Result: The response includes the invoice id (also returned as invoiceInformation.invoiceNumber) and, if the invoice was published, a paymentLink your customer can use to pay it.

Send the invoice, if needed

If you created a draft invoice (deliveryMode: none or deliveryMode: email with sendImmediately: false), the invoice is not yet visible to your customer. Publish and deliver it with a POST request to /invoicing/v2/invoices/{id}/delivery, using the invoice id from the creation response. See Send Invoice.

If you created the invoice with sendImmediately: true, or with deliveryMode: none and sendImmediately: true, skip this step — the invoice is already published.

Track the invoice status

Send a GET request to /invoicing/v2/invoices/{id} to check the invoice's current status (DRAFT, SENT, CREATED, PENDING, PARTIAL, PAID, or CANCELED) and payment history. See Retrieve Invoices.