menu
Return to solutions

What's on this page

Boarding API / SubmitOrder

Introduction

This endpoint submits the order for further processing. You need to create an order object first with the order-configurator. Click here for more details.

Notifications

If you want to be notified of the status of an submitted order you can specifify an NotificationURL. You have to inform CCV of the URL that is used so that we can allow communication to happen.

We will inform you on this URL of a status change in our system for your order. This is accomplished by making an HTTP call to an endpoint in your system at the moment a status change occurs. We will not send any information, but instead expect you to make a status call to retrieve the status of the order.

Due to security restricitions we will only support https:// URLs. If you are technically not able to support this, please contact us.

We will call your NotificationURL once. If it fails no retry mechanism is in place. But if the order status changes again, we will again call your NotificationURL.

Request

  • Resource: /api/ordercompletion/reseller/order
  • Method: POST
  • Content-Type: application/json
  • Authentication: Required
  • Parameters
    Field Required Format Description
    notifyCustomerByEmail true boolean If set to true the end customer will receive an e-mail to complete his order at CCV
    externalReference false string External reference that is known in the external system of the integrator. Can be used to relate status updates to internal objects
    statusNotificationInformation{} false
    - notificationUrl false string an URL that is called with a HTTP POST message when an order receives a status update
    - notifyOnStatus[] false string Trigger that defines wheter to send a status update to the NotificationURL. Will only work when NotificationURL is provided. Enum New,Incomplete,Screening,ErpInProgress,Completed,Canceled,Failed,AwaitingPayment,Closed,Processing,FulfillmentInProgress,FulfillmentDone. See Order status table below for more detailed information.
    order{} true The order with a SalesPackage, with products and correct pricing. You can create this object with order-configurator

Order status

The table below gives an overview and description of the different statuses

Status Description
Processing The order is being processed internally. Once the processing is finished the order status will be updated to Incomplete
Incomplete The order is created and processed, but doesn’t contain all the required fields. Waiting for the user to complete the order. Once the order contains all required fields, the order status will change
AwaitingPayment In this state the order contains immediate payment and will remain in this state until the user has paid or when all payments have failed
Screening The order contains a product for which we need to screen the merchant (applicable for PF and/or PSP contracts) and payment is successful or the order has no required payment. The order will remain in this state until the screening has been processed. Based on the screening results, the order status continues to New or will given the Closed status.
New The order is now ready to be handled by a CCV employee for delivery to the customer (if applicable).
ErpInProgress Reserved for further use.
FulfillmentInProgress This state is being used for orders with products such as the Tap & Go. An order can only transitioned from New to fulfillmentInProgress when 1 or more products is inactive
FulfillmentDone This state is applicable when ALL the products in the order has been activated. This state can be transitioned from the state New or FulfillmentInProgress
Completed* All required actions are done for this order
Closed* The order has been closed by a CCV employee. This may happen automatically when screening is processed and rejected.
Canceled* Order has been cancelled on request of the merchant.
Failed* When an order reaches this state, action is required by a CCV employee or admin. It may be that the payment has failed or requires manual intervention. Another way this could happen is when there’s a technical problem. Somewhere in the system something failed, causing an exception and failing the order.

* Subscribe to these statuses if you are only interested in the end status of an order

Response

Code Description
200 Order created
201 Success
400 Order data has missing/invalid values
401 Unauthorized
403 Forbidden
500 Server error

Example

{
  "notifyCustomerByEmail": true,
  "externalReference": "123456",
  "statusNotificationInformation": {
    "notificationUrl": "https://api.integrator.nl/orderstatusCCV/",
    "notifyOnStatus": [
      "Completed","Closed","Canceled","Failed"
    ]
  },
  "order": {}
}