Boarding API / order_configurator / StartOrder

Introduction

This endpoint creates a new order template with the provided data.

Request

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

  Field	Required	Format	Description
  orderDate	true	string($date-time)	The date-time you submitted the request, e.g 2017-07-21T17:32:28Z
  termsAndConditions{}	false		A list of terms and conditions that have been accepted for this order
  - type	false	string	Enum: GeneralTermsAndConditions, SupplementaryTermsAndConditions, Other, GeneralSupplyTerms
  - url	false	string	URL to the Terms and Conditions with the rootURL, e.g. /documents/termsAndConditions/general/file.pdf
  - name	false	string	Identifier for the terms and conditions that the merchant has signed for this order. This is for auditing purposes so we know in the future which version of the terms and conditions the merchant has agreed to for this order. (e.g. GeneralTermsAndConditions_version55B)
  orderNotes	false	string	Additional orders notes for this order. These notes are only visible for a CCV employee
  cartURL	true	string	Url the customer navigates to when using the browser back button in the checkout
  storeURL	true	string	Url the customer navigates to when pressing the header logo in the checkout
  statusURL	true	string
  storeInformation{}	true
  - companyName	false	string	The official registered company name
  - tradeName	false	string	The trade name/business name of the store (commercial name)
  - cocNumber	true	string	The official registered commercial Chamber of Commerce number
  - cocRegistry	true	string	The registry autority where the store is registered. Enum Kvk, Kbo, Rcs. Is mandatory when a cocNumber is provided
  - storeAddress{}	false		The address where the CCV product will be used. In case of a non-physical product use the address on which the contract needs to be registered. See store and delivery address
  - deliveryAddress{}	false		The address where the CCV product needs to be delivered. See store and delivery address
  - eBillingEmailAddress	false	string	Email address used for EBilling purpose
  - reportingEmailAddress	false	string	Email address used for PF reporting purpose
  companyContactPerson{}	true		The contact person. For this person we will create a MyCCV account
  - firstName	false	string	First Name
  - lastName	false	string	Last Name
  - prefix	false	string	First Prefix of the contact person. E.g. van in Jan van Beethoven. If it is not common in your country to store this in an additional field add this prefix in the lastName field
  - emailAddress	treue	string	Email address of the contact person. This emailAddress will be the username for the MyCCV account.
  - gender	false	string	enum Male or Female
  - phoneNumber	false	string	phone number
  - dateOfBirth	false	string($date-time)	Date of birth, e.g 1980-07-21T17:32:28Z
  - language	true	string	Language of the contact person. This will be the MyCCV language for this user. In BCP 47 code, e.g. nl-NL. Support values are nl-BE , fr-BE, de-DE, nl-NL
  invoiceAccount{}	false		the invoice account bank number. See invoice and payout bank account
  payoutAccount{}	false		the payout account bank number. See invoice and payout bank account
  shoppingcart{}	false
  cddInformation{}	false		CDD (customer due diligence) aka KYC (know your customer) data
  - tradingActivities	false	string	For which trading activities is the company going to use the CCV product(s)
  - ultimateBeneficialOwners{}	false	string	Provide the UBO’s of the company, See ubo's and signers
  - authorizedSignatories{}	false	string	Provide the authorized signers of the company. See ubo's and signers
  - expectedMaxTransactionAmount	false	integer($int32)	Provide the maximum transaction amount for electronic payments
  - expectedAverageTransactionAmount	false	integer($int32)	Provide the average transaction amount for electronic payments
  - expectedYearlyTurnover	false	integer($int32)	Provide the yearly turnover for electronic payments
  - hasPoliticalRelations	false	boolean	Provide if one of the UBO’s or autorized signers have a PEP relation
  - hasRelationsWithSanctionedCountries	false	boolean	Provide if company is located or has trade activities with countries outside the EU/EER
  - hasServiceBeenDeniedBefore	false	boolean	Provide if company has been denied for similar services in the past

Store and delivery address

Invoice and payout bank account

Ubo’s and signers

Response

Examples

Fully filled request

{
  "orderDate": "2021-02-23T14:34:37.528+00:00",
  "termsAndConditions": [
    {
      "type": "GeneralTermsAndConditions",
      "url": "https://www.terms.url",
      "name": "Term"
    }
  ],
  "orderNotes": "This is a note for Joe at CCV",
  "cartUrl": "http://myccv-local:8008/merchant/",
  "storeUrl": "http://myccv-local:8008/merchant/",
  "statusUrl": "http://myccv-local:8008/merchant/",
  "storeInformation": {
    "companyName": "The Spinning Sheep",
    "tradingName": "The Spinning Sheep",
    "cocNumber": "2835608189",
    "cocRegistry": "Kvk",
    "taxNumber": "NL001234567B01",
    "storeAddress": {
      "country": "NL",
      "city": "Arnhem",
      "streetName": "Westervoortsedijk",
      "postalCode": "6872 AT",
      "houseNumber": "55",
      "houseNumberExt": "Floor3"
    },
    "deliveryAddress": {
      "companyName": "The Spinning Sheep",
      "country": "NL",
      "city": "Arnhem",
      "streetName": "Westervoortsedijk",
      "postalCode": "6872 AT",
      "houseNumber": "55",
      "houseNumberExt": "Floor3"
    },
    "eBillingEmailAddress": "ccvtarobot+John-Baker1@gmail.com",
    "reportingEmailAddress": "ccvtarobot+John-Baker1@gmail.com"
  },
  "companyContactPerson": {
    "firstName": "John",
    "lastName": "Baker",
    "prefix": "the",
    "emailAddress": "ccvtarobot+John-Baker1@gmail.com",
    "gender": "Male",
    "phoneNumber": "+31646889058",
    "dateOfBirth": "2021-02-23T14:34:37.528+00:00",
    "language": "nl-NL"
  },
  "invoiceAccount": {
	"iban": "NL95ABNA2486932380",
    "owner": "John the Baker",
    "bic": "ABNANL2A"
  },
  "payoutAccount": {
    "iban": "NL95ABNA2486932380",
    "owner": "John the Baker",
    "bic": "ABNANL2A"
  },
  "cddInformation": {
    "tradingActivities": "Handelen",
    "ultimateBeneficialOwners": [
      {
        "firstNames": "Mr John",
        "lastName": "the Baker",
        "dateOfBirth": "2021-02-23T14:34:37.528+00:00",
        "nationality": "nl",
        "countryOfResidence": "nl"
      }
    ],
    "authorizedSignatories": [
      {
        "firstNames": "Mr John",
        "lastName": "the Baker",
        "dateOfBirth": "2021-02-23T14:34:37.528+00:00",
        "nationality": "nl",
        "countryOfResidence": "nl"
      }
    ],
    "expectedMaxTransactionAmount": 15123,
    "expectedAverageTransactionAmount": 125,
    "expectedYearlyTurnover": 34314,
    "hasPoliticalRelations": false,
    "hasRelationsWithSanctionedCountries": true,
    "hasServiceBeenDeniedBefore": false
  }
}
}

As empty as possible request

{
  "orderDate": "2021-02-23T14:34:37.528+00:00",
  "termsAndConditions": null,
  "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",
    },
    "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,
  "cddInformation": null,
}