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

Example: Get Invoice Details

Endpoint with an Invoice Number

GET https://https://api.cybersource.com/invoicing/v2/invoices/2670

Request

{}

Response to a Successful Request

{
  "_links": {
    "self": {
      "href": "/v2/invoices/2670",
      "method": "GET"
    },
    "update": {
      "href": "/v2/invoices/2670",
      "method": "PUT"
    },
    "deliver": {
      "href": "/v2/invoices/2670/delivery",
      "method": "POST"
    },
    "cancel": {
      "href": "/v2/invoices/2670/cancelation",
      "method": "POST"
    }
  },
  "id": "2670",
  "submitTimeUtc": "2024-07-24T18:36:18.863175539Z",
  "status": "SENT",
  "customerInformation": {
    "name": "Tanya Lee",
    "email": "tanya.lee@my-email.world"
  },
  "processingInformation": {
    "requestPhone": false,
    "requestShipping": false
  },
  "invoiceInformation": {
    "invoiceNumber": "2670",
    "dueDate": "2019-07-11",
    "allowPartialPayments": false,
    "paymentLink": "https://businesscenter.cybersource.com/ebc2/invoicing/payInvoice/W447tdnINi5t5wu6QA0KUE2HYWY2rQQ0zXL5b5z6M50w4Ea9FFlcYrEmp09pFlzl?version=v2.1",
    "deliveryMode": "Email"
  },
  "orderInformation": {
    "amountDetails": {
      "totalAmount": 247.86,
      "currency": "USD",
      "balanceAmount": 247.86
    },
    "lineItems": [
      {
        "productSku": "P653727383",
        "productName": "First line item's name",
        "unitPrice": 12.05,
        "quantity": 20,
        "totalAmount": 247.86
      }
    ]
  },
  "invoiceHistory": [
    {
      "event": "SEND",
      "date": "2024-07-24T18:35:23.320Z"
    },
    {
      "event": "DRAFT",
      "date": "2024-07-24T18:35:22.960Z"
    }
  ]
}

Back to top