On This Page

Create a Deliverable Draft Invoice

Drafting an invoice creates an unpublished invoice that is viewable only by you. To draft an invoice that will be delivered to the customer in an email message when you publish it, set the

invoiceInformation.deliveryMode

request field to

. When you are ready to publish and share the invoice with a customer, you can send the follow-on send invoice
request. The customer will then receive an email with the invoice and the invoice's status will update from

DRAFT

SENT

Itemized Invoices

An itemized invoice can list up to 30 billed items. To list the billed items in the invoice, include the items in the request using the line item array fields. An invoice with line items is known as an itemized
invoice. For more information about how to include line items in your request, see Including Line Items in an Invoice.

Invoice Numbers

You can assign a unique invoice number in the

invoiceInformation.invoiceNumber

request field. The invoice number is required for follow-on API requests and tracking. You should store the invoice number in your system so that you can optimally perform the follow-on requests. If you do not include a unique invoice number when creating an invoice, Visa Acceptance Solutions generates a unique invoice number for you in the

invoiceInformation.invoiceNumber

response field.

IMPORTANT

You cannot update the invoice number after it is generated.

Installment Payments

Invoices can be paid in installment payments when these fields and values are included in the request. If an invoice is payable in installments, multiple customers can make payments towards the same invoice.

invoiceInformation.allowPartialPayments: Set to
true
.
orderInformation.amountDetails.minimumPartialAmount: Set to the minimum amount allowed for a partial payment.

Partner Information

If your merchant account is associated with a Visa Acceptance Solutions partner, you can include your partner solution ID (PSID) in the request message for tracking and reporting purposes. To include your PSID, use the

clientReferenceInformation.partner.solutionId

request field and set its field value to your PSID.

Endpoint

Send an API POST request message to one of these endpoints:

Test:

POST https://apitest.visaacceptance.com/invoicing/v2/invoices

Production:

POST https://api.visaacceptance.com/invoicing/v2/invoices

Response to a Successful Request

A successfully drafted invoice is indicated by the

DRAFT

status in the

status

response field.

The redirect URL generated in the

invoiceInformation.paymentLink

response field is usable only by you and not the customer.

Additional invoice details are included in the response message for you to review.

Follow-On API Requests

After successfully drafting an invoice, you can send these follow-on API requests.

Send an Invoice: After drafting an invoice, you can publish and send an invoice using the send invoice request. For more information, see Send an Invoice.
Update an Invoice: To update customer information or item details in an already drafted invoice, send an update invoice request. For more information, see Update an Invoice.
Cancel an Invoice: To cancel a drafted invoice, send the a cancel invoice request. For more information, see Cancel an Invoice.
Get Invoice Details: To retrieve a drafted invoice's details, send a get invoice details request. For more information, see Get Invoice Details.