NOTE on Using the "MultipleSales" Category to Associate a Virtual Card Purchase to an existing sale or sales.

To specifically associate a Virtual Card to an existing sale(s), specify the "category" as "MultipleSales". In so doing you will be required to provide additional information in the request. For example, if you have two sales (order number J564 and A123) and a portion of each sale will go towards paying a supplier (i.e. Hilton) and you want to tie the order number and amount for each sale to the purchase, your request should look like (in this format):

{
    "itemGuid": "574B35F5-DFDC-4F1F-BE9A-393D6772652E",
    "value": "{\"PayeeName\": \"Hilton\",\"Total\": \"1000\",\"Note\": \"7898\",\"Orders\": [{\"OrderId\": \"J564\",\"Amount\": \"550\"},{\"OrderId\": \"A123\",\"Amount\": \"450\"}]}",
    "category": "MultipleSales",
    "idExternal": "299",
    "note": "Additional Info",
    "sequence": "TICKET1"
}

This request does the following

  • itemGUID: "574B35F5-DFDC-4F1F-BE9A-393D6772652E" is the unique GUID for the VC
  • where the total amount paid to Hilton is $1,000 ("Total": "1000)
  • on Invoice number 7898 ("Note": "7898")
  • and covers order "J564" for $550.00 ({"OrderId": "J564","Amount": "550"})
  • and order "A123" for $450 ({"OrderId": "A123","Amount": "450"}).

👍

Remember you will need to use an authentication token in the header request for every transaction.

Language
Authentication
Basic
base64
:
Click Try It! to start a request and see the response here!