Invoicing

The Invoicing API enables you to create and send invoices as well as track outstanding invoices. Your customers can pay using their preferred payment method from any device on a secure hosted website. Automated reminders are available to help you remind customers of upcoming due dates or overdue invoices.

You can also customize your invoice payment page to display your brand logo and color, as well as add custom messages to your invoice emails. Shipping information and phone numbers can also be collected at the time of payment. For more information, see Configure Invoice Settings.

The Invoicing API uses 's Digital Accept Unified to securely process payments so that you do not have to handle confidential payment data. Fraud and risk management tools are incorporated into Digital Accept Unified to prevent fraud and reduce chargebacks. For additional security, you can add payer authentication to your invoice payment processing. See Add Payer Authentication to Invoicing.

Requirements

The Invoicing API requires a transaction merchant ID (MID) account and API authentication before you can begin sending API messages to . See the REST Getting Started Guide for more information.

Webhook Notifications

To receive notifications when an invoice is paid, sent, or cancelled, you can create a subscription to receive invoicing webhook notifications. See Set Up Webhook Notifications for Invoicing.

Configure Unified Checkout

Invoicing supports Unified Checkout, which enables you to accept numerous types of digital payments, such as Apple Pay, Click to Pay, and Google Pay. For more information about enabling these digital payments using Digital Accept Unified, see the Unified Checkout guide.

Tokenization for Merchant-Initiated Transactions

You can create Token Management Service (TMS) tokens from invoice transactions using Transaction Management in the .

Personally Identifying Information Policy

Invoicing fields are strictly designated for non-personal data and must not be used to capture personally identifying information. You are prohibited from capturing, obtaining, or transmitting any personally identifying information in or through any invoicing fields, including merchant-defined data fields.

Personally identifying information includes, but is not limited to, address, payment card number, social security number, driver's license number, state-issued identification number, passport number, and card verification numbers (CVV, CVC2, CVV2, CID, CVN). In the event it is discovered that a merchant is capturing and/or transmitting personally identifying information, whether or not intentionally, the merchant's account is immediately suspended, which results in a rejection of any and all transaction requests submitted by the merchant after the point of suspension.

Custom lists, rules, and fields are not intended to and must not be used to capture personally identifying information. Accordingly, merchants are prohibited from capturing, obtaining, and/or transmitting any personally identifying information in or through custom lists, rules, or fields. Personally identifying information includes, but is not limited to, address, credit card number, social security number, driver's license number, state-issued identification number, passport number, and card verification numbers (CVV, CVC2, CVV2, CID, CVN). In the event it is discovered that a merchant is capturing and/or transmitting personally identifying information through custom lists, rules, or fields, whether or not intentionally, the merchant's account is immediately suspended, which results in a rejection of any and all transaction requests submitted by the merchant after the point of suspension.

Sandbox Testing

You can test Invoicing API requests using the Invoicing Endpoints page and the built-in API Explorer.

How Invoicing Works

When creating a new invoice, you can choose to create a draft invoice or published invoice. If you create a published invoice, you can specify whether the invoice is immediately emailed to the customer or not.

Invoicing Workflow

The Invoicing API processes all invoice creation requests through a single endpoint: POST /invoicing/v2/invoices. The invoice creation mode is controlled by combining the invoiceInformation.deliveryMode and invoiceInformation.sendImmediately field values.

This diagram shows the four invoice creation modes and the follow-on operations available after invoice creation.

Invoice Creation Requests

These modes control how an invoice is created and delivered:

Mode	Description	`deliveryMode`	`sendImmediately`	Status
Draft invoice	Create an invoice draft that is only viewable by you. To share the invoice with the customer, you must first publish it by sending a send invoice request. When published, you can send your customer the generated invoice URL. This method gives you control over the distribution of your invoices.	`none`	`false`	`DRAFT`
Deliverable draft	Create a draft invoice that is only viewable by you, and will be emailed to your customer when you publish it. To publish it, you must send a send invoice request.	`email`	`false`	`DRAFT`
Create and send	Create a published invoice that is immediately emailed to the customer by . Your customer can view and pay the invoice when they receive the invoice email.	`email`	`true`	`SENT`
Create without sending	Create a published invoice that you can share with the customer by sending the customer the generated URL. This method gives you control over the distribution of your invoices. Amount-only invoices (no line items) use the same `deliveryMode` and `sendImmediately` values as the standard creation modes above.	`none`	`true`	`CREATED`

Follow-on Operations

The Invoicing API also enables you to send these follow-on requests to manage the invoice:

Operation	Method	Endpoint
Send or resend an invoice	`POST`	`/invoicing/v2/invoices/{id}/delivery`
Get invoice details	`GET`	`/invoicing/v2/invoices/{id}`
Get all invoices	`GET`	`/invoicing/v2/invoices`
Update invoice	`PUT`	`/invoicing/v2/invoices/{id}`
Cancel invoice	`POST`	`/invoicing/v2/invoices/{id}/cancelation`

You can also customize your invoices to align with your brand. For more information about customizing your invoice settings, see Update Invoice Settings.

Ready to create your first invoice? See Create an Invoice.

Invoice Status Values

These are the possible values for the status field:

Status	Description
CANCELED	The invoice has been canceled.
CREATED	The invoice was created without being sent (create without sending mode).
DRAFT	The invoice is saved as a draft and has not been sent.
PAID	The invoice has been paid in full.
PARTIAL	The invoice has been partially paid. Set by the payment processor when the customer has paid less than the full invoice amount.
PENDING	A payment for the invoice is pending. Set by the payment processor when a payment is in process.
SENT	The invoice has been sent to the customer.

Was this page helpful?

Last published: September 29, 2026