On This Page

Create an Invoice without Sending it

Creating a new invoice publishes a payable invoice. To share the created invoice with a customer, send the customer the redirect URL generated in the

invoiceInformation.paymentLink

response field.

Itemized Invoices

An invoice can display a single billed amount or 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, Cybersource 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 Cybersource 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.

Alternative Methods to Create an Invoice

To create and send
a new invoice at the same time, see Create and Send an Invoice Immediately.

To create an invoice draft
that is not payable or viewable to the customer, see Create a Draft Invoice.

Endpoint

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

Test:

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

Production:

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

India Production:

POST https://api.in.cybersource.com/invoicing/v2/invoices

Successful Response

A successfully created invoice is indicated by the

CREATED

status in the

status

response field. The response message also includes the newly created invoice's details for the new invoice.

Follow-On API Requests

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

Send or Resend an Invoice: After creating an invoice, you can send the 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 invoice, send an update invoice request. For more information, see Update an Invoice.
Cancel an Invoice: To cancel an invoice, send a cancel invoice request. For more information, see Cancel an Invoice.
Get Invoice Details: You can retrieve an invoice's details by sending a get invoice details request. For more information, see Get Invoice Details.
Get List of Invoices: After creating multiple invoices, you might want to search for certain invoices. To retrieve a filtered list of invoices, send a get list of invoices request. For more information, see Get a List of Invoices.

Required Fields for Creating an Invoice

This section lists the required fields necessary to create these types of invoices:

In-person invoice

Email invoice

Itemized email invoice

The invoice created using these fields and specified values is not immediately sent to the customer.

Required Fields for Creating an In-Person Invoice

invoiceInformation.deliveryMode: Set to
none
.
invoiceInformation.description
invoiceInformation.dueDate
invoiceInformation.sendImmediately: Set to
true
.
orderInformation.amountDetails.currency
orderInformation.amountDetails.totalAmount

Required Fields for Creating an Email Invoice

customerInformation.email
customerInformation.name
invoiceInformation.deliveryMode: Set to
none
.
invoiceInformation.dueDate
invoiceInformation.sendImmediately: Set to
true
.
orderInformation.amountDetails.currency
orderInformation.amountDetails.totalAmount

Required Fields for Creating an Itemized Email Invoice

customerInformation.email
customerInformation.name
invoiceInformation.deliveryMode: Set to
none
.
invoiceInformation.dueDate
invoiceInformation.sendImmediately: Set to
true
.
orderInformation.amountDetails.currency
orderInformation.amountDetails.totalAmount
orderInformation.lineItems[].productName: Include for each item listed in the invoice.
orderInformation.lineItems[].productSku: Include for each item listed in the invoice.
orderInformation.lineItems[].quantity: Include for each item listed in the invoice.
orderInformation.lineItems[].totalAmount: Include for each item listed in the invoice.
orderInformation.lineItems[].unitPrice: Include for each item listed in the invoice.

Example: Creating an Invoice

Request

{
  "invoiceInformation": {
    "description": "Food",
    "dueDate": "2019-07-11",
    "sendImmediately": true,
    "deliveryMode": "none"
  },
  "orderInformation": {
    "amountDetails": {
      "totalAmount": "2623.64",
      "currency": "USD"
    }
  }
}

Response to a Successful Request

{
  "_links": {
    "self": {
      "href": "/v2/invoices/98761",
      "method": "GET"
    },
    "update": {
      "href": "/v2/invoices/98761",
      "method": "PUT"
    },
    "deliver": {
      "href": "/v2/invoices/98761/delivery",
      "method": "POST"
    },
    "cancel": {
      "href": "/v2/invoices/98761/cancelation",
      "method": "POST"
    }
  },
  "id": "98761",
  "submitTimeUtc": "2024-08-02T18:39:57.548314337Z",
  "status": "CREATED",
  "processingInformation": {
    "requestPhone": false,
    "requestShipping": false
  },
  "invoiceInformation": {
    "invoiceNumber": "98761",
    "description": "Food",
    "dueDate": "2019-07-11",
    "allowPartialPayments": false,
    "paymentLink": "https://businesscenter.cybersource.com/ebc2/invoicing/payInvoice/wzvrzUssiXFLJ2RcJcmbuQEoHSrlcQudy9dL91Jxo8n4VcoRhNWRp8wvVDz8xtlD?version=v2.1",
    "deliveryMode": "None"
  },
  "orderInformation": {
    "amountDetails": {
      "totalAmount": 2623.64,
      "currency": "USD",
      "balanceAmount": 2623.64
    }
  }
}