{"openapi":"3.0.4","info":{"title":"Norce Checkout - Awardit Adapter API","description":"Build 2026-10-20 07:07:57\n\nThe Awardit Adapter API is used to create and manage a Awardit Checkout Order.","version":"1.0.0"},"servers":[{"url":"https://{slug}.api-se.playground.norce.tech/checkout/awardit-adapter","description":"Playground","variables":{"slug":{"default":"customer-slug","description":"Replace with your slug."}}},{"url":"https://{slug}.api-se.stage.norce.tech/checkout/awardit-adapter","description":"Stage","variables":{"slug":{"default":"customer-slug","description":"Replace with your slug."}}},{"url":"https://{slug}.api-se.norce.tech/checkout/awardit-adapter","description":"Production","variables":{"slug":{"default":"customer-slug","description":"Replace with your slug."}}}],"paths":{"/api/checkout/v1/orders/{order_id}/payments":{"post":{"tags":["Payments"],"summary":"Create a new Awardit giftcard","description":"Requires an existing Norce order.","operationId":"CreateAwarditPayment","parameters":[{"name":"x-merchant","in":"header","description":"Merchant identifier.","required":true,"schema":{"type":"string","example":"norce"},"example":"norce"},{"name":"x-channel","in":"header","description":"Channel identifier","required":true,"schema":{"type":"string","example":"1"},"example":"1"},{"name":"order_id","in":"path","description":"Order identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/GiftCard"}]}}},"required":true},"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not Found","content":{"application/json":{}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"Bearer":[]}]}},"/api/checkout/v1/orders/{order_id}/payments/{payment_id}/remove":{"post":{"tags":["Payments"],"summary":"Remove a Awardit giftcard","description":"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 an Awardit payment.","operationId":"RemoveAwarditPayment","parameters":[{"name":"x-merchant","in":"header","description":"Merchant identifier.","required":true,"schema":{"type":"string","example":"norce"},"example":"norce"},{"name":"x-channel","in":"header","description":"Channel identifier","required":true,"schema":{"type":"string","example":"1"},"example":"1"},{"name":"order_id","in":"path","description":"Order identifier","required":true,"schema":{"type":"string"}},{"name":"payment_id","in":"path","description":"Payment identifier","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not Found","content":{"application/json":{}}}},"security":[{"Bearer":[]}]}},"/api/checkout/v1/orders/{order_id}/gift-card/enable-sell":{"post":{"tags":["Gift Cards"],"summary":"Enable gift card sell for an order","description":"Requires an existing Norce order in Checkout that contains gift card items configured in issueGiftCard. Registers the order scoped /state hook that validates the gift cards on Processing and issues them through Awardit on Completed. Does not issue any gift card itself. Idempotent.","operationId":"EnableGiftCardSell","parameters":[{"name":"x-merchant","in":"header","description":"Merchant identifier.","required":true,"schema":{"type":"string","example":"norce"},"example":"norce"},{"name":"x-channel","in":"header","description":"Channel identifier","required":true,"schema":{"type":"string","example":"1"},"example":"1"},{"name":"order_id","in":"path","description":"Order identifier","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not Found","content":{"application/json":{}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"Bearer":[]}]}},"/api/checkout/v1/callback/orders/{order_id}/state-changed":{"post":{"tags":["Norce Callbacks"],"summary":"Handle order state changed (order scoped, independent of any Awardit payment)","description":"Order state changed. Validates gift card items on Processing and issues gift cards on Completed.","operationId":"OrderStateChanged","parameters":[{"name":"x-merchant","in":"header","description":"Merchant identifier.","required":true,"schema":{"type":"string","example":"norce"},"example":"norce"},{"name":"x-channel","in":"header","description":"Channel identifier","required":true,"schema":{"type":"string","example":"1"},"example":"1"},{"name":"order_id","in":"path","description":"Order identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Updated order","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/NorceOrder"}]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PatchOperation"}}}}},"400":{"description":"Bad Request","content":{"application/json":{}}},"404":{"description":"Not Found","content":{"application/json":{}}}},"security":[{"Bearer":[]}]}},"/api/checkout/v1/callback/orders/{order_id}/payments/{payment_id}/state-changed":{"post":{"tags":["Norce Callbacks"],"summary":"Handle state changed","description":"State changed.","operationId":"StateChanged","parameters":[{"name":"x-merchant","in":"header","description":"Merchant identifier.","required":true,"schema":{"type":"string","example":"norce"},"example":"norce"},{"name":"x-channel","in":"header","description":"Channel identifier","required":true,"schema":{"type":"string","example":"1"},"example":"1"},{"name":"order_id","in":"path","description":"Order identifier","required":true,"schema":{"type":"string"}},{"name":"payment_id","in":"path","description":"Payment identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Updated order","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/NorceOrder"}]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PatchOperation"}}}}},"400":{"description":"Bad Request","content":{"application/json":{}}},"404":{"description":"Not Found","content":{"application/json":{}}}},"security":[{"Bearer":[]}]}},"/api/checkout/v1/callback/orders/{order_id}/payments/{payment_id}/update-payment":{"post":{"tags":["Norce Callbacks"],"summary":"Update payment amount in response to changes","description":"Hook on changes to update payment.","operationId":"UpdatePayment","parameters":[{"name":"x-merchant","in":"header","description":"Merchant identifier.","required":true,"schema":{"type":"string","example":"norce"},"example":"norce"},{"name":"x-channel","in":"header","description":"Channel identifier","required":true,"schema":{"type":"string","example":"1"},"example":"1"},{"name":"order_id","in":"path","description":"Order identifier","required":true,"schema":{"type":"string"}},{"name":"payment_id","in":"path","description":"Payment identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Updated order","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/NorceOrder"}]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PatchOperation"}}}}},"400":{"description":"Bad Request","content":{"application/json":{}}},"404":{"description":"Not Found","content":{"application/json":{}}}},"security":[{"Bearer":[]}]}},"/api/checkout/v1/orders/{order_id}/payments/{payment_id}/commit":{"post":{"tags":["Norce Notifications"],"summary":"Commit awardit transaction on authorized gift card","description":"Notification registered on order. Triggered by order status Completed.","operationId":"CommitAwarditPayment","parameters":[{"name":"x-merchant","in":"header","description":"Merchant identifier.","required":true,"schema":{"type":"string","example":"norce"},"example":"norce"},{"name":"x-channel","in":"header","description":"Channel identifier","required":true,"schema":{"type":"string","example":"1"},"example":"1"},{"name":"order_id","in":"path","description":"Order identifier","required":true,"schema":{"type":"string"}},{"name":"payment_id","in":"path","description":"Payment identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Completed order","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/NorceOrder"}]}}}},"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not Found","content":{"application/json":{}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"Bearer":[]}]}},"/api/checkout/v1/orders/{order_id}/payments/{payment_id}/cancel":{"post":{"tags":["Norce Notifications"],"summary":"Cancel awardit transaction on order changing back to \"checkout\" state with an authorized gift card","description":"Notification registered on order. Triggered by order status Checkout.","operationId":"CancelAwarditPayment","parameters":[{"name":"x-merchant","in":"header","description":"Merchant identifier.","required":true,"schema":{"type":"string","example":"norce"},"example":"norce"},{"name":"x-channel","in":"header","description":"Channel identifier","required":true,"schema":{"type":"string","example":"1"},"example":"1"},{"name":"order_id","in":"path","description":"Order identifier","required":true,"schema":{"type":"string"}},{"name":"payment_id","in":"path","description":"Payment identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Order in checkout state","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/NorceOrder"}]}}}},"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not Found","content":{"application/json":{}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"Bearer":[]}]}}},"components":{"schemas":{"Addon":{"type":"object","properties":{"reference":{"type":"string"},"price":{"type":"number","format":"double"}},"additionalProperties":false},"Address":{"type":"object","properties":{"type":{"allOf":[{"$ref":"#/components/schemas/CustomerType"}]},"givenName":{"type":"string"},"familyName":{"type":"string"},"careOf":{"type":"string"},"reference":{"type":"string"},"organizationName":{"type":"string"},"streetAddress":{"type":"string"},"streetAddress2":{"type":"string"},"postalCode":{"type":"string"},"city":{"type":"string"},"region":{"type":"string"},"country":{"type":"string"},"phone":{"type":"string"},"email":{"type":"string"},"nationalIdentificationNumber":{"type":"string"},"organizationIdentificationNumber":{"type":"string"},"attributes":{"type":"object","additionalProperties":{"nullable":true}}},"additionalProperties":false},"AwarditError":{"type":"object","properties":{"errorCode":{"type":"string"},"errorMessages":{"type":"array","items":{"type":"string"}},"correlationId":{"type":"string"}},"additionalProperties":false},"Cart":{"type":"object","properties":{"reference":{"type":"string"},"items":{"type":"array","items":{"$ref":"#/components/schemas/Item"}},"discounts":{"type":"array","items":{"$ref":"#/components/schemas/Discount"}},"total":{"allOf":[{"$ref":"#/components/schemas/Price"}]},"attributes":{"type":"object","additionalProperties":{"nullable":true}}},"additionalProperties":false},"Consent":{"type":"object","properties":{"id":{"type":"string"},"checked":{"type":"boolean"},"text":{"type":"string"},"required":{"type":"boolean"}},"additionalProperties":false},"Customer":{"type":"object","properties":{"billing":{"allOf":[{"$ref":"#/components/schemas/Address"}]},"shipping":{"allOf":[{"$ref":"#/components/schemas/Address"}]},"type":{"allOf":[{"$ref":"#/components/schemas/CustomerType"}]},"attributes":{"type":"object","additionalProperties":{"nullable":true}}},"additionalProperties":false},"CustomerType":{"enum":["person","organization"],"type":"string"},"DeliveryDetails":{"type":"object","properties":{"carrier":{"type":"string"},"class":{"type":"string"},"product":{"allOf":[{"$ref":"#/components/schemas/Product"}]},"pickupLocation":{"allOf":[{"$ref":"#/components/schemas/PickupLocation"}]}},"additionalProperties":false},"Discount":{"type":"object","properties":{"type":{"allOf":[{"$ref":"#/components/schemas/DiscountType"}]},"name":{"type":"string"},"code":{"type":"string"},"value":{"allOf":[{"$ref":"#/components/schemas/Price"}]},"attributes":{"type":"object","additionalProperties":{"nullable":true}}},"additionalProperties":false},"DiscountType":{"enum":["item","shipping"],"type":"string"},"Error":{"type":"object","properties":{"code":{"enum":["internal-server-error","unauthorized","configuration-error","configuration-not-found","order-not-found","order-error","order-bad-request","order-conflict","order-validation","order-unknown-validation-error","shipping-not-found","shipping-error","payment-not-found","payment-error","payment-conflict","awardit-error","awardit-bad-request","awardit-validation","awardit-card-not-found","awardit-missing-pin","awardit-card-empty","awardit-template-not-found","awardit-authentication","awardit-gift-card-voucher-payment-not-allowed","awardit-gift-card-template-not-available","awardit-gift-card-recipient-missing","awardit-gift-card-distribution-channel-not-supported","awardit-gift-card-send-at-invalid","awardit-gift-card-issuing-not-configured","awardit-gift-card-items-missing","translation-not-found"],"type":"string","description":"Error code","example":"cart-not-found"},"message":{"type":"string","description":"Detailed error information","example":"Cart with id:{id} not found."},"awarditError":{"allOf":[{"$ref":"#/components/schemas/AwarditError"}],"description":"Error if originating from Resurs Bank"}},"additionalProperties":false},"GiftCard":{"type":"object","properties":{"cardId":{"type":"string"},"code":{"type":"string"}},"additionalProperties":false},"Hook":{"type":"object","properties":{"id":{"type":"string"},"adapterId":{"type":"string"},"reference":{"type":"string"},"description":{"type":"string"},"scope":{"type":"string"},"version":{"allOf":[{"$ref":"#/components/schemas/OrderVersion"}]},"target":{"type":"string"},"invoke":{"type":"string"}},"additionalProperties":false},"Item":{"type":"object","properties":{"id":{"type":"string"},"reference":{"type":"string"},"name":{"type":"string"},"sku":{"type":"string"},"productType":{"allOf":[{"$ref":"#/components/schemas/ProductType"}]},"url":{"type":"string"},"imageUrl":{"type":"string"},"quantity":{"type":"integer","format":"int32"},"unit":{"type":"string"},"price":{"allOf":[{"$ref":"#/components/schemas/Price"}]},"total":{"allOf":[{"$ref":"#/components/schemas/Price"}]},"originalTotal":{"allOf":[{"$ref":"#/components/schemas/Price"}]},"vatRate":{"type":"number","format":"double"},"discounts":{"type":"array","items":{"$ref":"#/components/schemas/Discount"}},"attributes":{"type":"object","additionalProperties":{"nullable":true}}},"additionalProperties":false},"NorceOrder":{"type":"object","properties":{"id":{"type":"string"},"merchant":{"type":"string"},"channel":{"type":"string"},"reference":{"type":"string"},"created":{"type":"string","format":"date-time"},"lastModified":{"type":"string","format":"date-time"},"state":{"allOf":[{"$ref":"#/components/schemas/State"}]},"culture":{"type":"string"},"currency":{"type":"string"},"country":{"type":"string"},"cart":{"allOf":[{"$ref":"#/components/schemas/Cart"}]},"shippings":{"type":"array","items":{"$ref":"#/components/schemas/Shipping"}},"payments":{"type":"array","items":{"$ref":"#/components/schemas/Payment"}},"customer":{"allOf":[{"$ref":"#/components/schemas/Customer"}]},"consents":{"type":"array","items":{"$ref":"#/components/schemas/Consent"}},"hooks":{"type":"array","items":{"$ref":"#/components/schemas/Hook"}},"validations":{"type":"array","items":{"$ref":"#/components/schemas/Validation"}},"notifications":{"type":"array","items":{"$ref":"#/components/schemas/Notification"}},"total":{"allOf":[{"$ref":"#/components/schemas/Price"}]},"attributes":{"type":"object","additionalProperties":{"nullable":true}}},"additionalProperties":false},"Notification":{"type":"object","properties":{"id":{"type":"string"},"adapterId":{"type":"string"},"reference":{"type":"string"},"description":{"type":"string"},"scope":{"type":"string"},"schema":{"type":"object","additionalProperties":{"nullable":true}},"invoke":{"type":"string"},"delay":{"type":"integer","format":"int32"}},"additionalProperties":false},"OrderStatus":{"enum":["checkout","processing","accepted","completed","declined","removed"],"type":"string"},"OrderVersion":{"enum":["v0","v1"],"type":"string"},"PatchOperation":{"type":"object","properties":{"op":{"type":"string"},"path":{"type":"string"},"value":{}},"additionalProperties":false},"Payment":{"type":"object","properties":{"id":{"type":"string"},"adapterId":{"type":"string"},"name":{"type":"string"},"currency":{"type":"string"},"type":{"allOf":[{"$ref":"#/components/schemas/PaymentType"}]},"orderId":{"type":"string"},"amount":{"type":"number","format":"double"},"upperLimitAmount":{"type":"number","format":"double"},"state":{"allOf":[{"$ref":"#/components/schemas/PaymentState"}]},"reference":{"type":"string"},"voucher":{"allOf":[{"$ref":"#/components/schemas/Voucher"}]},"attributes":{"type":"object","additionalProperties":{"nullable":true}}},"additionalProperties":false},"PaymentState":{"enum":["intent","removed","processing","failed","confirmed","pending","declined","reserved","credited","captured","cancelled","refunded"],"type":"string"},"PaymentType":{"enum":["default","prepaid","voucher"],"type":"string"},"PickupLocation":{"type":"object","properties":{"reference":{"type":"string"},"name":{"type":"string"},"address":{"allOf":[{"$ref":"#/components/schemas/PickupLocationAddress"}]}},"additionalProperties":false},"PickupLocationAddress":{"type":"object","properties":{"streetAddress":{"type":"string"},"city":{"type":"string"},"postalCode":{"type":"string"},"country":{"type":"string"}},"additionalProperties":false},"Price":{"type":"object","properties":{"includingVat":{"type":"number","format":"double"},"excludingVat":{"type":"number","format":"double"}},"additionalProperties":false},"ProblemDetails":{"type":"object","properties":{"type":{"type":"string"},"title":{"type":"string"},"status":{"type":"integer","format":"int32"},"detail":{"type":"string"},"instance":{"type":"string"}},"additionalProperties":{}},"Product":{"type":"object","properties":{"reference":{"type":"string"},"name":{"type":"string"}},"additionalProperties":false},"ProductType":{"enum":["physical","digital","giftCard","bundle","placeholder","virtualBundle"],"type":"string"},"Shipping":{"type":"object","properties":{"id":{"type":"string"},"state":{"allOf":[{"$ref":"#/components/schemas/ShippingState"}]},"reference":{"type":"string"},"tmsReference":{"type":"string"},"orderId":{"type":"string"},"adapterId":{"type":"string"},"name":{"type":"string"},"total":{"allOf":[{"$ref":"#/components/schemas/Price"}]},"vatRate":{"type":"number","format":"double"},"deliveryDetails":{"allOf":[{"$ref":"#/components/schemas/DeliveryDetails"}]},"addons":{"type":"array","items":{"$ref":"#/components/schemas/Addon"}},"attributes":{"type":"object","additionalProperties":{"nullable":true}}},"additionalProperties":false},"ShippingState":{"enum":["intent","removed","processing","failed","confirmed"],"type":"string"},"State":{"type":"object","properties":{"currentStatus":{"allOf":[{"$ref":"#/components/schemas/OrderStatus"}]},"transitions":{"type":"array","items":{"$ref":"#/components/schemas/Transition"}}},"additionalProperties":false},"Transition":{"type":"object","properties":{"status":{"allOf":[{"$ref":"#/components/schemas/OrderStatus"}]},"timeStamp":{"type":"string","format":"date-time"}},"additionalProperties":false},"Validation":{"type":"object","properties":{"id":{"type":"string"},"adapterId":{"type":"string"},"reference":{"type":"string"},"description":{"type":"string"},"invoke":{"type":"string"}},"additionalProperties":false},"Voucher":{"type":"object","properties":{"cardId":{"type":"string"}},"additionalProperties":false}},"securitySchemes":{"Bearer":{"type":"apiKey","description":"Authorization header using the bearer scheme. Example: 'Bearer a3bcdABCaB12abc3AbCDAB5AbcABCaBcABC5ab3c5A0='","name":"Authorization","in":"header"}}}}