NORCE CHECKOUT
/
CORE
/
Order
/
Checkout Payment
/
Execute a Payment PaymentAction

Norce Checkout - Order Management API (0.1)

Build 2026-01-12 08:21:29

The Order Management API is used to create and handle orders

Download OpenAPI description
order.json
order.yaml
Languages
Servers
Playground

https://{slug}.api-se.playground.norce.tech/checkout/order/

Stage

https://{slug}.api-se.stage.norce.tech/checkout/order/

Production

https://{slug}.api-se.norce.tech/checkout/order/

Schemas

Checkout

Operations

Checkout Payment

Operations

Create Order Payment

Request

Creates a order payment

Path
order_idstringrequired

Order identifier

Headers
x-merchantstringnon-emptyrequired

Merchant identifier.

Example: norce
x-channelstringnon-emptyrequired

Channel identifier

Example: 1
x-adapteridstring

Optional adapter identifier. When provided, hooks belonging to this adapter will not be triggered for changes made by the adapter itself.

Example: qliro_checkout_adapter
Bodyapplication/json

Payment

adapterIdstring

Adapter ID

Example: "klarna-checkout"
namestring

Payment service provider name

merchantstring

Merchant identifier.

Example: "norce"
channelstring

Merchant channel.

currencystring^[A-Za-z]{3,3}$

Currency of the purchase. ISO 4217 alpha-3.

Example: "SEK"
typestring

Type of payment.

Enum"default""prepaid""voucher"
Example: "default"
orderIdstring

ID of the order.

Example: "o_DhZSbDfVzNzuxOzHyCFskzGzaJ"
amountnumber(double)

The amount to be covered by the payment. Amount in major unit currency.

Example: 10
upperLimitAmountnumber(double)

The upper limit to be used by this payment. For example the amount available on a voucher. Amount in major unit currency.

Example: 100
statestring

The state of the payment.

Enum"intent""removed""processing""failed""confirmed""pending""declined""reserved""credited""captured"
Example: "Intent"
referencestring

External reference to payment service provider.

Example: "7d31e2cf-2d46-4db0-b87d-d65dfaae298f"
attributesobject

Allows you to store any custom attributes for the payment.

actionsArray of objects(PaymentAction)

After payment actions

recurringobject

Information about a recurring payment used for processing repeated purchases.

upsellobject

Information about upsell transactions.

curl -i -X POST \
  'https://customer-slug.api-se.playground.norce.tech/checkout/order/api/v0/checkout/orders/{order_id}/payments' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -H 'x-channel: 1' \
  -H 'x-merchant: norce' \
  -d '{
    "adapterId": "klarna-checkout",
    "name": "string",
    "merchant": "norce",
    "channel": "string",
    "currency": "SEK",
    "type": "default",
    "orderId": "o_DhZSbDfVzNzuxOzHyCFskzGzaJ",
    "amount": 10,
    "upperLimitAmount": 100,
    "state": "Intent",
    "reference": "7d31e2cf-2d46-4db0-b87d-d65dfaae298f",
    "attributes": {
      "property1": null,
      "property2": null
    },
    "actions": [
      {
        "adapterId": "string",
        "type": "string",
        "url": "string"
      }
    ],
    "recurring": {
      "token": "string",
      "description": "string",
      "attributes": {
        "property1": null,
        "property2": null
      }
    },
    "upsell": {
      "eligible": true,
      "expiration": "2019-08-24T14:15:22Z",
      "transactions": [
        {
          "id": "string",
          "state": "created",
          "attributes": {
            "property1": null,
            "property2": null
          }
        }
      ],
      "attributes": {
        "property1": null,
        "property2": null
      }
    }
  }'

Responses

Created

Bodyapplication/json
idstring
Response
application/json
{
  "id": "string"
}

Get Order Payments

Request

Get order payments

Path
order_idstringrequired

Order identifier

Headers
x-merchantstringnon-emptyrequired

Merchant identifier.

Example: norce
x-channelstringnon-emptyrequired

Channel identifier

Example: 1
x-adapteridstring

Optional adapter identifier. When provided, hooks belonging to this adapter will not be triggered for changes made by the adapter itself.

Example: qliro_checkout_adapter
curl -i -X GET \
  'https://customer-slug.api-se.playground.norce.tech/checkout/order/api/v0/checkout/orders/{order_id}/payments' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'x-channel: 1' \
  -H 'x-merchant: norce'

Responses

OK

Bodyapplication/jsonArray [
idstringread-only

Unique ID of the payment.

Example: "p_KBiXuYjvYxsezKCQAMuuSKGDaT"
adapterIdstring

Adapter ID

Example: "klarna-checkout"
namestring

Payment service provider name

merchantstring

Merchant identifier.

Example: "norce"
channelstring

Merchant channel.

currencystring^[A-Za-z]{3,3}$

Currency of the purchase. ISO 4217 alpha-3.

Example: "SEK"
typestring

Type of payment.

Enum"default""prepaid""voucher"
Example: "default"
orderIdstring

ID of the order.

Example: "o_DhZSbDfVzNzuxOzHyCFskzGzaJ"
amountnumber(double)

The amount to be covered by the payment. Amount in major unit currency.

Example: 10
upperLimitAmountnumber(double)

The upper limit to be used by this payment. For example the amount available on a voucher. Amount in major unit currency.

Example: 100
statestring

The state of the payment.

Enum"intent""removed""processing""failed""confirmed""pending""declined""reserved""credited""captured"
Example: "Intent"
referencestring

External reference to payment service provider.

Example: "7d31e2cf-2d46-4db0-b87d-d65dfaae298f"
attributesobject

Allows you to store any custom attributes for the payment.

actionsArray of objects(PaymentAction)

After payment actions

recurringobject

Information about a recurring payment used for processing repeated purchases.

upsellobject

Information about upsell transactions.

]
Response
application/json
[
  {
    "id": "p_KBiXuYjvYxsezKCQAMuuSKGDaT",
    "adapterId": "klarna-checkout",
    "name": "string",
    "merchant": "norce",
    "channel": "string",
    "currency": "SEK",
    "type": "default",
    "orderId": "o_DhZSbDfVzNzuxOzHyCFskzGzaJ",
    "amount": 10,
    "upperLimitAmount": 100,
    "state": "Intent",
    "reference": "7d31e2cf-2d46-4db0-b87d-d65dfaae298f",
    "attributes": { … },
    "actions": [ … ],
    "recurring": { … },
    "upsell": { … }
  }
]

Get Order Payment

Request

Get order payment

Path
order_idstringrequired

Order identifier

payment_idstringrequired

Payment identifier

Headers
x-merchantstringnon-emptyrequired

Merchant identifier.

Example: norce
x-channelstringnon-emptyrequired

Channel identifier

Example: 1
x-adapteridstring

Optional adapter identifier. When provided, hooks belonging to this adapter will not be triggered for changes made by the adapter itself.

Example: qliro_checkout_adapter
curl -i -X GET \
  'https://customer-slug.api-se.playground.norce.tech/checkout/order/api/v0/checkout/orders/{order_id}/payments/{payment_id}' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'x-channel: 1' \
  -H 'x-merchant: norce'

Responses

OK

Bodyapplication/json
idstringread-only

Unique ID of the payment.

Example: "p_KBiXuYjvYxsezKCQAMuuSKGDaT"
adapterIdstring

Adapter ID

Example: "klarna-checkout"
namestring

Payment service provider name

merchantstring

Merchant identifier.

Example: "norce"
channelstring

Merchant channel.

currencystring^[A-Za-z]{3,3}$

Currency of the purchase. ISO 4217 alpha-3.

Example: "SEK"
typestring

Type of payment.

Enum"default""prepaid""voucher"
Example: "default"
orderIdstring

ID of the order.

Example: "o_DhZSbDfVzNzuxOzHyCFskzGzaJ"
amountnumber(double)

The amount to be covered by the payment. Amount in major unit currency.

Example: 10
upperLimitAmountnumber(double)

The upper limit to be used by this payment. For example the amount available on a voucher. Amount in major unit currency.

Example: 100
statestring

The state of the payment.

Enum"intent""removed""processing""failed""confirmed""pending""declined""reserved""credited""captured"
Example: "Intent"
referencestring

External reference to payment service provider.

Example: "7d31e2cf-2d46-4db0-b87d-d65dfaae298f"
attributesobject

Allows you to store any custom attributes for the payment.

actionsArray of objects(PaymentAction)

After payment actions

recurringobject

Information about a recurring payment used for processing repeated purchases.

upsellobject

Information about upsell transactions.

Response
application/json
{
  "id": "p_KBiXuYjvYxsezKCQAMuuSKGDaT",
  "adapterId": "klarna-checkout",
  "name": "string",
  "merchant": "norce",
  "channel": "string",
  "currency": "SEK",
  "type": "default",
  "orderId": "o_DhZSbDfVzNzuxOzHyCFskzGzaJ",
  "amount": 10,
  "upperLimitAmount": 100,
  "state": "Intent",
  "reference": "7d31e2cf-2d46-4db0-b87d-d65dfaae298f",
  "attributes": {
    "property1": null,
    "property2": null
  },
  "actions": [
    { … }
  ],
  "recurring": {
    "token": "string",
    "description": "string",
    "attributes": { … }
  },
  "upsell": {
    "eligible": true,
    "expiration": "2019-08-24T14:15:22Z",
    "transactions": [ … ],
    "attributes": { … }
  }
}

Update Order Payment

Request

Update order payment

Path
order_idstringrequired

Order identifier

payment_idstringrequired

Payment identifier

Headers
x-merchantstringnon-emptyrequired

Merchant identifier.

Example: norce
x-channelstringnon-emptyrequired

Channel identifier

Example: 1
x-adapteridstring

Optional adapter identifier. When provided, hooks belonging to this adapter will not be triggered for changes made by the adapter itself.

Example: qliro_checkout_adapter
Bodyapplication/json
adapterIdstring

Adapter ID

Example: "klarna-checkout"
namestring

Payment service provider name

merchantstring

Merchant identifier.

Example: "norce"
channelstring

Merchant channel.

currencystring^[A-Za-z]{3,3}$

Currency of the purchase. ISO 4217 alpha-3.

Example: "SEK"
typestring

Type of payment.

Enum"default""prepaid""voucher"
Example: "default"
orderIdstring

ID of the order.

Example: "o_DhZSbDfVzNzuxOzHyCFskzGzaJ"
amountnumber(double)

The amount to be covered by the payment. Amount in major unit currency.

Example: 10
upperLimitAmountnumber(double)

The upper limit to be used by this payment. For example the amount available on a voucher. Amount in major unit currency.

Example: 100
statestring

The state of the payment.

Enum"intent""removed""processing""failed""confirmed""pending""declined""reserved""credited""captured"
Example: "Intent"
referencestring

External reference to payment service provider.

Example: "7d31e2cf-2d46-4db0-b87d-d65dfaae298f"
attributesobject

Allows you to store any custom attributes for the payment.

actionsArray of objects(PaymentAction)

After payment actions

recurringobject

Information about a recurring payment used for processing repeated purchases.

upsellobject

Information about upsell transactions.

curl -i -X PUT \
  'https://customer-slug.api-se.playground.norce.tech/checkout/order/api/v0/checkout/orders/{order_id}/payments/{payment_id}' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -H 'x-channel: 1' \
  -H 'x-merchant: norce' \
  -d '{
    "adapterId": "klarna-checkout",
    "name": "string",
    "merchant": "norce",
    "channel": "string",
    "currency": "SEK",
    "type": "default",
    "orderId": "o_DhZSbDfVzNzuxOzHyCFskzGzaJ",
    "amount": 10,
    "upperLimitAmount": 100,
    "state": "Intent",
    "reference": "7d31e2cf-2d46-4db0-b87d-d65dfaae298f",
    "attributes": {
      "property1": null,
      "property2": null
    },
    "actions": [
      {
        "adapterId": "string",
        "type": "string",
        "url": "string"
      }
    ],
    "recurring": {
      "token": "string",
      "description": "string",
      "attributes": {
        "property1": null,
        "property2": null
      }
    },
    "upsell": {
      "eligible": true,
      "expiration": "2019-08-24T14:15:22Z",
      "transactions": [
        {
          "id": "string",
          "state": "created",
          "attributes": {
            "property1": null,
            "property2": null
          }
        }
      ],
      "attributes": {
        "property1": null,
        "property2": null
      }
    }
  }'

Responses

OK

Bodyapplication/json
idstringread-only

Unique ID of the payment.

Example: "p_KBiXuYjvYxsezKCQAMuuSKGDaT"
adapterIdstring

Adapter ID

Example: "klarna-checkout"
namestring

Payment service provider name

merchantstring

Merchant identifier.

Example: "norce"
channelstring

Merchant channel.

currencystring^[A-Za-z]{3,3}$

Currency of the purchase. ISO 4217 alpha-3.

Example: "SEK"
typestring

Type of payment.

Enum"default""prepaid""voucher"
Example: "default"
orderIdstring

ID of the order.

Example: "o_DhZSbDfVzNzuxOzHyCFskzGzaJ"
amountnumber(double)

The amount to be covered by the payment. Amount in major unit currency.

Example: 10
upperLimitAmountnumber(double)

The upper limit to be used by this payment. For example the amount available on a voucher. Amount in major unit currency.

Example: 100
statestring

The state of the payment.

Enum"intent""removed""processing""failed""confirmed""pending""declined""reserved""credited""captured"
Example: "Intent"
referencestring

External reference to payment service provider.

Example: "7d31e2cf-2d46-4db0-b87d-d65dfaae298f"
attributesobject

Allows you to store any custom attributes for the payment.

actionsArray of objects(PaymentAction)

After payment actions

recurringobject

Information about a recurring payment used for processing repeated purchases.

upsellobject

Information about upsell transactions.

Response
application/json
{
  "id": "p_KBiXuYjvYxsezKCQAMuuSKGDaT",
  "adapterId": "klarna-checkout",
  "name": "string",
  "merchant": "norce",
  "channel": "string",
  "currency": "SEK",
  "type": "default",
  "orderId": "o_DhZSbDfVzNzuxOzHyCFskzGzaJ",
  "amount": 10,
  "upperLimitAmount": 100,
  "state": "Intent",
  "reference": "7d31e2cf-2d46-4db0-b87d-d65dfaae298f",
  "attributes": {
    "property1": null,
    "property2": null
  },
  "actions": [
    { … }
  ],
  "recurring": {
    "token": "string",
    "description": "string",
    "attributes": { … }
  },
  "upsell": {
    "eligible": true,
    "expiration": "2019-08-24T14:15:22Z",
    "transactions": [ … ],
    "attributes": { … }
  }
}

Get transactions for an order payment

Request

Get transactions for an order payment

Path
order_idstringrequired

Order identifier

payment_idstringrequired

Payment identifier

Headers
x-merchantstringnon-emptyrequired

Merchant identifier.

Example: norce
x-channelstringnon-emptyrequired

Channel identifier

Example: 1
x-adapteridstring

Optional adapter identifier. When provided, hooks belonging to this adapter will not be triggered for changes made by the adapter itself.

Example: qliro_checkout_adapter
curl -i -X GET \
  'https://customer-slug.api-se.playground.norce.tech/checkout/order/api/v0/checkout/orders/{order_id}/payments/{payment_id}/transactions' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'x-channel: 1' \
  -H 'x-merchant: norce'

Responses

OK

Bodyapplication/jsonArray [
eventstring

Event that triggered the transaction.

Enum"open""process""confirm""reopen""cancel""paymentAction""capture""refund"
pspEventstring

Payment service provider event.

amountnumber(double)

Amount after transaction. Amount in major unit currency.

isSuccessboolean

Indicated whether the transaction was successful.

errorDetailstring

Message detailing the error.

pspStatusstring

Payment service provider status.

requestJsonstring

Transaction request. Must be a valid json.

responseJsonstring

Transaction response. Must be a valid json.

createdstring(date-time)read-only

DateTime when transaction was posted.

paymentActionobject

Payment Action

]
Response
application/json
[
  {
    "event": "open",
    "pspEvent": "string",
    "amount": 0.1,
    "isSuccess": true,
    "errorDetail": "string",
    "pspStatus": "string",
    "requestJson": "string",
    "responseJson": "string",
    "created": "2019-08-24T14:15:22Z",
    "paymentAction": { … }
  }
]

Add transaction for an order payment

Request

Add transaction for an order payment

Path
order_idstringrequired

Order identifier

payment_idstringrequired

Payment identifier

Headers
x-merchantstringnon-emptyrequired

Merchant identifier.

Example: norce
x-channelstringnon-emptyrequired

Channel identifier

Example: 1
x-adapteridstring

Optional adapter identifier. When provided, hooks belonging to this adapter will not be triggered for changes made by the adapter itself.

Example: qliro_checkout_adapter
Bodyapplication/json
eventstring

Event that triggered the transaction.

Enum"open""process""confirm""reopen""cancel""paymentAction""capture""refund"
pspEventstring

Payment service provider event.

amountnumber(double)

Amount after transaction. Amount in major unit currency.

isSuccessboolean

Indicated whether the transaction was successful.

errorDetailstring

Message detailing the error.

pspStatusstring

Payment service provider status.

requestJsonstring

Transaction request. Must be a valid json.

responseJsonstring

Transaction response. Must be a valid json.

paymentActionobject

Payment Action

curl -i -X POST \
  'https://customer-slug.api-se.playground.norce.tech/checkout/order/api/v0/checkout/orders/{order_id}/payments/{payment_id}/transactions' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -H 'x-channel: 1' \
  -H 'x-merchant: norce' \
  -d '{
    "event": "open",
    "pspEvent": "string",
    "amount": 0.1,
    "isSuccess": true,
    "errorDetail": "string",
    "pspStatus": "string",
    "requestJson": "string",
    "responseJson": "string",
    "paymentAction": {
      "adapterId": "string",
      "type": "string",
      "url": "string"
    }
  }'

Responses

OK

Bodyapplication/json
eventstring

Event that triggered the transaction.

Enum"open""process""confirm""reopen""cancel""paymentAction""capture""refund"
pspEventstring

Payment service provider event.

amountnumber(double)

Amount after transaction. Amount in major unit currency.

isSuccessboolean

Indicated whether the transaction was successful.

errorDetailstring

Message detailing the error.

pspStatusstring

Payment service provider status.

requestJsonstring

Transaction request. Must be a valid json.

responseJsonstring

Transaction response. Must be a valid json.

createdstring(date-time)read-only

DateTime when transaction was posted.

paymentActionobject

Payment Action

Response
application/json
{
  "event": "open",
  "pspEvent": "string",
  "amount": 0.1,
  "isSuccess": true,
  "errorDetail": "string",
  "pspStatus": "string",
  "requestJson": "string",
  "responseJson": "string",
  "created": "2019-08-24T14:15:22Z",
  "paymentAction": {
    "id": "string",
    "adapterId": "string",
    "type": "string",
    "url": "string"
  }
}

Create a Payment PaymentAction

Request

Add paymentAction for an order payment

Path
order_idstringrequired

Order identifier

payment_idstringrequired

Payment identifier

Headers
x-merchantstringnon-emptyrequired

Merchant identifier.

Example: norce
x-channelstringnon-emptyrequired

Channel identifier

Example: 1
x-adapteridstring

Optional adapter identifier. When provided, hooks belonging to this adapter will not be triggered for changes made by the adapter itself.

Example: qliro_checkout_adapter
Bodyapplication/jsonrequired

Payment Actions

Array [
adapterIdstringnon-emptyrequired
typestringnon-emptyrequired
urlstringnon-emptyrequired
]
curl -i -X POST \
  'https://customer-slug.api-se.playground.norce.tech/checkout/order/api/v0/checkout/orders/{order_id}/payments/{payment_id}/actions' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -H 'x-channel: 1' \
  -H 'x-merchant: norce' \
  -d '[
    {
      "adapterId": "string",
      "type": "string",
      "url": "string"
    }
  ]'

Responses

OK

Response
No content

Execute a Payment PaymentAction

Request

Execute a paymentAction for an order payment

Path
order_idstringrequired

Order identifier

payment_idstringrequired

Payment identifier

action_idstringrequired

PaymentAction identifier

Headers
x-merchantstringnon-emptyrequired

Merchant identifier.

Example: norce
x-channelstringnon-emptyrequired

Channel identifier

Example: 1
x-adapteridstring

Optional adapter identifier. When provided, hooks belonging to this adapter will not be triggered for changes made by the adapter itself.

Example: qliro_checkout_adapter
curl -i -X POST \
  'https://customer-slug.api-se.playground.norce.tech/checkout/order/api/v0/checkout/orders/{order_id}/payments/{payment_id}/actions/{action_id}/execute' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'x-channel: 1' \
  -H 'x-merchant: norce'

Responses

OK

Response
No content

Checkout Shipping

Operations