checkout-qliro-adapter-env.ci.jetshopcloud.io Open in urlscan Pro
20.76.203.228 Public Scan

Back to summary
Submitted URL:
https://checkout-qliro-adapter-env.ci.jetshopcloud.io/
Effective URL:
https://checkout-qliro-adapter-env.ci.jetshopcloud.io/docs/v1/index.html
Submission: On March 24 via api (March 24th 2024, 2:58:24 pm UTC) from US — Scanned from US
Form analysis
0 forms found in the DOM

Text Content

 * Payments
   * postCreate a new Qliro Checkout order
   * getGet an existing Qliro Checkout order
   * postRemove a Qliro Checkout order
 * Qliro Checkout Callbacks
   * postValidate
   * postPush
 * Qliro Checkout 'Client-side events' Callbacks
   * postRefresh customer information on Norce order from qliro order
   * postShipping option update. The Norce order will be updated with the latest
     selected delivery information from qliro
 * Norce Callbacks
   * postHandle Cart changed
   * postHandle State changed
 * Order Management
   * postRefresh the list of available PaymentActions for an order
   * postCancel Qliro Order
   * postCapture Qliro order
   * postRefund Qliro order

API docs by Redocly





NORCE CHECKOUT - QLIRO CHECKOUT ADAPTER API (1.0.0)

Download OpenAPI specification:Download




Build 2024-03-23 10:23:18

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


PAYMENTS


CREATE A NEW QLIRO CHECKOUT ORDER

Requires an existing Norce order.

AUTHORIZATIONS:

Bearer

PATH PARAMETERS

order_id
required
string

Order identifier

HEADER PARAMETERS

x-merchant
required
string
Example: norce

Merchant identifier.

x-channel
required
string
Example: 1

Channel identifier


RESPONSES

200

Success

RESPONSE SCHEMA: APPLICATION/JSON

paymentId
string

Norce Payment Id

htmlSnippet
string

Qliro checkout order html snippet.

400

Bad Request

RESPONSE SCHEMA: APPLICATION/JSON

code
string
Enum: "internal-server-error" "unauthorized" "configuration-error"
"configuration-not-found" "order-not-found" "order-error" "order-bad-request"
"order-conflict" "order-validation" "shipping-not-found" "shipping-error"
"payment-not-found" "payment-error" "payment-conflict" "qliro-error"
"qliro-bad-request" "qliro-validation" "qliro-order-not-found"
"translation-not-found"

Error code

message
string

Detailed error information

qliroError
object

Error if originating from Qliro

404

Not Found

409

Conflict

RESPONSE SCHEMA: APPLICATION/JSON

code
string
Enum: "internal-server-error" "unauthorized" "configuration-error"
"configuration-not-found" "order-not-found" "order-error" "order-bad-request"
"order-conflict" "order-validation" "shipping-not-found" "shipping-error"
"payment-not-found" "payment-error" "payment-conflict" "qliro-error"
"qliro-bad-request" "qliro-validation" "qliro-order-not-found"
"translation-not-found"

Error code

message
string

Detailed error information

qliroError
object

Error if originating from Qliro

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

Test server

https://checkout-qliro-adapter.test.norce.tech/api/checkout/v1/orders/{order_id}/payments


RESPONSE SAMPLES

 * 200
 * 400
 * 409

Content type
application/json
Copy
{
 * "paymentId": "string",
 * "htmlSnippet": ""

}




GET AN EXISTING QLIRO CHECKOUT ORDER

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

AUTHORIZATIONS:

Bearer

PATH PARAMETERS

order_id
required
string

Order identifier

payment_id
required
string

Payment identifier

HEADER PARAMETERS

x-merchant
required
string
Example: norce

Merchant identifier.

x-channel
required
string
Example: 1

Channel identifier


RESPONSES

200

Success

RESPONSE SCHEMA: APPLICATION/JSON

paymentId
string

Norce Payment Id

htmlSnippet
string

Qliro checkout order html snippet.

404

Not Found

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

Test server

https://checkout-qliro-adapter.test.norce.tech/api/checkout/v1/orders/{order_id}/payments/{payment_id}


RESPONSE SAMPLES

 * 200

Content type
application/json
Copy
{
 * "paymentId": "string",
 * "htmlSnippet": ""

}


REMOVE A QLIRO CHECKOUT ORDER

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 Qliro Checkout order.

AUTHORIZATIONS:

Bearer

PATH PARAMETERS

order_id
required
string

Order identifier

payment_id
required
string

Payment identifier

HEADER PARAMETERS

x-merchant
required
string
Example: norce

Merchant identifier.

x-channel
required
string
Example: 1

Channel identifier


RESPONSES

200

Success

400

Bad Request

RESPONSE SCHEMA: APPLICATION/JSON

code
string
Enum: "internal-server-error" "unauthorized" "configuration-error"
"configuration-not-found" "order-not-found" "order-error" "order-bad-request"
"order-conflict" "order-validation" "shipping-not-found" "shipping-error"
"payment-not-found" "payment-error" "payment-conflict" "qliro-error"
"qliro-bad-request" "qliro-validation" "qliro-order-not-found"
"translation-not-found"

Error code

message
string

Detailed error information

qliroError
object

Error if originating from Qliro

401

Unauthorized

RESPONSE SCHEMA: APPLICATION/JSON

code
string
Enum: "internal-server-error" "unauthorized" "configuration-error"
"configuration-not-found" "order-not-found" "order-error" "order-bad-request"
"order-conflict" "order-validation" "shipping-not-found" "shipping-error"
"payment-not-found" "payment-error" "payment-conflict" "qliro-error"
"qliro-bad-request" "qliro-validation" "qliro-order-not-found"
"translation-not-found"

Error code

message
string

Detailed error information

qliroError
object

Error if originating from Qliro

404

Not Found

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

Test server

https://checkout-qliro-adapter.test.norce.tech/api/checkout/v1/orders/{order_id}/payments/{payment_id}/remove


RESPONSE SAMPLES

 * 400
 * 401

Content type
application/json
Copy
Expand all Collapse all
{
 * "code": "cart-not-found",
 * "message": "Cart with id:{id} now found.",
 * "qliroError": {
    * "errorCode": "string",
    * "errorMessages": [
       * "string"
      
      ],
    * "correlationId": "string"
   
   }

}



QLIRO CHECKOUT CALLBACKS


VALIDATE

PATH PARAMETERS

order_id
required
string

Order identifier

payment_id
required
string

Payment identifier

QUERY PARAMETERS

merchant
required
string

Merchant identifier

channel
required
string

Merchant channel

REQUEST BODY SCHEMA: APPLICATION/JSON

Qliro order

OrderId
integer <int32>

MerchantReference
string

TotalPrice
number <double>

Currency
string

Country
string

Language
string

CustomerCheckoutStatus
string
Enum: "inProcess" "completed" "onHold" "refused"

Customer
object

BillingAddress
object

ShippingAddress
object

OrderItems
Array of objects (OrderItem)

PaymentMethod
object

SelectedShippingMethod
string

SelectedShippingSecondaryOption
string

SignupForNewsletter
boolean

AskForNewsletterSignupChecked
boolean

IdentityVerification
object

MerchantProvidedMetadata
Array of objects (MerchantProvidedMetadata)

OrderHtmlSnippet
string



RESPONSES

200

Success

400

Bad Request

RESPONSE SCHEMA: APPLICATION/JSON

declineReasonMessage
string


401

Unauthorized

RESPONSE SCHEMA: APPLICATION/JSON

code
string
Enum: "internal-server-error" "unauthorized" "configuration-error"
"configuration-not-found" "order-not-found" "order-error" "order-bad-request"
"order-conflict" "order-validation" "shipping-not-found" "shipping-error"
"payment-not-found" "payment-error" "payment-conflict" "qliro-error"
"qliro-bad-request" "qliro-validation" "qliro-order-not-found"
"translation-not-found"

Error code

message
string

Detailed error information

qliroError
object

Error if originating from Qliro

404

Not Found

RESPONSE SCHEMA: APPLICATION/JSON

code
string
Enum: "internal-server-error" "unauthorized" "configuration-error"
"configuration-not-found" "order-not-found" "order-error" "order-bad-request"
"order-conflict" "order-validation" "shipping-not-found" "shipping-error"
"payment-not-found" "payment-error" "payment-conflict" "qliro-error"
"qliro-bad-request" "qliro-validation" "qliro-order-not-found"
"translation-not-found"

Error code

message
string

Detailed error information

qliroError
object

Error if originating from Qliro

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

Test server

https://checkout-qliro-adapter.test.norce.tech/api/checkout/v1/callback/orders/{order_id}/payments/{payment_id}/validate


REQUEST SAMPLES

 * Payload

Content type
application/json
Copy
Expand all Collapse all
{
 * "OrderId": 0,
 * "MerchantReference": "string",
 * "TotalPrice": 0,
 * "Currency": "string",
 * "Country": "string",
 * "Language": "string",
 * "CustomerCheckoutStatus": "inProcess",
 * "Customer": {
    * "FirstName": "string",
    * "LastName": "string",
    * "PersonalNumber": "string",
    * "VatNumber": "string",
    * "Email": "string",
    * "MobileNumber": "string",
    * "JuridicalType": "physical",
    * "DateOfBirth": "string",
    * "Gender": 0
   
   },
 * "BillingAddress": {
    * "FirstName": "string",
    * "LastName": "string",
    * "CompanyName": "string",
    * "CareOf": "string",
    * "Street": "string",
    * "Street2": "string",
    * "PostalCode": "string",
    * "City": "string",
    * "CountryCode": "string",
    * "Area": "string",
    * "AreaCode": "string"
   
   },
 * "ShippingAddress": {
    * "FirstName": "string",
    * "LastName": "string",
    * "CompanyName": "string",
    * "CareOf": "string",
    * "Street": "string",
    * "Street2": "string",
    * "PostalCode": "string",
    * "City": "string",
    * "CountryCode": "string",
    * "Area": "string",
    * "AreaCode": "string"
   
   },
 * "OrderItems": [
    * {
       * "MerchantReference": "string",
       * "Description": "string",
       * "Type": "product",
       * "Quantity": 0,
       * "PricePerItemIncVat": 0,
       * "PricePerItemExVat": 0,
       * "PaymentTransactionId": 0
      
      }
   
   ],
 * "PaymentMethod": {
    * "PaymentMethodName": "string",
    * "PaymentTypeCode": "string"
   
   },
 * "SelectedShippingMethod": "string",
 * "SelectedShippingSecondaryOption": "string",
 * "SignupForNewsletter": true,
 * "AskForNewsletterSignupChecked": true,
 * "IdentityVerification": {
    * "RequireIdentityVerification": true,
    * "IdentityVerified": true
   
   },
 * "MerchantProvidedMetadata": [
    * {
       * "Key": "string",
       * "Value": "string"
      
      }
   
   ],
 * "OrderHtmlSnippet": "string"

}


RESPONSE SAMPLES

 * 400
 * 401
 * 404

Content type
application/json
Copy
{
 * "declineReasonMessage": "string"

}




PUSH

Called whenever a Qliro order’s CheckoutOrderStatus is changed

PATH PARAMETERS

order_id
required
string

Order identifier

payment_id
required
string

Payment identifier

QUERY PARAMETERS

merchant
required
string

Merchant identifier

channel
required
string

Merchant channel


RESPONSES

200

Success

RESPONSE SCHEMA: APPLICATION/JSON

callbackResponse
string


post/api/checkout/v1/callback/orders/{order_id}/payments/{payment_id}/push

Test server

https://checkout-qliro-adapter.test.norce.tech/api/checkout/v1/callback/orders/{order_id}/payments/{payment_id}/push


RESPONSE SAMPLES

 * 200

Content type
application/json
Copy
{
 * "callbackResponse": "string"

}


QLIRO CHECKOUT 'CLIENT-SIDE EVENTS' CALLBACKS


REFRESH CUSTOMER INFORMATION ON NORCE ORDER FROM QLIRO ORDER

Updates customer information on Norce order with latest customer information
from Qliro Checkout

AUTHORIZATIONS:

Bearer

PATH PARAMETERS

order_id
required
string

Order identifier

payment_id
required
string

Payment identifier

QUERY PARAMETERS

merchant
required
string

Merchant identifier

channel
required
string

Merchant channel


RESPONSES

200

Success

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

Test server

https://checkout-qliro-adapter.test.norce.tech/api/checkout/v1/callback/orders/{order_id}/payments/{payment_id}/customer-update


SHIPPING OPTION UPDATE. THE NORCE ORDER WILL BE UPDATED WITH THE LATEST SELECTED
DELIVERY INFORMATION FROM QLIRO

Shipping option updated notifications. Will update the Norce order with latest
shipping selection from qliro

AUTHORIZATIONS:

Bearer

PATH PARAMETERS

order_id
required
string

Order identifier

payment_id
required
string

Payment identifier

QUERY PARAMETERS

merchant
required
string

Merchant identifier

channel
required
string

Merchant channel

REQUEST BODY SCHEMA: APPLICATION/JSON

Shipping option update object

method
string

secondaryOption
string

additionalShippingServices
Array of strings

price
number <double>

Represents the price of the shipping method selected

totalShippingPrice
number <double>

Price of the shipping method selected plus any additionalServices that might
cost extra

totalShippingPriceExVat
number <double>



RESPONSES

200

Success

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

Test server

https://checkout-qliro-adapter.test.norce.tech/api/checkout/v1/callback/orders/{order_id}/payments/{payment_id}/shipping-option-update


REQUEST SAMPLES

 * Payload

Content type
application/json
Copy
Expand all Collapse all
{
 * "method": "string",
 * "secondaryOption": "string",
 * "additionalShippingServices": [
    * "string"
   
   ],
 * "price": 0,
 * "totalShippingPrice": 0,
 * "totalShippingPriceExVat": 0

}


NORCE CALLBACKS


HANDLE CART CHANGED

Cart changed.

AUTHORIZATIONS:

Bearer

PATH PARAMETERS

order_id
required
string

Order identifier

payment_id
required
string

Payment identifier

HEADER PARAMETERS

x-merchant
required
string
Example: norce

Merchant identifier.

x-channel
required
string
Example: 1

Channel identifier

REQUEST BODY SCHEMA: APPLICATION/JSON

Updated order

id
string

merchant
string

channel
string

reference
string

created
string <date-time>

lastModified
string <date-time>

state
object

culture
string

currency
string

country
string

cart
object

shippings
Array of objects (Shipping)

payments
Array of objects (Payment)

customer
object

consents
Array of objects (Consent)

hooks
Array of objects (Hook)

total
object

attributes
object



RESPONSES

200

Success

RESPONSE SCHEMA: APPLICATION/JSON

Array

op
string

path
string

value
any



404

Not Found

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

Test server

https://checkout-qliro-adapter.test.norce.tech/api/checkout/v1/callback/orders/{order_id}/payments/{payment_id}/cart-changed


REQUEST SAMPLES

 * Payload

Content type
application/json
Copy
Expand all Collapse all
{
 * "id": "string",
 * "merchant": "string",
 * "channel": "string",
 * "reference": "string",
 * "created": "2019-08-24T14:15:22Z",
 * "lastModified": "2019-08-24T14:15:22Z",
 * "state": {
    * "currentStatus": "checkout",
    * "transitions": [
       * {
          * "status": "checkout",
          * "timeStamp": "2019-08-24T14:15:22Z"
         
         }
      
      ]
   
   },
 * "culture": "string",
 * "currency": "string",
 * "country": "string",
 * "cart": {
    * "reference": "string",
    * "items": [
       * {
          * "id": "string",
          * "reference": "string",
          * "name": "string",
          * "sku": "string",
          * "url": "string",
          * "imageUrl": "string",
          * "quantity": 0,
          * "unit": "string",
          * "price": {
             * "includingVat": 0,
             * "excludingVat": 0
            
            },
          * "total": {
             * "includingVat": 0,
             * "excludingVat": 0
            
            },
          * "originalTotal": {
             * "includingVat": 0,
             * "excludingVat": 0
            
            },
          * "vatRate": 0,
          * "discounts": [
             * {
                * "type": "item",
                * "name": "string",
                * "code": "string",
                * "value": {
                   * "includingVat": 0,
                   * "excludingVat": 0
                  
                  },
                * "attributes": {
                   * "property1": null,
                   * "property2": null
                  
                  }
               
               }
            
            ],
          * "attributes": {
             * "property1": null,
             * "property2": null
            
            }
         
         }
      
      ],
    * "discounts": [
       * {
          * "type": "item",
          * "name": "string",
          * "code": "string",
          * "value": {
             * "includingVat": 0,
             * "excludingVat": 0
            
            },
          * "attributes": {
             * "property1": null,
             * "property2": null
            
            }
         
         }
      
      ],
    * "total": {
       * "includingVat": 0,
       * "excludingVat": 0
      
      },
    * "attributes": {
       * "property1": null,
       * "property2": null
      
      }
   
   },
 * "shippings": [
    * {
       * "id": "string",
       * "merchant": "string",
       * "channel": "string",
       * "state": "intent",
       * "reference": "string",
       * "tmsReference": "string",
       * "orderId": "string",
       * "adapterId": "string",
       * "name": "string",
       * "total": {
          * "includingVat": 0,
          * "excludingVat": 0
         
         },
       * "vatRate": 0,
       * "deliveryDetails": {
          * "carrier": "string",
          * "class": "string",
          * "product": {
             * "reference": "string",
             * "name": "string"
            
            },
          * "pickupLocation": {
             * "reference": "string",
             * "name": "string",
             * "address": {
                * "streetAddress": "string",
                * "city": "string",
                * "postalCode": "string",
                * "country": "string"
               
               }
            
            }
         
         },
       * "addons": [
          * {
             * "reference": "string",
             * "price": 0
            
            }
         
         ],
       * "attributes": {
          * "property1": null,
          * "property2": null
         
         }
      
      }
   
   ],
 * "payments": [
    * {
       * "id": "string",
       * "adapterId": "string",
       * "name": "string",
       * "merchant": "string",
       * "channel": "string",
       * "currency": "string",
       * "type": "default",
       * "orderId": "string",
       * "amount": 0,
       * "upperLimitAmount": 0,
       * "state": "intent",
       * "reference": "string",
       * "attributes": {
          * "property1": null,
          * "property2": null
         
         },
       * "actions": [
          * {
             * "id": "string",
             * "adapterId": "string",
             * "type": "string",
             * "url": "string"
            
            }
         
         ]
      
      }
   
   ],
 * "customer": {
    * "billing": {
       * "type": "person",
       * "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": {
          * "property1": null,
          * "property2": null
         
         }
      
      },
    * "shipping": {
       * "type": "person",
       * "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": {
          * "property1": null,
          * "property2": null
         
         }
      
      },
    * "type": "person",
    * "attributes": {
       * "property1": null,
       * "property2": null
      
      }
   
   },
 * "consents": [
    * {
       * "id": "string",
       * "checked": true,
       * "text": "string",
       * "required": true
      
      }
   
   ],
 * "hooks": [
    * {
       * "id": "string",
       * "adapterId": "string",
       * "subscribeTo": "string",
       * "target": "string",
       * "invoke": "string"
      
      }
   
   ],
 * "total": {
    * "includingVat": 0,
    * "excludingVat": 0
   
   },
 * "attributes": {
    * "property1": null,
    * "property2": null
   
   }

}


RESPONSE SAMPLES

 * 200

Content type
application/json
Copy
Expand all Collapse all
[
 * {
    * "op": "string",
    * "path": "string",
    * "value": null
   
   }

]


HANDLE STATE CHANGED

State changed.

AUTHORIZATIONS:

Bearer

PATH PARAMETERS

order_id
required
string

Order identifier

payment_id
required
string

Payment identifier

HEADER PARAMETERS

x-merchant
required
string
Example: norce

Merchant identifier.

x-channel
required
string
Example: 1

Channel identifier

REQUEST BODY SCHEMA: APPLICATION/JSON

Updated order

id
string

merchant
string

channel
string

reference
string

created
string <date-time>

lastModified
string <date-time>

state
object

culture
string

currency
string

country
string

cart
object

shippings
Array of objects (Shipping)

payments
Array of objects (Payment)

customer
object

consents
Array of objects (Consent)

hooks
Array of objects (Hook)

total
object

attributes
object



RESPONSES

200

Success

RESPONSE SCHEMA: APPLICATION/JSON

Array

op
string

path
string

value
any



400

Bad Request

404

Not Found

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

Test server

https://checkout-qliro-adapter.test.norce.tech/api/checkout/v1/callback/orders/{order_id}/payments/{payment_id}/state-changed


REQUEST SAMPLES

 * Payload

Content type
application/json
Copy
Expand all Collapse all
{
 * "id": "string",
 * "merchant": "string",
 * "channel": "string",
 * "reference": "string",
 * "created": "2019-08-24T14:15:22Z",
 * "lastModified": "2019-08-24T14:15:22Z",
 * "state": {
    * "currentStatus": "checkout",
    * "transitions": [
       * {
          * "status": "checkout",
          * "timeStamp": "2019-08-24T14:15:22Z"
         
         }
      
      ]
   
   },
 * "culture": "string",
 * "currency": "string",
 * "country": "string",
 * "cart": {
    * "reference": "string",
    * "items": [
       * {
          * "id": "string",
          * "reference": "string",
          * "name": "string",
          * "sku": "string",
          * "url": "string",
          * "imageUrl": "string",
          * "quantity": 0,
          * "unit": "string",
          * "price": {
             * "includingVat": 0,
             * "excludingVat": 0
            
            },
          * "total": {
             * "includingVat": 0,
             * "excludingVat": 0
            
            },
          * "originalTotal": {
             * "includingVat": 0,
             * "excludingVat": 0
            
            },
          * "vatRate": 0,
          * "discounts": [
             * {
                * "type": "item",
                * "name": "string",
                * "code": "string",
                * "value": {
                   * "includingVat": 0,
                   * "excludingVat": 0
                  
                  },
                * "attributes": {
                   * "property1": null,
                   * "property2": null
                  
                  }
               
               }
            
            ],
          * "attributes": {
             * "property1": null,
             * "property2": null
            
            }
         
         }
      
      ],
    * "discounts": [
       * {
          * "type": "item",
          * "name": "string",
          * "code": "string",
          * "value": {
             * "includingVat": 0,
             * "excludingVat": 0
            
            },
          * "attributes": {
             * "property1": null,
             * "property2": null
            
            }
         
         }
      
      ],
    * "total": {
       * "includingVat": 0,
       * "excludingVat": 0
      
      },
    * "attributes": {
       * "property1": null,
       * "property2": null
      
      }
   
   },
 * "shippings": [
    * {
       * "id": "string",
       * "merchant": "string",
       * "channel": "string",
       * "state": "intent",
       * "reference": "string",
       * "tmsReference": "string",
       * "orderId": "string",
       * "adapterId": "string",
       * "name": "string",
       * "total": {
          * "includingVat": 0,
          * "excludingVat": 0
         
         },
       * "vatRate": 0,
       * "deliveryDetails": {
          * "carrier": "string",
          * "class": "string",
          * "product": {
             * "reference": "string",
             * "name": "string"
            
            },
          * "pickupLocation": {
             * "reference": "string",
             * "name": "string",
             * "address": {
                * "streetAddress": "string",
                * "city": "string",
                * "postalCode": "string",
                * "country": "string"
               
               }
            
            }
         
         },
       * "addons": [
          * {
             * "reference": "string",
             * "price": 0
            
            }
         
         ],
       * "attributes": {
          * "property1": null,
          * "property2": null
         
         }
      
      }
   
   ],
 * "payments": [
    * {
       * "id": "string",
       * "adapterId": "string",
       * "name": "string",
       * "merchant": "string",
       * "channel": "string",
       * "currency": "string",
       * "type": "default",
       * "orderId": "string",
       * "amount": 0,
       * "upperLimitAmount": 0,
       * "state": "intent",
       * "reference": "string",
       * "attributes": {
          * "property1": null,
          * "property2": null
         
         },
       * "actions": [
          * {
             * "id": "string",
             * "adapterId": "string",
             * "type": "string",
             * "url": "string"
            
            }
         
         ]
      
      }
   
   ],
 * "customer": {
    * "billing": {
       * "type": "person",
       * "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": {
          * "property1": null,
          * "property2": null
         
         }
      
      },
    * "shipping": {
       * "type": "person",
       * "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": {
          * "property1": null,
          * "property2": null
         
         }
      
      },
    * "type": "person",
    * "attributes": {
       * "property1": null,
       * "property2": null
      
      }
   
   },
 * "consents": [
    * {
       * "id": "string",
       * "checked": true,
       * "text": "string",
       * "required": true
      
      }
   
   ],
 * "hooks": [
    * {
       * "id": "string",
       * "adapterId": "string",
       * "subscribeTo": "string",
       * "target": "string",
       * "invoke": "string"
      
      }
   
   ],
 * "total": {
    * "includingVat": 0,
    * "excludingVat": 0
   
   },
 * "attributes": {
    * "property1": null,
    * "property2": null
   
   }

}


RESPONSE SAMPLES

 * 200

Content type
application/json
Copy
Expand all Collapse all
[
 * {
    * "op": "string",
    * "path": "string",
    * "value": null
   
   }

]


ORDER MANAGEMENT


REFRESH THE LIST OF AVAILABLE PAYMENTACTIONS FOR AN ORDER

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

AUTHORIZATIONS:

Bearer

PATH PARAMETERS

order_id
required
string

payment_id
required
string


HEADER PARAMETERS

x-merchant
required
string
Example: norce

Merchant identifier.

x-channel
required
string
Example: 1

Channel identifier


RESPONSES

200

Success

400

Bad Request

404

Not Found

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

Test server

https://checkout-qliro-adapter.test.norce.tech/api/order/v1/orders/{order_id}/payments/{payment_id}/refresh


CANCEL QLIRO ORDER

Used to cancel a Qliro order

AUTHORIZATIONS:

Bearer

PATH PARAMETERS

order_id
required
string

payment_id
required
string


HEADER PARAMETERS

x-merchant
required
string
Example: norce

Merchant identifier.

x-channel
required
string
Example: 1

Channel identifier


RESPONSES

200

Success

RESPONSE SCHEMA: APPLICATION/JSON

paymentId
string

Norce Payment Id

htmlSnippet
string

Qliro checkout order html snippet.

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

Test server

https://checkout-qliro-adapter.test.norce.tech/api/order/v1/orders/{order_id}/payments/{payment_id}/cancel


RESPONSE SAMPLES

 * 200

Content type
application/json
Copy
{
 * "paymentId": "string",
 * "htmlSnippet": ""

}


CAPTURE QLIRO ORDER

Used to capture a Qliro order

AUTHORIZATIONS:

Bearer

PATH PARAMETERS

order_id
required
string

Order identifier

payment_id
required
string

Payment identifier

HEADER PARAMETERS

x-merchant
required
string
Example: norce

Merchant identifier.

x-channel
required
string
Example: 1

Channel identifier


RESPONSES

200

Success

RESPONSE SCHEMA: APPLICATION/JSON

paymentId
string

Norce Payment Id

htmlSnippet
string

Qliro checkout order html snippet.

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

Test server

https://checkout-qliro-adapter.test.norce.tech/api/order/v1/orders/{order_id}/payments/{payment_id}/capture


RESPONSE SAMPLES

 * 200

Content type
application/json
Copy
{
 * "paymentId": "string",
 * "htmlSnippet": ""

}


REFUND QLIRO ORDER

Used to refund a Qliro order

AUTHORIZATIONS:

Bearer

PATH PARAMETERS

order_id
required
string

Order identifier

payment_id
required
string

Payment identifier

HEADER PARAMETERS

x-merchant
required
string
Example: norce

Merchant identifier.

x-channel
required
string
Example: 1

Channel identifier


RESPONSES

200

Success

RESPONSE SCHEMA: APPLICATION/JSON

paymentId
string

Norce Payment Id

htmlSnippet
string

Qliro checkout order html snippet.

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

Test server

https://checkout-qliro-adapter.test.norce.tech/api/order/v1/orders/{order_id}/payments/{payment_id}/refund


RESPONSE SAMPLES

 * 200

Content type
application/json
Copy
{
 * "paymentId": "string",
 * "htmlSnippet": ""

}
checkout-qliro-adapter-env.ci.jetshopcloud.io Open in urlscan Pro 20.76.203.228 Public Scan

Form analysis 0 forms found in the DOM

Text Content

checkout-qliro-adapter-env.ci.jetshopcloud.io Open in urlscan Pro
20.76.203.228 Public Scan

Form analysis
0 forms found in the DOM
