VCC Addendum

General Overview

The VCC Addendum feature allows you to attach additional data (via API) to a Virtual Card after the card has been created, thus providing more enhanced tracking and reporting capability.

For those of you who create virtual cards without an associated sale but later want to tie the virtual card and the sale together, take special note of the addendum category of 'MultipleSales' in the API documentation. Using this category allows you to input one or more order number(s) to which the virtual card should be associated. For example, if you create a sale with order number '1234' for $100.00 and a second sale with order number '7865' for $100 and you issue a virtual card for a supplier combined payment of $180 you can tie those two orders to that individual virtual card by calling the VCC Addendum Endpoint with the following parameters:

{
    "itemGuid": "574B35F5-DFDC-4F1F-BE9A-393D6772652E",
    "value": "{\"Orders\": [{\"OrderId\": \"1234\",\"Amount\": \"90\"},{\"OrderId\": \"7865\",\"Amount\": \"90\"}]}",
    "category": "MultipleSales",
    "idExternal": "299",
    "note": "Group payment",
    "sequence": "TICKET1"
}

In Summary, calling the Virtual Card Addendum Route:

  • Finds a specific purchase transaction and adds your custom information to that transaction
  • Stores that information for purposes of being able to report that add-on information via the Analytics tool

Technical Overview

API Endpoints for Adding addenda to a Virtual Card require that you supply a valid GUID and ExtValue where ExtValue is the custom information you wish to add to the VC record

There are additional optional values that can be added but are not required

Additional technical content such as requests and response information can be found here.


Did this page help you?