Norce Checkout - Avarda Checkout Adapter API

Version: 1.0.0

Build 2025-10-28 13:31:10

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

Related Documentation

For conceptual documentation and usage guides, see:

• Avarda Provider - Avarda integration overview and configuration
• Payment Adapters - Overview of NCO payment adapters
• NCO Introduction - Getting started with Norce Checkout

Base URLs

• https://checkout-avarda-adapter.test.norce.tech - Test server

Authentication

Bearer

• Type: apiKey
• Description: Authorization header using the bearer scheme. Example: 'Bearer a3bcdABCaB12abc3AbCDAB5AbcABCaBcABC5ab3c5A0='

Endpoints

POST /api/checkout/v1/orders/{order_id}/payments

Initialize a new Avarda Checkout Session

Requires an existing Norce order.

Parameters

• x-merchant (header) required
  • Merchant identifier. norce
  • Type: string
• x-channel (header) required
  • Channel identifier. 1
  • Type: string
• order_id (path) required
  • Order identifier
  • Type: string

Responses

200

OK

Content-Type: application/json

Schema: AvardaCheckoutOrder

400

Bad Request

Content-Type: application/json

Schema: Error

404

Not Found

Content-Type: application/json

409

Conflict

Content-Type: application/json

Schema: Error

GET /api/checkout/v1/orders/{order_id}/payments/{payment_id}

Get Avarda Checkout Session

Used to get the html snippet, for example after the Avarda Checkout Order has been confirmed.

Parameters

• x-merchant (header) required
  • Merchant identifier. norce
  • Type: string
• x-channel (header) required
  • Channel identifier. 1
  • Type: string
• order_id (path) required
  • Order identifier
  • Type: string
• payment_id (path) required
  • Payment identifier
  • Type: string

Responses

200

OK

Content-Type: application/json

Schema: AvardaCheckoutOrder

404

Not Found

Content-Type: application/json

POST /api/checkout/v1/orders/{order_id}/payments/{payment_id}/remove

Remove an Avarda Checkout order

Requires an existing Norce order. Will soft delete any payments and/or shipping by setting their respective state to removed. Will delete any hooks added when creating a Avarda Checkout order.

Parameters

• x-merchant (header) required
  • Merchant identifier. norce
  • Type: string
• x-channel (header) required
  • Channel identifier. 1
  • Type: string
• order_id (path) required
  • Order identifier
  • Type: string
• payment_id (path) required
  • Payment identifier
  • Type: string

Responses

200

OK

400

Bad Request

Content-Type: application/json

Schema: Error

401

Unauthorized

Content-Type: application/json

Schema: Error

404

Not Found

Content-Type: application/json

POST /api/checkout/v1/callback/orders/{order_id}/payments/{payment_id}/notification

Notification

Consumes notification when a Avarda Checkout Order is completed or Invoice Status is updated

Parameters

• order_id (path) required
  • Order identifier
  • Type: string
• merchant (query) required
  • Merchant identifier
  • Type: string
• channel (query) required
  • Merchant channel
  • Type: string
• payment_id (path) required
  • Payment identifier
  • Type: string

Responses

200

OK

POST /api/checkout/v1/callback/orders/{order_id}/payments/{payment_id}/process

Process

Parameters

• order_id (path) required
  • Order identifier
  • Type: string
• payment_id (path) required
  • Payment identifier
  • Type: string
• x-merchant (header) required
  • Merchant identifier
  • Type: string
• x-channel (header) required
  • Merchant channel
  • Type: string

Responses

200

OK

400

Bad Request

Content-Type: application/json

Schema: AvardaCheckoutValidationCustomError

POST /api/checkout/v1/callback/orders/{order_id}/payments/{payment_id}/customer-update

Refresh customer information on norce order from Avarda order

Updates customer information on norce order with latest customer information from Avarda

Parameters

• order_id (path) required
  • Order identifier
  • Type: string
• merchant (query) required
  • Merchant identifier
  • Type: string
• channel (query) required
  • Merchant channel
  • Type: string
• payment_id (path) required
  • Payment identifier
  • Type: string

Responses

200

OK

POST /api/checkout/v1/callback/orders/{order_id}/payments/{payment_id}/shipping-option-update

Shipping option update. The norce order will be updated with the latest selected delivery information from Avarda

Shipping option updated notifications. Will update the norce order with latest shipping selection from Avarda

Parameters

• order_id (path) required
  • Order identifier
  • Type: string
• merchant (query) required
  • Merchant identifier
  • Type: string
• channel (query) required
  • Merchant channel
  • Type: string
• payment_id (path) required
  • Payment identifier
  • Type: string

Responses

200

OK

POST /api/checkout/v1/callback/orders/{order_id}/payments/{payment_id}/cart-changed

Handle Cart changed

Cart changed.

Parameters

• x-merchant (header) required
  • Merchant identifier. norce
  • Type: string
• x-channel (header) required
  • Channel identifier. 1
  • Type: string
• order_id (path) required
  • Order identifier
  • Type: string
• payment_id (path) required
  • Payment identifier
  • Type: string

Request Body

Updated order

Content-Type: application/json

Responses

200

OK

Content-Type: application/json

Schema: Array of PatchOperation

404

Not Found

Content-Type: application/json

POST /api/checkout/v1/callback/orders/{order_id}/payments/{payment_id}/state-changed

Handle State changed

State changed.

Parameters

• x-merchant (header) required
  • Merchant identifier. norce
  • Type: string
• x-channel (header) required
  • Channel identifier. 1
  • Type: string
• order_id (path) required
  • Order identifier
  • Type: string
• payment_id (path) required
  • Payment identifier
  • Type: string

Request Body

Updated order

Content-Type: application/json

Responses

200

OK

Content-Type: application/json

Schema: Array of PatchOperation

404

Not Found

Content-Type: application/json

POST /api/checkout/v1/callback/orders/{order_id}/payments/{payment_id}/validate

Validate

Parameters

• order_id (path) required
  • Order identifier
  • Type: string
• payment_id (path) required
  • Payment identifier
  • Type: string
• x-merchant (header) required
  • Merchant identifier
  • Type: string
• x-channel (header) required
  • Merchant channel
  • Type: string

Responses

200

OK

400

Bad Request

Content-Type: application/json

Schema: Array of ValidationError

401

Unauthorized

Content-Type: application/json

Schema: Error

404

Not Found

Content-Type: application/json

Schema: Error

POST /api/order/v1/orders/{order_id}/payments/{payment_id}/refresh

Refresh the list of available PaymentActions for an order

Refreshes the list of available payment actions on the payment to reflect the current payment state

Parameters

• x-merchant (header) required
  • Merchant identifier. norce
  • Type: string
• x-channel (header) required
  • Channel identifier. 1
  • Type: string
• order_id (path) required
  • Order identifier
  • Type: string
• payment_id (path) required
  • Payment identifier
  • Type: string

Responses

200

OK

400

Bad Request

Content-Type: application/json

404

Not Found

Content-Type: application/json

POST /api/order/v1/orders/{order_id}/payments/{payment_id}/capture

Capture order

Used to capture order

Parameters

• x-merchant (header) required
  • Merchant identifier. norce
  • Type: string
• x-channel (header) required
  • Channel identifier. 1
  • Type: string
• order_id (path) required
  • Order identifier
  • Type: string
• payment_id (path) required
  • Payment identifier
  • Type: string

Responses

200

OK

400

Bad Request

Content-Type: application/json

404

Not Found

Content-Type: application/json

POST /api/order/v1/orders/{order_id}/payments/{payment_id}/cancel

Cancel order

Used to cancel order

Parameters

• x-merchant (header) required
  • Merchant identifier. norce
  • Type: string
• x-channel (header) required
  • Channel identifier. 1
  • Type: string
• order_id (path) required
  • Order identifier
  • Type: string
• payment_id (path) required
  • Payment identifier
  • Type: string

Responses

200

OK

400

Bad Request

Content-Type: application/json

404

Not Found

Content-Type: application/json

POST /api/order/v1/orders/{order_id}/payments/{payment_id}/refund

Refund order

Used to refund order

Parameters

• x-merchant (header) required
  • Merchant identifier. norce
  • Type: string
• x-channel (header) required
  • Channel identifier. 1
  • Type: string
• order_id (path) required
  • Order identifier
  • Type: string
• payment_id (path) required
  • Payment identifier
  • Type: string

Responses

200

OK

400

Bad Request

Content-Type: application/json

404

Not Found

Content-Type: application/json

Schemas

Addon

Properties

• reference (string)
• price (number)

Address

Properties

• customerType
• 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 (object)

AvardaCheckoutOrder

Properties

• paymentId (string)
• purchaseJwt (string)
• javascriptUrl (string)
• styles (object)

AvardaCheckoutValidationCustomError

Properties

• title (string)
  • The title of the validation failure displayed in the Checkout. Truncated to max 512 chars.
• message (string)
  • The message with a more descriptive text why the validation failed, and how the customer should proceed. Truncated to max 512 chars.

Callback

Properties

• id (string)
• adapterId (string)
• event
• url (string)

CallbackEvent

Cart

Properties

• reference (string)
• items (array) - Array of Item
• discounts (array) - Array of Discount
• total

Consent

Properties

• id (string)
• checked (boolean)
• text (string)
• required (boolean)

Customer

Properties

• billing
• shipping
• type required
• attributes (object)

CustomerType

DeliveryDetails

Properties

• carrier (string)
• class (string)
• product
• pickupLocation

Discount

Properties

• type
• name (string)
• code (string)
• value
• attributes (object)

DiscountType

Error

Properties

• code (string)
  • Error code
  • Example: "cart-not-found"
• message (string)
  • Detailed error information
  • Example: "Cart with id:{id} now found."

Hook

Properties

• id (string)
• adapterId (string)
• subscribeTo (string)
• target (string)
• invoke (string)

Item

Properties

• id (string)
• reference (string)
• name (string)
• sku (string)
• url (string)
• imageUrl (string)
• quantity (integer)
• unit (string)
• price
• total
• originalTotal
• vatRate (number)
• discounts (array) - Array of Discount
• attributes (object)

NorceOrder

Properties

• id (string)
• merchant (string)
• channel (string)
• reference (string)
• created (string)
• lastModified (string)
• state
• culture (string)
• currency (string)
• country (string)
• cart
• shippings (array) - Array of Shipping
• payments (array) - Array of Payment
• customer
• consents (array) - Array of Consent
• validations (array) - Array of Callback
• hooks (array) - Array of Hook
• notifications (array) - Array of Notification
• total
• attributes (object)

Notification

Properties

• id (string)
• adapterId (string)
• reference (string)
• description (string)
• scope (string)
• schema (object)
• invoke (string)

OrderStatus

PatchOperation

Properties

• op (string)
• path (string)
• value

Payment

Properties

• id (string)
• adapterId (string)
• name (string)
• merchant (string)
• channel (string)
• currency (string)
• type
• orderId (string)
• amount (number)
• upperLimitAmount (number)
• state
• reference (string)
• attributes (object)
• actions (array) - Array of PaymentAction

PaymentAction

Properties

• id (string)
• adapterId (string)
• type (string)
• url (string)

PaymentState

PaymentType

PickupLocation

Properties

• reference (string)
• name (string)
• address

Price

Properties

• includingVat (number)
• excludingVat (number)

ProblemDetails

Properties

• type (string)
• title (string)
• status (integer)
• detail (string)
• instance (string)

Product

Properties

• reference (string)
• name (string)

Shipping

Properties

• id (string)
• merchant (string)
• channel (string)
• reference (string)
• tmsReference (string)
• orderId (string)
• adapterId (string)
• name (string)
• total
• vatRate (number)
• deliveryDetails
• addons (array) - Array of Addon
• attributes (object)

ShippingAddress

Properties

• streetAddress (string)
• city (string)
• postalCode (string)
• country (string)

State

Properties

• currentStatus
• transitions (array) - Array of Transition

Transition

Properties

• status
• timeStamp (string)

ValidationError

Properties

• code (string)
• adapterId (string)