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
Languages
Servers
Test server

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

Schemas

Payments

Operations

Initialize a new Avarda Checkout Session

Request

Requires an existing Norce order.

Path
order_idstringrequired

Order identifier

Headers
x-merchantstringrequired

Merchant identifier. norce

x-channelstringrequired

Channel identifier. 1

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

Responses

OK

Bodyapplication/json
paymentIdstring
purchaseJwtstring
javascriptUrlstring
stylesobject
Response
application/json
{ "paymentId": "string", "purchaseJwt": "string", "javascriptUrl": "string", "styles": { "property1": null, "property2": null } }

Get Avarda Checkout Session

Request

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

Path
order_idstringrequired

Order identifier

payment_idstringrequired

Payment identifier

Headers
x-merchantstringrequired

Merchant identifier. norce

x-channelstringrequired

Channel identifier. 1

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

Responses

OK

Bodyapplication/json
paymentIdstring
purchaseJwtstring
javascriptUrlstring
stylesobject
Response
application/json
{ "paymentId": "string", "purchaseJwt": "string", "javascriptUrl": "string", "styles": { "property1": null, "property2": null } }

Remove an Avarda Checkout order

Request

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.

Path
order_idstringrequired

Order identifier

payment_idstringrequired

Payment identifier

Headers
x-merchantstringrequired

Merchant identifier. norce

x-channelstringrequired

Channel identifier. 1

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

Responses

OK

Response
No content

Avarda Checkout Callbacks

Operations

Avarda 'Client-side events' Callbacks

Operations

Norce Callbacks

Operations

Order Management

Operations