PartialType

PartialLine

One committed line of a payment partial. Item and Shipping variants carry disjoint reference fields, so an entry can never mix them up; serializes with a "kind" discriminator ("item" / "shipping") matching the payment adapters. Line total is always unitPrice x quantity.

quantityinteger(int32)

The committed quantity of the item or shipping.

Example: 1

unitPriceobject

Unit price snapshot.

totalobject

Line total; always unitPrice x quantity, never total / quantity.

vatRatenumber(double)

VAT rate as a fraction (e.g. 0.25 for 25%).

Example: 0.25

{
  "quantity": 1,
  "unitPrice": {
    "includingVat": 1234,
    "excludingVat": 987.2
  },
  "total": {
    "includingVat": 1234,
    "excludingVat": 987.2
  },
  "vatRate": 0.25
}

Payment

idstringread-only

Unique ID of the payment.

Example: "p_KBiXuYjvYxsezKCQAMuuSKGDaT"

adapterIdstring

Adapter ID

Example: "klarna-checkout"

namestring

Payment service provider name

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.

voucherobject

Additional information about voucher payments.

partialsArray of objects(PaymentPartial)

Partial captures, refunds, and cancels committed against this payment. Append-only: a payment update appends entries with a new id and never changes or removes committed ones.

{
  "id": "p_KBiXuYjvYxsezKCQAMuuSKGDaT",
  "adapterId": "klarna-checkout",
  "name": "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": { … }
  },
  "voucher": {
    "cardId": "1234567890"
  },
  "partials": [
    { … }
  ]
}

Norce Checkout - Order Management API (1.0)

Schemas

PartialLine

PartialType

Payment

Checkout

Checkout Payment

Checkout Shipping