Norce Checkout - Walley Checkout Adapter API

Version: 0.0.1

Build 2025-11-03 10:44:51

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

Related Documentation

For conceptual documentation and usage guides, see:

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

Base URLs

• https://checkout-walley-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 Payment

Initialize a new Walley Checkout payment session for 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: WalleyCheckoutOrder

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 Payment

Get an existing Walley Checkout payment session. May be used to get the Walley html snippet, for example after the Walley 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: WalleyCheckoutOrder

404

Not Found

Content-Type: application/json

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

Remove a Walley Checkout payment

Requires an existing Norce order. Will do soft delete on any payments or shippings by setting state to removed. Will delete any hooks added when creating a Walley Checkout payment.

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

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

Notification

Consumes notifications when a Walley Checkout order is completed or invoice status is updated.

Parameters

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

Responses

200

OK

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

Validation

Validates Walley Checkout order against Norce order requirements such as currently in stock, correct pricing etc.

Parameters

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

Responses

200

OK

Content-Type: application/json

Schema: WalleyCheckoutValidationSuccess

400

Bad Request

Content-Type: application/json

Schema: WalleyCheckoutValidationCustomError

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

Update Customer

Updates customer information on Norce order with latest customer information from Walley.

Parameters

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

Responses

200

OK

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

Update Shipping Option

Updates shipping option on Norce order with latest shipping information from Walley.

Parameters

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

Responses

200

OK

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

State Changed

Updates the Walley Checkout order when the Norce state changes, ex. transitioning back from processing to checkout.

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}/cart-changed

Cart Changed

Updates the Walley Checkout order when the Norce cart changes, ex. if a new item is added to the cart or the amount changes.

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

202

Accepted

404

Not Found

Content-Type: application/json

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

Handle order changes

Responds with patch for updated payment given an updated 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

Request Body

Updated order

Content-Type: application/json

Responses

200

OK

Content-Type: application/json

Schema: Array of PatchOperation

400

Bad Request

Content-Type: application/json

404

Not Found

Content-Type: application/json

423

Locked

Content-Type: application/json

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

Refresh the list of available PaymentActions for a Walley Checkout Order Payment

Refreshes the list of available payment actions on the Walley Checkout 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
  • Type: string
• payment_id (path) required
  • 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 Walley Order

Used to cancel a Walley order

Parameters

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

Responses

200

OK

Content-Type: application/json

Schema: WalleyCheckoutOrder

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

Capture Walley order

Used to capture a Walley 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

Content-Type: application/json

Schema: WalleyCheckoutOrder

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

Refund Walley order

Used to refund a Walley 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

Content-Type: application/json

Schema: WalleyCheckoutOrder

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)

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."
• error_text (string)

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

Logistics

Properties

• weight (integer)
• height (integer)
• width (integer)
• length (integer)
• tags (array)
• shippingDate (string)

Order

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 Callback
• total
• attributes (object)

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)

WalleyCheckoutOrder

Properties

• paymentId (string)
  • Payment Id
• publicToken (string)
  • The PublicToken is used to render the Checkout iframe. The public token has a limited lifetime of 168 hours (7 days).
  • Example: "public-SE-20e84dd04dcc3da405696d6f15b5154a9572f64d2394f461"
• htmlSnippet (string)
  • Place this script on the pages where you want the Checkout to appear. The value provided in the data-token attribute corresponds to the public token received when initializing the Checkout session. When the script is executed, the Checkout iframe is dynamically fetched and rendered on the page.
  • Example: "\n <script src=\"https://checkout.uat.walleydev.com/walley-checkout-loader.js\"\n data-token=\"public-SE-20e84dd04dcc3da405696d6f15b5154a9572f64d2394f461\" data-version=\"v2\"></script>\n "

WalleyCheckoutValidationCustomError

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.

WalleyCheckoutValidationSuccess

Properties

• orderReference (string)
  • Order reference to the order just created during the validate call. This can later be used to track the purchase with merchant services. Max 50 chars.