Fulfillment

Use this API to fulfill an order.

Complete order - client mode

Only the client needs to be logged in to use this endpoint. The user does not need to be logged in, click here to read more.

The API is used only to fulfill a previously registered order with orderId. Currently this API is possible to use on orders with mobile payment or for prepaid orders. You can only use this API to fulfill the order if paymentMethod on the order is sms, invoice, free, kco (Klarna), creditcardPayex or other (own integration with payment provider).

This API previously exposed functionality to create and link a ConnectID user to the order, and possibly send a sms/email notification. This functionality is removed from this API. To use these features, you need to use the new API named Assign user.

SecurityClient_Credentials
Request
Request Body schema: application/json
required
orderId
required
integer

Fullfill order with this id.

callbackUrl
string

Callback URL (absolute) used when payment is fulfilled. Parameter fulfillmentStatus is added to url and method GET is used. Parameter will have one of the following values:

  • success
  • failed
Responses
200

OK

Response Schema: application/json
fulfillmentStatus
string

Possible values are:

  • OK: A message is sent to user and a callback is done (if callbackUrl is given in request) when payment is done.
  • ERROR:
Enum: "OK" "ERROR"
orderId
integer

Something went wrong calling fullfilment API, e.g mobile phone number not accepted. Is null if status OK.

errorMessage
string

Descriptiv error message if error status.

400

Bad Request

429

Too Many Requests

500

Internal Server Error

post/v1/client/order/fulfillment
Request samples
application/json
{
  • "orderId": 14
}
Response samples
application/json
{
  • "fulfillmentStatus": "ERROR",
  • "orderId": 14,
  • "errorMessage": "Descriptiv error message"
}