NORCE CHECKOUT

PAYMENT ADAPTERS

Norce Checkout - Avarda Checkout Adapter API (1.0.0)

Build 2026-01-09 07:29:55

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

Download OpenAPI description

avarda-adapter.json

avarda-adapter.yaml

Servers

Test server

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

Schemas

Payments

Operations

Avarda Checkout Callbacks

Operations

Avarda 'Client-side events' Callbacks

Operations

Norce Callbacks

Operations

Handle Cart changed

Request

Cart changed.

Path

order_idstringrequired

Order identifier

payment_idstringrequired

Payment identifier

Headers

x-merchantstringrequired

Merchant identifier. norce

x-channelstringrequired

Channel identifier. 1

Bodyapplication/json

Updated 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)

validationsArray of objects(Callback)

hooksArray of objects(Hook)

notificationsArray of objects(Notification)

totalobject

attributesobject

curl -i -X POST \
  'https://checkout-avarda-adapter.test.norce.tech/api/checkout/v1/callback/orders/{order_id}/payments/{payment_id}/cart-changed' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -H 'x-channel: string' \
  -H 'x-merchant: string' \
  -d '{
    "id": "string",
    "merchant": "string",
    "channel": "string",
    "reference": "string",
    "created": "2019-08-24T14:15:22Z",
    "lastModified": "2019-08-24T14:15:22Z",
    "state": {
      "currentStatus": "checkout"
    },
    "culture": "string",
    "currency": "string",
    "country": "string",
    "cart": {
      "reference": "string",
      "items": [
        {
          "id": "string",
          "reference": "string",
          "name": "string",
          "sku": "string",
          "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
      }
    },
    "shippings": [
      {
        "id": "string",
        "merchant": "string",
        "channel": "string",
        "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",
        "merchant": "string",
        "channel": "string",
        "currency": "string",
        "type": "default",
        "orderId": "string",
        "amount": 0.1,
        "upperLimitAmount": 0.1,
        "state": "intent",
        "reference": "string",
        "attributes": {
          "property1": null,
          "property2": null
        },
        "actions": [
          {
            "id": "string",
            "adapterId": "string",
            "type": "string",
            "url": "string"
          }
        ]
      }
    ],
    "customer": {
      "billing": {
        "customerType": "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": {
        "customerType": "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
      }
    ],
    "validations": [
      {
        "adapterId": "string",
        "event": "validate",
        "url": "string"
      }
    ],
    "hooks": [
      {
        "adapterId": "string",
        "subscribeTo": "string",
        "target": "string",
        "invoke": "string"
      }
    ],
    "notifications": [
      {
        "id": "string",
        "adapterId": "string",
        "reference": "string",
        "description": "string",
        "scope": "string",
        "schema": {
          "property1": null,
          "property2": null
        },
        "invoke": "string"
      }
    ],
    "total": {
      "includingVat": 0.1,
      "excludingVat": 0.1
    },
    "attributes": {
      "property1": null,
      "property2": null
    }
  }'

Responses

Bodyapplication/jsonArray [

opstring

pathstring

valueany

]

Response

application/json

[
  {
    "op": "string",
    "path": "string",
    "value": null
  }
]

Handle State changed

Request

State changed.

Path

order_idstringrequired

Order identifier

payment_idstringrequired

Payment identifier

Headers

x-merchantstringrequired

Merchant identifier. norce

x-channelstringrequired

Channel identifier. 1

Bodyapplication/json

Updated 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)

validationsArray of objects(Callback)

hooksArray of objects(Hook)

notificationsArray of objects(Notification)

totalobject

attributesobject

curl -i -X POST \
  'https://checkout-avarda-adapter.test.norce.tech/api/checkout/v1/callback/orders/{order_id}/payments/{payment_id}/state-changed' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -H 'x-channel: string' \
  -H 'x-merchant: string' \
  -d '{
    "id": "string",
    "merchant": "string",
    "channel": "string",
    "reference": "string",
    "created": "2019-08-24T14:15:22Z",
    "lastModified": "2019-08-24T14:15:22Z",
    "state": {
      "currentStatus": "checkout"
    },
    "culture": "string",
    "currency": "string",
    "country": "string",
    "cart": {
      "reference": "string",
      "items": [
        {
          "id": "string",
          "reference": "string",
          "name": "string",
          "sku": "string",
          "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
      }
    },
    "shippings": [
      {
        "id": "string",
        "merchant": "string",
        "channel": "string",
        "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",
        "merchant": "string",
        "channel": "string",
        "currency": "string",
        "type": "default",
        "orderId": "string",
        "amount": 0.1,
        "upperLimitAmount": 0.1,
        "state": "intent",
        "reference": "string",
        "attributes": {
          "property1": null,
          "property2": null
        },
        "actions": [
          {
            "id": "string",
            "adapterId": "string",
            "type": "string",
            "url": "string"
          }
        ]
      }
    ],
    "customer": {
      "billing": {
        "customerType": "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": {
        "customerType": "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
      }
    ],
    "validations": [
      {
        "adapterId": "string",
        "event": "validate",
        "url": "string"
      }
    ],
    "hooks": [
      {
        "adapterId": "string",
        "subscribeTo": "string",
        "target": "string",
        "invoke": "string"
      }
    ],
    "notifications": [
      {
        "id": "string",
        "adapterId": "string",
        "reference": "string",
        "description": "string",
        "scope": "string",
        "schema": {
          "property1": null,
          "property2": null
        },
        "invoke": "string"
      }
    ],
    "total": {
      "includingVat": 0.1,
      "excludingVat": 0.1
    },
    "attributes": {
      "property1": null,
      "property2": null
    }
  }'

Responses

Bodyapplication/jsonArray [

opstring

pathstring

valueany

]

Response

application/json

[
  {
    "op": "string",
    "path": "string",
    "value": null
  }
]

Validate

Request

Path

order_idstringrequired

Order identifier

payment_idstringrequired

Payment identifier

Headers

x-merchantstringrequired

Merchant identifier

x-channelstringrequired

Merchant channel

curl -i -X POST \
  'https://checkout-avarda-adapter.test.norce.tech/api/checkout/v1/callback/orders/{order_id}/payments/{payment_id}/validate' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'x-channel: string' \
  -H 'x-merchant: string'

Responses

Response

No content

Order Management

Operations

Norce Checkout - Avarda Checkout Adapter API (1.0.0)

Schemas

Payments

Avarda Checkout Callbacks

Avarda 'Client-side events' Callbacks

Norce Callbacks

Handle Cart changed

Request

Responses

Did the information on the page help you?

Handle State changed

Request

Responses

Did the information on the page help you?

Validate

Request

Responses

Did the information on the page help you?

Order Management

Norce Checkout - Avarda Checkout Adapter API (1.0.0)

Schemas

Payments

Avarda Checkout Callbacks

Avarda 'Client-side events' Callbacks

Norce Callbacks

Handle Cart changed

RequestExpand all

Responses

Did the information on the page help you?

Handle State changed

RequestExpand all

Responses

Did the information on the page help you?

Validate

Request

Responses

Did the information on the page help you?

Order Management

Request

Request