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
  - Line Items
  - 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
  - Line Items
  - 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
  - Line Items
  - 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
  - Line Items
  - 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
  - Line Items
  - 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

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

Webhooks for Invoicing
- Example: Subscribe to Invoicing Webhooks

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 with Transaction Management
- Generating a Report with Invoice Data
- Create a Custom Text Field for an Invoice

Get Invoice Details

Retrieve an invoice's details to check its current status and payment history. Retrieving an invoice's details requires the unique invoice number assigned when the invoice was created.

If you need more information about the payment history, you can also use the transaction details API. For more information, see the Transaction Details API section in the Transaction Search and Details API Developer Guide
.

Endpoints

Send your API request to one of these endpoints:

Test:

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

Production:

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

India Production:

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

The {id}
is the invoice number from the invoice creation response message.

Successful Response

A response contains this invoice information:

Response Fields to a Successful Request
Response Field	Description
submitTimeUtc	The date and time that the invoice was sent, in UTC format.
status	The invoice status. Possible values: CANCELED : The invoice is cancelled. CREATED : The invoice is created. DRAFT : The invoice is drafted and not published. PAID : The invoice is fully paid. The customer is notified that the payment is successful. PARTIAL : The invoice is partially paid. PENDING : Fraud management is reviewing the invoice and you must accept or reject the payment. The customer is also notified that the payment is processing. When you accept the payment, the invoice updates to the PAID status. If you reject the payment, the invoice updates to the SENT status. IMPORTANT This status is only retrievable for merchants with fraud management enabled. SENT : The invoice is delivered to the customer.
customerInformation (field object)	The customer's information, such as name and email.
invoiceInformation (field object)	The paymentLink field contains the direct URL to the invoice.
orderInformation (field object)	The itemized amount charged for the billed goods and services.
invoiceHistory (field object)	An array of invoice status changes and the date and time stamp of each invoice status changed.