checkout-resursbank-adapter-fixslnpath.ci.jetshopcloud.io Open in urlscan Pro
20.76.203.228  Public Scan

Submitted URL: https://checkout-resursbank-adapter-fixslnpath.ci.jetshopcloud.io/
Effective URL: https://checkout-resursbank-adapter-fixslnpath.ci.jetshopcloud.io/api-docs/index.html
Submission: On February 15 via automatic, source certstream-suspicious — Scanned from NL

Form analysis 0 forms found in the DOM

Text Content

 * Payments
   * postCreate a new Resurs Bank Checkout order
   * getGet an existing Resurs Bank Checkout order
   * postRemove a Resurs Bank Checkout order
 * Resurs Bank Checkout Callbacks
   * postValidate
   * postPush
 * Resurs Bank Checkout 'Client-side events' Callbacks
   * postRefresh customer information on Norce order from Resurs Bank order
   * postShipping option update. The Norce order will be updated with the latest
     selected delivery information from Resurs Bank
 * Norce Callbacks
   * postHandle Cart changed
   * postHandle State changed

API docs by Redocly





NORCE CHECKOUT - RESURS BANK CHECKOUT ADAPTER API (1.0.0)

Download OpenAPI specification:Download




Build 2024-02-15 15:12:26

The Resurs Bank Checkout Adapter API is used to create and manage a ResursBank
Checkout Order.


PAYMENTS


CREATE A NEW RESURS BANK 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

ResursBank 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" "resursbank-error"
"resursbank-bad-request" "resursbank-validation" "resursbank-order-not-found"
"translation-not-found"

Error code

message
string

Detailed error information

resursBankError
object

Error if originating from Resurs Bank

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" "resursbank-error"
"resursbank-bad-request" "resursbank-validation" "resursbank-order-not-found"
"translation-not-found"

Error code

message
string

Detailed error information

resursBankError
object

Error if originating from Resurs Bank

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

Test server

https://checkout-resursBank-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 RESURS BANK CHECKOUT ORDER

Used to get the html snippet, for example after the Resurs Bank 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

ResursBank checkout order html snippet.

404

Not Found

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

Test server

https://checkout-resursBank-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 RESURS BANK 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 Resurs Bank 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" "resursbank-error"
"resursbank-bad-request" "resursbank-validation" "resursbank-order-not-found"
"translation-not-found"

Error code

message
string

Detailed error information

resursBankError
object

Error if originating from Resurs Bank

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" "resursbank-error"
"resursbank-bad-request" "resursbank-validation" "resursbank-order-not-found"
"translation-not-found"

Error code

message
string

Detailed error information

resursBankError
object

Error if originating from Resurs Bank

404

Not Found

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

Test server

https://checkout-resursBank-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.",
 * "resursBankError": {
    * "errorCode": "string",
    * "errorMessages": [
       * "string"
      
      ],
    * "correlationId": "string"
   
   }

}



RESURS BANK 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


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" "resursbank-error"
"resursbank-bad-request" "resursbank-validation" "resursbank-order-not-found"
"translation-not-found"

Error code

message
string

Detailed error information

resursBankError
object

Error if originating from Resurs Bank

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" "resursbank-error"
"resursbank-bad-request" "resursbank-validation" "resursbank-order-not-found"
"translation-not-found"

Error code

message
string

Detailed error information

resursBankError
object

Error if originating from Resurs Bank

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

Test server

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


RESPONSE SAMPLES

 * 400
 * 401
 * 404

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

}




PUSH

Called whenever a Resurs Bank 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-resursBank-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"

}


RESURS BANK CHECKOUT 'CLIENT-SIDE EVENTS' CALLBACKS


REFRESH CUSTOMER INFORMATION ON NORCE ORDER FROM RESURS BANK ORDER

Updates customer information on Norce order with latest customer information
from Resurs Bank 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-resursBank-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 RESURS BANK

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

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}/shipping-option-update

Test server

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


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-resursBank-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
         
         }
      
      }
   
   ],
 * "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-resursBank-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
         
         }
      
      }
   
   ],
 * "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
   
   }

]