Getting started

Introduction

If you want to board merchants at CCV, you have to submit an order. When receiving an order we will create a MyCCV environment and register the order. In the MyCCV environment the merchant is able to communicate with CCV. We use the following structure for orders:

We have created several orderconfigurators that helps you creating the right order object. In each step you have to input the output from the previous step. It may look a bit overwhelming, but you will notice that it is not as difficult as it seems.

To get started with the boarding api, you need to contact CCV first. Only autorized resellers can use this API. Please contact us if you are interested.

Global flow

1. You start with the /api/ordercompletion/reseller/orderconfigurator/startorder. This will create a new order template
2. Add a new sales package to the newly created order template. Use /api/ordercompletion/reseller/orderconfigurator/addSalesPackage.
3. Fill this SalesPackage with products. E.g. if you resell CCV Online Payments add the product /api/ordercompletion/reseller/orderconfigurator/addProductPSPStandalone to the sales package. Note; it is thus possible to add multiple products to your SalesPackage.
4. Set the total costs for your order. Use /api/ordercompletion/reseller/orderconfigurator/setShoppingCartPricingDetails
5. Submit the order for further processing with /api/ordercompletion/reseller/order

Global flow for terminal packages

1. You start with the /api/ordercompletion/reseller/orderconfigurator/startorder. This will create a new order template
2. Add a new terminal package to the newly created order template. Use /api/ordercompletion/reseller/orderconfigurator/addTerminalPackage.
3. Set the total costs for your order. Use /api/ordercompletion/reseller/orderconfigurator/setShoppingCartPricingDetails
4. Submit the order for further processing with /api/ordercompletion/reseller/order

CCV products vs configurators

The table below gives an overview of the CCV products and their orderconfigutors. If e.g. you want to resell CCV OnlinePayments, you can use orderconfiguration/addProductPSPStandalone. If you want to resell CCV terminal packages, you can use orderconfigurator/addTerminalPackage.

The orderconfigurator/addProductPSPForSubMerchants is only applicable if you are enabled at CCV for the split payments functionality. With this orderconfigurator you can submit merchants for your own platform.