{"openapi":"3.1.1","info":{"title":"Norce Checkout - Nexi Adapter API","description":"Adapter for the Nexi Paygate payment gateway. Handles payment creation (Hosted Forms and Direct integration), webhooks, and order management (capture, refund, cancel).","version":"1.0.0"},"servers":[{"url":"http://nexi-adapter.checkout.prod.norce.tech/"}],"paths":{"/api/checkout/v1/callback/orders/{order_id}/payments/{payment_id}/webhook":{"post":{"tags":["Callbacks"],"summary":"Nexi webhook","description":"Webhook callback from Nexi Paygate. Receives the Nexi payId and resolves the final payment status.","parameters":[{"name":"merchant","in":"query","description":"Merchant identifier (query param — Nexi cannot send custom headers)","required":true,"schema":{"type":"string"}},{"name":"channel","in":"query","description":"Channel identifier (query param)","required":true,"schema":{"type":"string"}},{"name":"order_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"payment_id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Nexi webhook payload containing the payId","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BasicWebhook"}},"text/json":{"schema":{"$ref":"#/components/schemas/BasicWebhook"}},"application/*+json":{"schema":{"$ref":"#/components/schemas/BasicWebhook"}}},"required":true},"responses":{"200":{"description":"OK"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}},"text/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}},"text/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}}}}},"/api/checkout/v1/callback/orders/{order_id}/payments/{payment_id}/return":{"get":{"tags":["Callbacks"],"summary":"Payment return URL","description":"Invoked when the customer is redirected back from the Nexi hosted payment form after completing payment. Resolves the final payment status by querying Nexi for payment details, then redirects the browser to the configured confirmation page (success) or checkout page (failure).","parameters":[{"name":"merchant","in":"query","description":"Merchant identifier (query param — browser redirects cannot send custom headers)","required":true,"schema":{"type":"string"}},{"name":"channel","in":"query","description":"Channel identifier (query param)","required":true,"schema":{"type":"string"}},{"name":"order_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"payment_id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"303":{"description":"See Other"}}}},"/api/checkout/v1/callback/orders/{order_id}/payments/{payment_id}/cancel":{"get":{"tags":["Callbacks"],"summary":"Payment cancel URL","description":"Invoked when the customer cancels payment on the Nexi hosted form. Marks the payment as cancelled if it has not already been reserved or captured, then redirects the browser to the configured checkout page.","parameters":[{"name":"merchant","in":"query","description":"Merchant identifier (query param — browser redirects cannot send custom headers)","required":true,"schema":{"type":"string"}},{"name":"channel","in":"query","description":"Channel identifier (query param)","required":true,"schema":{"type":"string"}},{"name":"order_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"payment_id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"303":{"description":"See Other"}}}},"/api/checkout/v1/callback/orders/{order_id}/payments/{payment_id}/update-payment":{"post":{"tags":["Callbacks"],"summary":"Update payment hook","description":"Internal hook invoked by checkout-order when the cart changes on an order with an active Nexi payment. Updates the Nexi payment amount to match the new order total.","parameters":[{"name":"merchant","in":"header","description":"Merchant and channel headers","schema":{"$ref":"#/components/schemas/RequiredMerchantHeaderModel"}},{"name":"order_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"payment_id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Full Norce order payload from the hook","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NorceOrder"}},"text/json":{"schema":{"$ref":"#/components/schemas/NorceOrder"}},"application/*+json":{"schema":{"$ref":"#/components/schemas/NorceOrder"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PatchOperation"}}},"text/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PatchOperation"}}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}},"text/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}}}}},"/api/checkout/v1/callback/orders/{order_id}/payments/{payment_id}/state-updated":{"post":{"tags":["Callbacks"],"summary":"State updated hook","description":"Internal hook invoked by checkout-order when the order state changes. Currently a no-op — order state advancement is driven from the external webhook/return callbacks.","parameters":[{"name":"merchant","in":"header","description":"Merchant and channel headers","schema":{"$ref":"#/components/schemas/RequiredMerchantHeaderModel"}},{"name":"order_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"payment_id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Full Norce order payload from the hook","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NorceOrder"}},"text/json":{"schema":{"$ref":"#/components/schemas/NorceOrder"}},"application/*+json":{"schema":{"$ref":"#/components/schemas/NorceOrder"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PatchOperation"}}},"text/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PatchOperation"}}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}},"text/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}}}}},"/api/checkout/v1/orders/{order_id}/payments":{"post":{"tags":["Payments"],"summary":"Initialize a Nexi payment","description":"Creates a new Nexi payment for an existing Norce checkout order.\nReturns a redirect URL for Hosted integration, or inline payment result for Direct integration.","parameters":[{"name":"merchant","in":"header","description":"Merchant and channel headers","schema":{"$ref":"#/components/schemas/RequiredMerchantHeaderModel"}},{"name":"order_id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Payment method selection and optional browser/device data for Direct integration","content":{"application/json":{"schema":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/CreatePaymentRequest"}]}},"text/json":{"schema":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/CreatePaymentRequest"}]}},"application/*+json":{"schema":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/CreatePaymentRequest"}]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NexiCheckoutOrder"}},"text/json":{"schema":{"$ref":"#/components/schemas/NexiCheckoutOrder"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}},"text/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}},"text/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}},"text/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/api/checkout/v1/orders/{order_id}/payments/{payment_id}/remove":{"post":{"tags":["Payments"],"summary":"Remove a Nexi payment","description":"Soft deletes the Nexi payment by setting its state to Removed and deletes the hooks\nregistered when the payment was created, allowing the customer to select another\npayment method. Payments in Reserved or Captured state cannot be removed.","parameters":[{"name":"merchant","in":"header","description":"Merchant and channel headers","schema":{"$ref":"#/components/schemas/RequiredMerchantHeaderModel"}},{"name":"order_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"payment_id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}},"text/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}},"text/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}},"text/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/api/order/v1/orders/{order_id}/payments/{payment_id}/capture":{"post":{"tags":["Order Management"],"summary":"Capture payment","description":"Capture a reserved Nexi payment. Transfers the authorized funds from the customer's account. Only available when the payment is in Reserved state.","parameters":[{"name":"merchant","in":"header","description":"Merchant and channel headers","schema":{"$ref":"#/components/schemas/RequiredMerchantHeaderModel"}},{"name":"order_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"payment_id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}},"text/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}},"text/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}},"text/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}}}}},"/api/order/v1/orders/{order_id}/payments/{payment_id}/refund":{"post":{"tags":["Order Management"],"summary":"Refund payment","description":"Refund a captured Nexi payment. Returns the captured funds to the customer. Only available when the payment is in Captured state.","parameters":[{"name":"merchant","in":"header","description":"Merchant and channel headers","schema":{"$ref":"#/components/schemas/RequiredMerchantHeaderModel"}},{"name":"order_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"payment_id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}},"text/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}},"text/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}},"text/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}}}}},"/api/order/v1/orders/{order_id}/payments/{payment_id}/cancel":{"post":{"tags":["Order Management"],"summary":"Cancel payment","description":"Cancel a reserved Nexi payment. Releases the authorization hold without capturing. Only available when the payment is in Reserved state.","parameters":[{"name":"merchant","in":"header","description":"Merchant and channel headers","schema":{"$ref":"#/components/schemas/RequiredMerchantHeaderModel"}},{"name":"order_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"payment_id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}},"text/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}},"text/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}},"text/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}}}}},"/api/order/v1/orders/{order_id}/payments/{payment_id}/refresh":{"post":{"tags":["Order Management"],"summary":"Refresh payment actions","description":"Rebuilds the available action list (Capture, Cancel, Refund) on the Norce payment to reflect the current payment state.","parameters":[{"name":"merchant","in":"header","description":"Merchant and channel headers","schema":{"$ref":"#/components/schemas/RequiredMerchantHeaderModel"}},{"name":"order_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"payment_id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK"},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}},"text/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}}}}}},"components":{"schemas":{"Addon":{"type":"object","properties":{"reference":{"type":["null","string"]},"price":{"pattern":"^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$","type":["number","string"],"format":"double"}}},"Address":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/CustomerType"},"givenName":{"type":["null","string"]},"familyName":{"type":["null","string"]},"careOf":{"type":["null","string"]},"reference":{"type":["null","string"]},"organizationName":{"type":["null","string"]},"streetAddress":{"type":["null","string"]},"streetAddress2":{"type":["null","string"]},"postalCode":{"type":["null","string"]},"city":{"type":["null","string"]},"region":{"type":["null","string"]},"country":{"type":["null","string"]},"phone":{"type":["null","string"]},"email":{"type":["null","string"]},"nationalIdentificationNumber":{"type":["null","string"]},"organizationIdentificationNumber":{"type":["null","string"]},"attributes":{"type":["null","object"]}}},"ApplePay":{"type":"object","properties":{"token":{"type":["null","string"]},"merchantIdentifierOfPublicKey":{"type":["null","string"]}}},"BasicWebhook":{"type":"object","properties":{"payId":{"type":["null","string"]}}},"BrowserInfoDto":{"type":"object","properties":{"acceptHeaders":{"type":["null","string"]},"ipAddress":{"type":["null","string"]},"javaEnabled":{"type":["null","boolean"]},"javaScriptEnabled":{"type":["null","boolean"]},"language":{"type":["null","string"]},"colorDepth":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"format":"int32"},"screenHeight":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"format":"int32"},"screenWidth":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"format":"int32"},"timeZoneOffset":{"type":["null","string"]},"userAgent":{"type":["null","string"]}}},"Callback":{"type":"object","properties":{"id":{"type":["null","string"]},"adapterId":{"type":["null","string"]},"event":{"$ref":"#/components/schemas/CallbackEvent"},"url":{"type":["null","string"]}}},"CallbackEvent":{"enum":["Validate","Accept","Complete"]},"Card":{"type":"object","properties":{"subType":{"type":["null","array"],"items":{"$ref":"#/components/schemas/CardSubType"}},"dccEnabled":{"type":["null","boolean"]},"template":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/CardTemplate"}]},"prefillInfo":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/CardPrefillInfo"}]},"number":{"type":["null","string"]},"cardHolderName":{"type":["null","string"]},"expiryDate":{"type":["null","string"]},"brand":{"type":["null","string"]},"securityCode":{"type":["null","string"]},"startDate":{"type":["null","string"]},"sequenceNumber":{"type":["null","string"]},"brandSelection":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/CardBrandSelection"}]},"tokenData":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/CardTokenData"}]}}},"CardBrandSelection":{"enum":["Customer","Merchant",null]},"CardPrefillInfo":{"type":"object","properties":{"cardHolderName":{"type":["null","string"]}}},"CardSubType":{"enum":["Airplus","Amex","Argencard","Aura","Bancontact","Cabal","Cartesbancaires","Cbn","Cencosud","Comfortcard","Cup","Dankort","Diners","Discover","Elo","Hipercard","Jcb","Laser","Maestro","Mastercard","Naranja","Rupay","Shopping","Total","Visa"]},"CardTemplate":{"type":"object","properties":{"name":{"type":["null","string"]},"fontSize":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"format":"int32"},"textColor":{"type":["null","string"]},"backgroundColor":{"type":["null","string"]},"backgroundImage":{"type":["null","string"]},"fontName":{"type":["null","string"]},"tableWidth":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"format":"int32"},"tableHeight":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"format":"int32"},"customFields":{"type":["null","object"],"additionalProperties":{"type":"string"}}}},"CardTokenData":{"type":"object","properties":{"cryptogram":{"type":["null","string"]},"eci":{"type":["null","string"]},"tokenRequestor":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/CardTokenRequestor"}]}}},"CardTokenRequestor":{"enum":["Applepay","Googlepay","MerchantTokenization",null]},"Cart":{"type":"object","properties":{"reference":{"type":["null","string"]},"items":{"type":["null","array"],"items":{"$ref":"#/components/schemas/Item"}},"discounts":{"type":["null","array"],"items":{"$ref":"#/components/schemas/Discount"}},"total":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/Price"}]},"attributes":{"type":["null","object"]}}},"Consent":{"type":"object","properties":{"id":{"type":["null","string"]},"checked":{"type":"boolean"},"text":{"type":["null","string"]},"required":{"type":"boolean"}}},"CreatePaymentRequest":{"required":["paymentMethods"],"type":"object","properties":{"paymentMethods":{"$ref":"#/components/schemas/PaymentMethods"},"browserInfo":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/BrowserInfoDto"}]},"device":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/DeviceDto"}]},"referencePayId":{"type":["null","string"]},"simulationMode":{"type":["null","string"]}}},"Customer":{"type":"object","properties":{"billing":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/Address"}]},"shipping":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/Address"}]},"type":{"$ref":"#/components/schemas/CustomerType"},"attributes":{"type":["null","object"]}}},"CustomerType":{"enum":["Person","Organization"]},"DeliveryDetails":{"type":"object","properties":{"carrier":{"type":["null","string"]},"class":{"type":["null","string"]},"product":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/Product"}]},"pickupLocation":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/PickupLocation"}]}}},"DeviceDto":{"type":"object","properties":{"deviceId":{"type":["null","string"]},"deviceType":{"type":["null","string"]},"deviceOs":{"type":["null","string"]}}},"DirectDebit":{"type":"object","properties":{"account":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/DirectDebitAccount"}]},"mandate":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/DirectDebitMandate"}]},"method":{"type":["null","string"]}}},"DirectDebitAccount":{"type":"object","properties":{"number":{"type":["null","string"]},"accountHolderName":{"type":["null","string"]},"code":{"type":["null","string"]},"bankName":{"type":["null","string"]}}},"DirectDebitMandate":{"type":"object","properties":{"mandateId":{"type":["null","string"]},"dateOfSignature":{"type":["null","string"],"format":"date"}}},"Discount":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/DiscountType"},"name":{"type":["null","string"]},"code":{"type":["null","string"]},"value":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/Price"}]},"attributes":{"type":["null","object"]}}},"DiscountType":{"enum":["Item","Shipping"]},"EasyCollect":{"type":"object","properties":{"eventToken":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/EasyCollectEventToken"}]},"mandateId":{"type":["null","string"]}}},"EasyCollectEventToken":{"enum":["MandateOnly","PaymentOnly","MandateWithPayment",null]},"Error":{"type":"object","properties":{"code":{"type":["null","string"],"description":"Error code","example":"cart-not-found"},"message":{"type":["null","string"],"description":"Detailed error information","example":"Cart with id:{id} not found."},"nexiError":{"oneOf":[{"type":"null"},{"description":"Error if originating from Nexi","$ref":"#/components/schemas/NexiError"}]}}},"GooglePay":{"type":"object","properties":{"token":{"type":["null","string"]}}},"Hook":{"type":"object","properties":{"id":{"type":["null","string"]},"adapterId":{"type":["null","string"]},"subscribeTo":{"type":["null","string"]},"target":{"type":["null","string"]},"invoke":{"type":["null","string"]}}},"IntegrationType":{"enum":["Hosted","Direct"]},"Item":{"type":"object","properties":{"id":{"type":["null","string"]},"reference":{"type":["null","string"]},"name":{"type":["null","string"]},"sku":{"type":["null","string"]},"url":{"type":["null","string"]},"imageUrl":{"type":["null","string"]},"quantity":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int32"},"unit":{"type":["null","string"]},"price":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/Price"}]},"total":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/Price"}]},"originalTotal":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/Price"}]},"vatRate":{"pattern":"^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$","type":["number","string"],"format":"double"},"discounts":{"type":["null","array"],"items":{"$ref":"#/components/schemas/Discount"}},"logistics":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/Logistics"}]},"attributes":{"type":["null","object"]}}},"Logistics":{"type":"object","properties":{"weight":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"format":"int32"},"height":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"format":"int32"},"width":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"format":"int32"},"length":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"format":"int32"}}},"NexiCheckoutOrder":{"type":"object","properties":{"paymentId":{"type":["null","string"],"description":"Identifier of the payment created in the Norce checkout order."},"redirectUrl":{"type":["null","string"],"description":"URL to the Nexi hosted payment form. Redirect the customer here to complete payment."},"status":{"type":["null","string"]},"responseCode":{"type":["null","string"]},"responseDescription":{"type":["null","string"]}}},"NexiError":{"type":"object","properties":{"responseCode":{"type":["null","string"],"description":"Nexi response code, e.g. 21500100","example":21500100},"responseDescription":{"type":["null","string"],"description":"Nexi response description, e.g. DECLINED","example":"DECLINED"},"payId":{"type":["null","string"],"description":"Nexi payment identifier, when one was allocated"},"traceId":{"type":["null","string"],"description":"Nexi-side correlation id, for support cases raised with Nexi"}}},"NorceOrder":{"type":"object","properties":{"id":{"type":["null","string"]},"merchant":{"type":["null","string"]},"channel":{"type":["null","string"]},"reference":{"type":["null","string"]},"created":{"type":"string","format":"date-time"},"lastModified":{"type":"string","format":"date-time"},"state":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/State"}]},"culture":{"type":["null","string"]},"currency":{"type":["null","string"]},"country":{"type":["null","string"]},"cart":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/Cart"}]},"shippings":{"type":["null","array"],"items":{"$ref":"#/components/schemas/Shipping"}},"payments":{"type":["null","array"],"items":{"$ref":"#/components/schemas/Payment"}},"customer":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/Customer"}]},"consents":{"type":["null","array"],"items":{"$ref":"#/components/schemas/Consent"}},"validations":{"type":["null","array"],"items":{"$ref":"#/components/schemas/Callback"}},"hooks":{"type":["null","array"],"items":{"$ref":"#/components/schemas/Hook"}},"notifications":{"type":["null","array"],"items":{"$ref":"#/components/schemas/Callback"}},"total":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/Price"}]},"attributes":{"type":["null","object"]}}},"OrderStatus":{"enum":["Checkout","Processing","Accepted","Completed","Declined","Removed"]},"PatchOperation":{"type":"object","properties":{"op":{"type":["null","string"]},"path":{"type":["null","string"]},"value":{}}},"Payment":{"type":"object","properties":{"id":{"type":["null","string"]},"adapterId":{"type":["null","string"]},"name":{"type":["null","string"]},"merchant":{"type":["null","string"]},"channel":{"type":["null","string"]},"currency":{"type":["null","string"]},"type":{"$ref":"#/components/schemas/PaymentType"},"orderId":{"type":["null","string"]},"amount":{"pattern":"^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$","type":["number","string"],"format":"double"},"upperLimitAmount":{"pattern":"^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$","type":["null","number","string"],"format":"double"},"state":{"$ref":"#/components/schemas/PaymentState"},"reference":{"type":["null","string"]},"attributes":{"type":["null","object"]},"actions":{"type":["null","array"],"items":{"$ref":"#/components/schemas/PaymentAction"}},"recurring":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/Recurring"}]}}},"PaymentAction":{"type":"object","properties":{"id":{"type":["null","string"]},"adapterId":{"type":["null","string"]},"type":{"type":["null","string"]},"url":{"type":["null","string"]}}},"PaymentMethods":{"required":["integrationType","type"],"type":"object","properties":{"integrationType":{"$ref":"#/components/schemas/IntegrationType"},"type":{"$ref":"#/components/schemas/PaymentMethodType"},"card":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/Card"}]},"applePay":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/ApplePay"}]},"googlePay":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/GooglePay"}]},"directDebit":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/DirectDebit"}]},"ratepay":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/Ratepay"}]},"easyCollect":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/EasyCollect"}]},"pfConnect":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/PfConnect"}]},"payPal":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/PayPal"}]}}},"PaymentMethodType":{"enum":["Alipay","Amazonpay","Applepay","Bancontact","Bizum","Boleto","Card","Directdebit","Easycollect","Eps","Floapay","Googlepay","Ideal","Instanea","Klarna","Mbway","Mobilepay","Multibanco","Mybank","Pagbrasilpl","Paypal","Payu","Pfconnect","Przelewy24","Ratepay","Riverty","Swish","Vippsmobilepay","Trustly","Twint","Unionpay","Wechat","Wero"]},"PaymentState":{"enum":["Intent","Removed","Processing","Failed","Confirmed","Pending","Declined","Reserved","Credited","Captured","Cancelled","Refunded"]},"PaymentType":{"enum":["Default","Prepaid","Voucher"]},"PayPal":{"type":"object","properties":{"accountId":{"type":["null","string"]},"expressCheckout":{"type":["null","boolean"]},"hideAddress":{"type":["null","boolean"]}}},"PfConnect":{"type":"object","properties":{"merchantCountryCode":{"type":["null","string"]},"financialProductId":{"type":["null","string"]},"shoppingBasketAmount":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"format":"int64"},"downPaymentAmount":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"format":"int64"},"deliveryDate":{"type":["null","string"]},"applicationDate":{"type":["null","string"]},"aboId":{"type":["null","string"]},"quotationId":{"type":["null","string"]},"customerRole":{"type":["null","string"]}}},"PickupLocation":{"type":"object","properties":{"reference":{"type":["null","string"]},"name":{"type":["null","string"]},"address":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/PickupLocationAddress"}]}}},"PickupLocationAddress":{"type":"object","properties":{"streetAddress":{"type":["null","string"]},"city":{"type":["null","string"]},"postalCode":{"type":["null","string"]},"country":{"type":["null","string"]}}},"Price":{"type":"object","properties":{"includingVat":{"pattern":"^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$","type":["number","string"],"format":"double"},"excludingVat":{"pattern":"^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$","type":["number","string"],"format":"double"}}},"ProblemDetails":{"type":"object","properties":{"type":{"type":["null","string"]},"title":{"type":["null","string"]},"status":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"format":"int32"},"detail":{"type":["null","string"]},"instance":{"type":["null","string"]}}},"Product":{"type":"object","properties":{"reference":{"type":["null","string"]},"name":{"type":["null","string"]}}},"Ratepay":{"type":"object","properties":{"subType":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/RatepaySubType"}]},"transferType":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/RatepayTransferType"}]}}},"RatepaySubType":{"enum":["OpenInvoice","PayNow",null]},"RatepayTransferType":{"enum":["BankTransfer","SepaDirectDebit",null]},"Recurring":{"type":"object","properties":{"token":{"type":["null","string"]},"description":{"type":["null","string"]},"attributes":{"type":["null","object"]}}},"RequiredMerchantHeaderModel":{"required":["merchantId","channel"],"type":"object","properties":{"merchantId":{"type":["null","string"],"description":"Merchant identifier.","example":"norce"},"channel":{"type":["null","string"],"description":"Channel identifier","example":1}}},"Shipping":{"type":"object","properties":{"id":{"type":["null","string"]},"merchant":{"type":["null","string"]},"channel":{"type":["null","string"]},"state":{"$ref":"#/components/schemas/ShippingState"},"reference":{"type":["null","string"]},"tmsReference":{"type":["null","string"]},"orderId":{"type":["null","string"]},"adapterId":{"type":["null","string"]},"name":{"type":["null","string"]},"total":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/Price"}]},"vatRate":{"pattern":"^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$","type":["number","string"],"format":"double"},"deliveryDetails":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/DeliveryDetails"}]},"addons":{"type":["null","array"],"items":{"$ref":"#/components/schemas/Addon"}},"attributes":{"type":["null","object"]}}},"ShippingState":{"enum":["Intent","Removed","Processing","Failed","Confirmed"]},"State":{"type":"object","properties":{"currentStatus":{"$ref":"#/components/schemas/OrderStatus"},"transitions":{"type":["null","array"],"items":{"$ref":"#/components/schemas/Transition"}}}},"Transition":{"type":"object","properties":{"status":{"$ref":"#/components/schemas/OrderStatus"},"timeStamp":{"type":"string","format":"date-time"}}}}},"tags":[{"name":"Callbacks"},{"name":"Payments"},{"name":"Order Management"}]}