Payment

Pagination

offsetinteger(int32)read-only

Query offset

limitinteger(int32)read-only

Query limit

sizeinteger(int32)read-only

Results count, after filtering

valueSumnumber(double)read-only

Sum of values, after filtering, Amount in major unit currency.

totalSizeinteger(int32)read-only

Total size of available set

{
  "offset": 0,
  "limit": 0,
  "size": 0,
  "valueSum": 0.1,
  "totalSize": 0
}

Payment

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.

{
  "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": { … }
  }
}

Norce Checkout - Order Management API (0.1)

Schemas

Payment

PaymentAction

Checkout

Checkout Payment

Checkout Shipping