Boarding API / order_configurator / AddTerminalPackage

Introduction

This endpoint creates a SalesPackage with a terminal package. Note if you use this endpoint you do not have to call the Add sales package endpoint first to create a Sales package. This endpoints creates one for you.

A terminal package contains the following products:

• The payment terminal
• All-in plus service contract
• Transaction processing contract
• For the CCV Mobile also a 4G SIM card + contract
• Plug and play delivery

Prices

You have to agree with CCV about the prices that you deliver in this endpoint. If you deliver the wrong prices you (as a partner) will be invoiced by CCV.

Request

• Resource: /api/ordercompletion/reseller/orderconfigurator/addTerminalPackage
• Method: PATCH
• Content-Type: application/json
• Authentication: Required
• Parameters

  Field	Required	Format	Description
  terminalPackageType	true	boolean	Enum Smart,Budget,Mobile,Compact,Mini
  transactionFee	true	number($double)	Amount of money the merchants pays for every transaction
  oneOffPriceIncludingTax	true	number($double)	The one off price including tax
  oneOffPriceExcludingTax	true	number($double)	The one off price excluding tax
  oneOffPriceTaxAmount	true	number($double)	The one off price tax amount
  oneOffPriceTaxRate	true	number($double)	The one off price tax rate percentage
  monthlyPriceIncludingTax	true	number($double)	The monthly price including tax
  monthlyPriceExcludingTax	true	number($double)	The monthly price excluding tax
  monthlyPriceTaxAmount	true	number($double)	The monthly price tax amount
  monthlyPriceTaxRate	true	number($double)	The monthly price tax rate percentage
  order{}	true		The order with a SalesPackage, created with addSalesPackage

Response

Examples

Example for a Smart terminal package

{
  "terminalPackageType": "Smart",
  "transactionFee": 0,
  "discount": 0,
  "oneOffPriceIncludingTax": 150,
  "oneOffPriceExcludingTax": 100,
  "oneOffTaxAmount": 50,
  "oneOffTaxRate": 21,
  "monthlyPriceIncludingTax": 20,
  "monthlyPriceExcludingTax": 10,
  "monthlyTaxAmount": 10,
  "monthlyTaxRate": 21,
  "order": {
     "orderDate": "2021-02-23T14:34:37.528+00:00",
     "orderNotes": null,
     "cartUrl": "http://myccv-local:8008/merchant/",
     "storeUrl": "http://myccv-local:8008/merchant/",
     "statusUrl": "http://myccv-local:8008/merchant/",
     "storeInformation": {
       "companyName": null,
       "tradingName": null,
       "cocNumber": "12345678",
       "cocRegistry": "Kvk",
       "taxNumber": null,
       "storeAddress": {
         "country": "NL",
         "city": null,
         "streetName": null,
         "postalCode": null,
         "houseNumber": null,
         "houseNumberExt": null
       },
       "deliveryAddress": null,
       "eBillingEmailAddress": null,
       "reportingEmailAddress": null
     },
     "companyContactPerson": {
       "firstName": null,
       "lastName": null,
       "prefix": null,
       "emailAddress": "ccvtarobot+John-Baker1@gmail.com",
       "gender": "Male",
       "phoneNumber": null,
       "dateOfBirth": null,
       "language": "nl-NL"
     },
     "invoiceAccount": null,
     "payoutAccount": null,
     "shoppingCart": null,
     "cddInformation": null
   }
}