API Overview

Invoicing Developer Guide
- Recent Revisions to This Document
- VISA Platform Connect: Specifications and Conditions for Resellers/Partners

Introduction to Invoicing

Invoicing API Requests
- Create a Draft Invoice
  - Required Fields for Drafting an Invoice
  - Optional Fields for Invoice Creation
  - Optional Fields for Discounts and Taxes
  - Example: Drafting an Invoice
  - REST Interactive Example: Create an Invoice Draft
- Create a Deliverable Draft Invoice
  - Required Fields for Drafting an Invoice
  - Optional Fields for Invoice Creation
  - Optional Fields for Discounts and Taxes
  - Example: Drafting a Deliverable Invoice
  - REST Interactive Example: Create an Invoice Draft
- Create and Send an Invoice Immediately
  - Required Fields for Creating and Sending an Invoice
  - Optional Fields for Invoice Creation
  - Optional Fields for Discounts and Taxes
  - Example: Creating and Sending an Invoice
  - REST Interactive Example: Create and Send an Invoice
- Create an Invoice without Sending it
  - Required Fields for Creating an Invoice
  - Optional Fields for Invoice Creation
  - Optional Fields for Discounts and Taxes
  - Example: Creating an Invoice
  - REST Interactive Example: Create a New Invoice
- Get a List of Invoices
  - Generate an Endpoint with Query Parameters
  - Example: Get a List of Invoices
  - REST Interactive Example: Get a List of Invoices
- Get Invoice Details
  - Example: Get Invoice Details
  - REST Interactive Example: Get Invoice Details
- Update an Invoice
  - Required Fields for Updating an Invoice
  - Optional Fields for Updating an Invoice
  - Example: Updating an Invoice
  - REST Interactive Example: Update an Invoice
- Send an Invoice
  - Example: Send an Invoice
  - REST Interactive Example: Send an Invoice
- Cancel an Invoice
  - Example: Cancelling an Invoice
  - REST Interactive Example: Cancel an Invoice
- Including Line Items in an Invoice

Invoice Settings API Requests
- Update Invoice Settings
  - Fields for Updating Invoice Settings
  - Example: Update Invoice Settings
  - REST Interactive Example: Update Invoice Settings
- Get Invoice Settings
  - Example: Get Invoice Settings
  - REST Interactive Example: Get Invoice Settings

Add Payer Authentication to Invoicing

Add Invoicing Add-In to Outlook
- Set Up Add-In with Existing Account
- Set Up Add-In with New Account
- Create a Simple Invoice
- Create an Itemized Invoice
- Manage Invoices
- Revoke and Reconnect Outlook Permissions
- Sign Out

Webhook Notifications for Invoicing
- Example: Creating an Invoice Webhook Subscription

Manage Invoices Using the Business Center
- Enabling 3-D Secure for Invoices
- Fraud Management for Invoices
- Approving Payment Flagged for Fraud
- Rejecting Payment Flagged for Fraud
- Filtering Invoice Transactions in Transaction Management
- Generating a Report with Invoice Data
- Create a Custom Text Field for an Invoice

On This Page

Update an Invoice

You can update an invoice if no payment has been made. Include all of the fields that were contained in the original request message in the update request. If you do not include a field that was in the original request message, the field information associated with it will be removed in the updated invoice.

If you update the customer's email in the

customerInformation.email

request field, the generated redirect URL in the

invoiceInformation.paymentLink

response field changes and the previous URL becomes invalid. You can either share the new redirect URL with the customer, or resend the updated invoice using the send invoice request. For more information about how to resend an invoice, see Send an Invoice.

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.

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.

Endpoints

Send your API request message to one of these endpoints:

Test:

PUT https://apitest.cybersource.com/invoicing/v2/invoices/{id}

Production:

PUT https://api.cybersource.com/invoicing/v2/invoices/{id}

India Production:

PUT https://api.in.cybersource.com/invoicing/v2/invoices/{id}

The {id}
is the invoice number from the response to the create invoice request.

Back to top