NORCE CHECKOUT

VOUCHER ADAPTERS

Norce Checkout - Awardit Adapter API (1.0.0)

Build 2026-10-05 05:49:56

The Awardit Adapter API is used to create and manage a Awardit Checkout Order.

Download OpenAPI description

awardit-adapter.json

awardit-adapter.yaml

Servers

Public

https://awardit-adapter.checkout.playground.norce.tech/checkout/awardit-adapter/

Internal Test

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

Internal Playground

https://awardit-adapter.checkout.playground.internal.norce.tech/

Internal Stage

https://awardit-adapter.checkout.stage.internal.norce.tech/

Internal Production

https://awardit-adapter.checkout.prod.internal.norce.tech/

Schemas

Payments

Operations

Gift Cards

Operations

Norce Callbacks

Operations

Norce Notifications

Operations

Commit awardit transaction on authorized gift card

Request

Notification registered on order. Triggered by order status Completed.

Path

order_idstringrequired

Order identifier

payment_idstringrequired

Payment identifier

Headers

x-merchantstringrequired

Merchant identifier.

Example: norce

x-channelstringrequired

Channel identifier

Example: 1

Bodyapplication/json

Completed order

idstring

merchantstring

channelstring

referencestring

createdstring(date-time)

lastModifiedstring(date-time)

stateobject

culturestring

currencystring

countrystring

cartobject

shippingsArray of objects(Shipping)

paymentsArray of objects(Payment)

customerobject

consentsArray of objects(Consent)

hooksArray of objects(Hook)

validationsArray of objects(Validation)

notificationsArray of objects(Notification)

totalobject

attributesobject

curl -i -X POST \
  'https://awardit-adapter.checkout.playground.norce.tech/checkout/awardit-adapter/api/checkout/v1/orders/{order_id}/payments/{payment_id}/commit' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -H 'x-channel: 1' \
  -H 'x-merchant: norce' \
  -d '{
    "id": "string",
    "merchant": "string",
    "channel": "string",
    "reference": "string",
    "created": "2019-08-24T14:15:22Z",
    "lastModified": "2019-08-24T14:15:22Z",
    "state": {
      "currentStatus": "checkout",
      "transitions": [
        {
          "status": "checkout",
          "timeStamp": "2019-08-24T14:15:22Z"
        }
      ]
    },
    "culture": "string",
    "currency": "string",
    "country": "string",
    "cart": {
      "reference": "string",
      "items": [
        {
          "id": "string",
          "reference": "string",
          "name": "string",
          "sku": "string",
          "productType": "physical",
          "url": "string",
          "imageUrl": "string",
          "quantity": 0,
          "unit": "string",
          "price": {
            "includingVat": 0.1,
            "excludingVat": 0.1
          },
          "total": {
            "includingVat": 0.1,
            "excludingVat": 0.1
          },
          "originalTotal": {
            "includingVat": 0.1,
            "excludingVat": 0.1
          },
          "vatRate": 0.1,
          "discounts": [
            {
              "type": "item",
              "name": "string",
              "code": "string",
              "value": {
                "includingVat": 0.1,
                "excludingVat": 0.1
              },
              "attributes": {
                "property1": null,
                "property2": null
              }
            }
          ],
          "attributes": {
            "property1": null,
            "property2": null
          }
        }
      ],
      "discounts": [
        {
          "type": "item",
          "name": "string",
          "code": "string",
          "value": {
            "includingVat": 0.1,
            "excludingVat": 0.1
          },
          "attributes": {
            "property1": null,
            "property2": null
          }
        }
      ],
      "total": {
        "includingVat": 0.1,
        "excludingVat": 0.1
      },
      "attributes": {
        "property1": null,
        "property2": null
      }
    },
    "shippings": [
      {
        "id": "string",
        "state": "intent",
        "reference": "string",
        "tmsReference": "string",
        "orderId": "string",
        "adapterId": "string",
        "name": "string",
        "total": {
          "includingVat": 0.1,
          "excludingVat": 0.1
        },
        "vatRate": 0.1,
        "deliveryDetails": {
          "carrier": "string",
          "class": "string",
          "product": {
            "reference": "string",
            "name": "string"
          },
          "pickupLocation": {
            "reference": "string",
            "name": "string",
            "address": {
              "streetAddress": "string",
              "city": "string",
              "postalCode": "string",
              "country": "string"
            }
          }
        },
        "addons": [
          {
            "reference": "string",
            "price": 0.1
          }
        ],
        "attributes": {
          "property1": null,
          "property2": null
        }
      }
    ],
    "payments": [
      {
        "id": "string",
        "adapterId": "string",
        "name": "string",
        "currency": "string",
        "type": "default",
        "orderId": "string",
        "amount": 0.1,
        "upperLimitAmount": 0.1,
        "state": "intent",
        "reference": "string",
        "voucher": {
          "cardId": "string"
        },
        "attributes": {
          "property1": null,
          "property2": null
        }
      }
    ],
    "customer": {
      "billing": {
        "type": "person",
        "givenName": "string",
        "familyName": "string",
        "careOf": "string",
        "reference": "string",
        "organizationName": "string",
        "streetAddress": "string",
        "streetAddress2": "string",
        "postalCode": "string",
        "city": "string",
        "region": "string",
        "country": "string",
        "phone": "string",
        "email": "string",
        "nationalIdentificationNumber": "string",
        "organizationIdentificationNumber": "string",
        "attributes": {
          "property1": null,
          "property2": null
        }
      },
      "shipping": {
        "type": "person",
        "givenName": "string",
        "familyName": "string",
        "careOf": "string",
        "reference": "string",
        "organizationName": "string",
        "streetAddress": "string",
        "streetAddress2": "string",
        "postalCode": "string",
        "city": "string",
        "region": "string",
        "country": "string",
        "phone": "string",
        "email": "string",
        "nationalIdentificationNumber": "string",
        "organizationIdentificationNumber": "string",
        "attributes": {
          "property1": null,
          "property2": null
        }
      },
      "type": "person",
      "attributes": {
        "property1": null,
        "property2": null
      }
    },
    "consents": [
      {
        "id": "string",
        "checked": true,
        "text": "string",
        "required": true
      }
    ],
    "hooks": [
      {
        "id": "string",
        "adapterId": "string",
        "reference": "string",
        "description": "string",
        "scope": "string",
        "version": "v0",
        "target": "string",
        "invoke": "string"
      }
    ],
    "validations": [
      {
        "id": "string",
        "adapterId": "string",
        "reference": "string",
        "description": "string",
        "invoke": "string"
      }
    ],
    "notifications": [
      {
        "id": "string",
        "adapterId": "string",
        "reference": "string",
        "description": "string",
        "scope": "string",
        "schema": {
          "property1": null,
          "property2": null
        },
        "invoke": "string",
        "delay": 0
      }
    ],
    "total": {
      "includingVat": 0.1,
      "excludingVat": 0.1
    },
    "attributes": {
      "property1": null,
      "property2": null
    }
  }'

Responses

Bad Request

Bodyapplication/json

codestring

Error code

Enum"internal-server-error""unauthorized""configuration-error""configuration-not-found""order-not-found""order-error""order-bad-request""order-conflict""order-validation""order-unknown-validation-error"

Example: "cart-not-found"

messagestring

Detailed error information

Example: "Cart with id:{id} now found."

awarditErrorobject

Error if originating from Resurs Bank

Response

application/json

{
  "code": "cart-not-found",
  "message": "Cart with id:{id} now found.",
  "awarditError": {
    "errorCode": "string",
    "errorMessages": [ … ],
    "correlationId": "string"
  }
}

Cancel awardit transaction on order changing back to "checkout" state with an authorized gift card

Request

Notification registered on order. Triggered by order status Checkout.

Path

order_idstringrequired

Order identifier

payment_idstringrequired

Payment identifier

Headers

x-merchantstringrequired

Merchant identifier.

Example: norce

x-channelstringrequired

Channel identifier

Example: 1

Bodyapplication/json

Order in checkout state

idstring

merchantstring

channelstring

referencestring

createdstring(date-time)

lastModifiedstring(date-time)

stateobject

culturestring

currencystring

countrystring

cartobject

shippingsArray of objects(Shipping)

paymentsArray of objects(Payment)

customerobject

consentsArray of objects(Consent)

hooksArray of objects(Hook)

validationsArray of objects(Validation)

notificationsArray of objects(Notification)

totalobject

attributesobject

curl -i -X POST \
  'https://awardit-adapter.checkout.playground.norce.tech/checkout/awardit-adapter/api/checkout/v1/orders/{order_id}/payments/{payment_id}/cancel' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -H 'x-channel: 1' \
  -H 'x-merchant: norce' \
  -d '{
    "id": "string",
    "merchant": "string",
    "channel": "string",
    "reference": "string",
    "created": "2019-08-24T14:15:22Z",
    "lastModified": "2019-08-24T14:15:22Z",
    "state": {
      "currentStatus": "checkout",
      "transitions": [
        {
          "status": "checkout",
          "timeStamp": "2019-08-24T14:15:22Z"
        }
      ]
    },
    "culture": "string",
    "currency": "string",
    "country": "string",
    "cart": {
      "reference": "string",
      "items": [
        {
          "id": "string",
          "reference": "string",
          "name": "string",
          "sku": "string",
          "productType": "physical",
          "url": "string",
          "imageUrl": "string",
          "quantity": 0,
          "unit": "string",
          "price": {
            "includingVat": 0.1,
            "excludingVat": 0.1
          },
          "total": {
            "includingVat": 0.1,
            "excludingVat": 0.1
          },
          "originalTotal": {
            "includingVat": 0.1,
            "excludingVat": 0.1
          },
          "vatRate": 0.1,
          "discounts": [
            {
              "type": "item",
              "name": "string",
              "code": "string",
              "value": {
                "includingVat": 0.1,
                "excludingVat": 0.1
              },
              "attributes": {
                "property1": null,
                "property2": null
              }
            }
          ],
          "attributes": {
            "property1": null,
            "property2": null
          }
        }
      ],
      "discounts": [
        {
          "type": "item",
          "name": "string",
          "code": "string",
          "value": {
            "includingVat": 0.1,
            "excludingVat": 0.1
          },
          "attributes": {
            "property1": null,
            "property2": null
          }
        }
      ],
      "total": {
        "includingVat": 0.1,
        "excludingVat": 0.1
      },
      "attributes": {
        "property1": null,
        "property2": null
      }
    },
    "shippings": [
      {
        "id": "string",
        "state": "intent",
        "reference": "string",
        "tmsReference": "string",
        "orderId": "string",
        "adapterId": "string",
        "name": "string",
        "total": {
          "includingVat": 0.1,
          "excludingVat": 0.1
        },
        "vatRate": 0.1,
        "deliveryDetails": {
          "carrier": "string",
          "class": "string",
          "product": {
            "reference": "string",
            "name": "string"
          },
          "pickupLocation": {
            "reference": "string",
            "name": "string",
            "address": {
              "streetAddress": "string",
              "city": "string",
              "postalCode": "string",
              "country": "string"
            }
          }
        },
        "addons": [
          {
            "reference": "string",
            "price": 0.1
          }
        ],
        "attributes": {
          "property1": null,
          "property2": null
        }
      }
    ],
    "payments": [
      {
        "id": "string",
        "adapterId": "string",
        "name": "string",
        "currency": "string",
        "type": "default",
        "orderId": "string",
        "amount": 0.1,
        "upperLimitAmount": 0.1,
        "state": "intent",
        "reference": "string",
        "voucher": {
          "cardId": "string"
        },
        "attributes": {
          "property1": null,
          "property2": null
        }
      }
    ],
    "customer": {
      "billing": {
        "type": "person",
        "givenName": "string",
        "familyName": "string",
        "careOf": "string",
        "reference": "string",
        "organizationName": "string",
        "streetAddress": "string",
        "streetAddress2": "string",
        "postalCode": "string",
        "city": "string",
        "region": "string",
        "country": "string",
        "phone": "string",
        "email": "string",
        "nationalIdentificationNumber": "string",
        "organizationIdentificationNumber": "string",
        "attributes": {
          "property1": null,
          "property2": null
        }
      },
      "shipping": {
        "type": "person",
        "givenName": "string",
        "familyName": "string",
        "careOf": "string",
        "reference": "string",
        "organizationName": "string",
        "streetAddress": "string",
        "streetAddress2": "string",
        "postalCode": "string",
        "city": "string",
        "region": "string",
        "country": "string",
        "phone": "string",
        "email": "string",
        "nationalIdentificationNumber": "string",
        "organizationIdentificationNumber": "string",
        "attributes": {
          "property1": null,
          "property2": null
        }
      },
      "type": "person",
      "attributes": {
        "property1": null,
        "property2": null
      }
    },
    "consents": [
      {
        "id": "string",
        "checked": true,
        "text": "string",
        "required": true
      }
    ],
    "hooks": [
      {
        "id": "string",
        "adapterId": "string",
        "reference": "string",
        "description": "string",
        "scope": "string",
        "version": "v0",
        "target": "string",
        "invoke": "string"
      }
    ],
    "validations": [
      {
        "id": "string",
        "adapterId": "string",
        "reference": "string",
        "description": "string",
        "invoke": "string"
      }
    ],
    "notifications": [
      {
        "id": "string",
        "adapterId": "string",
        "reference": "string",
        "description": "string",
        "scope": "string",
        "schema": {
          "property1": null,
          "property2": null
        },
        "invoke": "string",
        "delay": 0
      }
    ],
    "total": {
      "includingVat": 0.1,
      "excludingVat": 0.1
    },
    "attributes": {
      "property1": null,
      "property2": null
    }
  }'

Responses

Bad Request

Bodyapplication/json

codestring

Error code

Example: "cart-not-found"

messagestring

Detailed error information

Example: "Cart with id:{id} now found."

awarditErrorobject

Error if originating from Resurs Bank

Response

application/json

{
  "code": "cart-not-found",
  "message": "Cart with id:{id} now found.",
  "awarditError": {
    "errorCode": "string",
    "errorMessages": [ … ],
    "correlationId": "string"
  }
}

Norce Checkout - Awardit Adapter API (1.0.0)

Schemas

Payments

Gift Cards

Norce Callbacks

Norce Notifications

Commit awardit transaction on authorized gift card

Request

Responses

Did the information on the page help you?

Cancel awardit transaction on order changing back to "checkout" state with an authorized gift card

Request

Responses

Did the information on the page help you?

Norce Checkout - Awardit Adapter API (1.0.0)

Schemas

Payments

Gift Cards

Norce Callbacks

Norce Notifications

Commit awardit transaction on authorized gift card

RequestExpand all

Responses

Did the information on the page help you?

Cancel awardit transaction on order changing back to "checkout" state with an authorized gift card

RequestExpand all

Responses

Did the information on the page help you?

Request

Request