Norce Checkout - Norce Adapter API (1.0.0)

Build 2026-10-08 11:14:42

The Norce Adapter API is used to create and manage an Order based on a Norce Checkout Basket.

Download OpenAPI description

norce-adapter.json

norce-adapter.yaml

Servers

Test server

https://checkout-norce-adapter.test.norce.tech/

Schemas

Payment

idstring

adapterIdstring

namestring

merchantstring

channelstring

currencystring

typestring

Enum"default""prepaid""voucher"

orderIdstring

amountnumber(double)

upperLimitAmountnumber(double)

statestring

Enum"intent""removed""processing""failed""confirmed""pending""declined""reserved""credited""captured"

referencestring

upsellobject

attributesobject

partialsArray of objects(PaymentPartial)

{
  "id": "string",
  "adapterId": "string",
  "name": "string",
  "merchant": "string",
  "channel": "string",
  "currency": "string",
  "type": "default",
  "orderId": "string",
  "amount": 0.1,
  "upperLimitAmount": 0.1,
  "state": "intent",
  "reference": "string",
  "upsell": {
    "eligible": true,
    "expiration": "2019-08-24T14:15:22Z",
    "transactions": [ … ],
    "attributes": { … }
  },
  "attributes": {
    "property1": null,
    "property2": null
  },
  "partials": [
    { … }
  ]
}

PaymentPartial

idstringrequired

referencestringrequired

typestring

Enum"capture""refund""cancel"

linesArray of objects(PartialLine)required

lines[].quantityinteger(int32)

lines[].unitPriceobjectrequired

lines[].unitPrice.includingVatnumber(double)

lines[].unitPrice.excludingVatnumber(double)

lines[].vatRatenumber(double)

totalobjectrequired

total.includingVatnumber(double)

total.excludingVatnumber(double)

completedstring(date-time)required

{
  "id": "string",
  "reference": "string",
  "type": "capture",
  "lines": [
    { … }
  ],
  "total": {
    "includingVat": 0.1,
    "excludingVat": 0.1
  },
  "completed": "2019-08-24T14:15:22Z"
}

PaymentState

string(PaymentState)

Enum"intent""removed""processing""failed""confirmed""pending""declined""reserved""credited""captured"

"intent"

Orders

Operations

Hooks

Operations

Notifications

Operations