checkout-adyen-adapter-ord1260customer.ci.jetshopcloud.io
Open in
urlscan Pro
20.76.203.228
Public Scan
Submitted URL: https://checkout-adyen-adapter-ord1260customer.ci.jetshopcloud.io/
Effective URL: https://checkout-adyen-adapter-ord1260customer.ci.jetshopcloud.io/docs/v1/index.html
Submission: On April 10 via automatic, source certstream-suspicious — Scanned from NL
Effective URL: https://checkout-adyen-adapter-ord1260customer.ci.jetshopcloud.io/docs/v1/index.html
Submission: On April 10 via automatic, source certstream-suspicious — Scanned from NL
Form analysis 0 forms found in the DOM
Text Content
* Payments
* postCreate a new Adyen Checkout order
* getGet an existing Adyen Checkout order
* postStart a transaction
* postSubmit additional payment details to complete the Adyen Checkout
payment.
* postRemove a Adyen Checkout order
* Adyen Checkout Callbacks
* postValidate
* Adyen Checkout Webhook endpoint
* postWebhook/Notification
* Norce Callbacks
* postHandle shipping changed.
* postHandle Cart changed
* postHandle State changed
API docs by Redocly
NORCE CHECKOUT - ADYEN CHECKOUT ADAPTER API (1.0.0)
Download OpenAPI specification:Download
Build 2024-04-10 09:52:20
The Adyen Checkout Adapter API is used to create and manage a Adyen Checkout
Order.
PAYMENTS
CREATE A NEW ADYEN 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
clientKey
string
locale
string
environment
string
Enum: "test" "live"
amount
object
paymentMethodsResponse
object
paymentMethodsConfiguration
any
400
Bad Request
RESPONSE SCHEMA: APPLICATION/JSON
code
string
Enum: "internal-server-error" "unauthorized" "conflict" "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" "adyen-error"
"adyen-bad-request" "adyen-validation" "adyen-order-not-found"
"translation-not-found"
Error code
message
string
Detailed error information
adyenError
object
Error if originating from Adyen
404
Not Found
RESPONSE SCHEMA: APPLICATION/JSON
type
string
title
string
status
integer <int32>
detail
string
instance
string
property name*
additional property
any
409
Conflict
RESPONSE SCHEMA: APPLICATION/JSON
code
string
Enum: "internal-server-error" "unauthorized" "conflict" "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" "adyen-error"
"adyen-bad-request" "adyen-validation" "adyen-order-not-found"
"translation-not-found"
Error code
message
string
Detailed error information
adyenError
object
Error if originating from Adyen
post/api/checkout/v1/orders/{order_id}/payments
https://checkout-adyen-adapter-ord1260customer.ci.jetshopcloud.io/api/checkout/v1/orders/{order_id}/payments
RESPONSE SAMPLES
* 200
* 400
* 404
* 409
Content type
application/json
Copy
Expand all Collapse all
{
* "paymentId": "string",
* "clientKey": "string",
* "locale": "string",
* "environment": "test",
* "amount": {
* "currency": "string",
* "value": 0
},
* "paymentMethodsResponse": {
* "paymentMethods": [
* {
* "fundingSource": "credit",
* "brand": "string",
* "brands": [
* "string"
],
* "_Configuration": {
* "property1": "string",
* "property2": "string"
},
* "group": {
* "name": "string",
* "paymentMethodData": "string",
* "type": "string"
},
* "inputDetails": [
* {
* "_Configuration": {
* "property1": "string",
* "property2": "string"
},
* "details": [
* {
* "_Configuration": {
* "property1": "string",
* "property2": "string"
},
* "items": [
* {
* "id": null,
* "name": null
}
],
* "key": "string",
* "optional": true,
* "type": "string",
* "value": "string"
}
],
* "inputDetails": [
* {
* "_Configuration": {
* "property1": "string",
* "property2": "string"
},
* "items": [
* {
* "id": null,
* "name": null
}
],
* "key": "string",
* "optional": true,
* "type": "string",
* "value": "string"
}
],
* "itemSearchUrl": "string",
* "items": [
* {
* "id": "string",
* "name": "string"
}
],
* "key": "string",
* "optional": true,
* "type": "string",
* "value": "string"
}
],
* "issuers": [
* {
* "disabled": true,
* "id": "string",
* "name": "string"
}
],
* "name": "string",
* "type": "string"
}
],
* "storedPaymentMethods": [
* {
* "bankAccountNumber": "string",
* "bankLocationId": "string",
* "brand": "string",
* "expiryMonth": "string",
* "expiryYear": "string",
* "holderName": "string",
* "iban": "string",
* "id": "string",
* "label": "string",
* "lastFour": "string",
* "name": "string",
* "networkTxReference": "string",
* "ownerName": "string",
* "shopperEmail": "string",
* "supportedRecurringProcessingModels": [
* "string"
],
* "supportedShopperInteractions": [
* "string"
],
* "type": "string"
}
]
},
* "paymentMethodsConfiguration": null
}
GET AN EXISTING ADYEN CHECKOUT ORDER
Used to get an existing Adyen Checkout Order with payment methods.
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
clientKey
string
locale
string
environment
string
Enum: "test" "live"
amount
object
paymentMethodsResponse
object
paymentMethodsConfiguration
any
404
Not Found
RESPONSE SCHEMA: APPLICATION/JSON
type
string
title
string
status
integer <int32>
detail
string
instance
string
property name*
additional property
any
get/api/checkout/v1/orders/{order_id}/payments/{payment_id}
https://checkout-adyen-adapter-ord1260customer.ci.jetshopcloud.io/api/checkout/v1/orders/{order_id}/payments/{payment_id}
RESPONSE SAMPLES
* 200
* 404
Content type
application/json
Copy
Expand all Collapse all
{
* "paymentId": "string",
* "clientKey": "string",
* "locale": "string",
* "environment": "test",
* "amount": {
* "currency": "string",
* "value": 0
},
* "paymentMethodsResponse": {
* "paymentMethods": [
* {
* "fundingSource": "credit",
* "brand": "string",
* "brands": [
* "string"
],
* "_Configuration": {
* "property1": "string",
* "property2": "string"
},
* "group": {
* "name": "string",
* "paymentMethodData": "string",
* "type": "string"
},
* "inputDetails": [
* {
* "_Configuration": {
* "property1": "string",
* "property2": "string"
},
* "details": [
* {
* "_Configuration": {
* "property1": "string",
* "property2": "string"
},
* "items": [
* {
* "id": null,
* "name": null
}
],
* "key": "string",
* "optional": true,
* "type": "string",
* "value": "string"
}
],
* "inputDetails": [
* {
* "_Configuration": {
* "property1": "string",
* "property2": "string"
},
* "items": [
* {
* "id": null,
* "name": null
}
],
* "key": "string",
* "optional": true,
* "type": "string",
* "value": "string"
}
],
* "itemSearchUrl": "string",
* "items": [
* {
* "id": "string",
* "name": "string"
}
],
* "key": "string",
* "optional": true,
* "type": "string",
* "value": "string"
}
],
* "issuers": [
* {
* "disabled": true,
* "id": "string",
* "name": "string"
}
],
* "name": "string",
* "type": "string"
}
],
* "storedPaymentMethods": [
* {
* "bankAccountNumber": "string",
* "bankLocationId": "string",
* "brand": "string",
* "expiryMonth": "string",
* "expiryYear": "string",
* "holderName": "string",
* "iban": "string",
* "id": "string",
* "label": "string",
* "lastFour": "string",
* "name": "string",
* "networkTxReference": "string",
* "ownerName": "string",
* "shopperEmail": "string",
* "supportedRecurringProcessingModels": [
* "string"
],
* "supportedShopperInteractions": [
* "string"
],
* "type": "string"
}
]
},
* "paymentMethodsConfiguration": null
}
START A TRANSACTION
Sends payment parameters (like amount, country, and currency) together with
other required input details collected from the shopper.
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
Transaction data from Adyen front-end
any
RESPONSES
200
Success
RESPONSE SCHEMA: APPLICATION/JSON
resultCode
string
Enum: "authenticationFinished" "authenticationNotRequired" "authorised"
"cancelled" "challengeShopper" "error" "identifyShopper" "partiallyAuthorised"
"pending" "presentToShopper" "received" "redirectShopper" "refused" "success"
action
object
additionalData
object
amount
object
donationToken
string
fraudResult
object
merchantReference
string
order
object
paymentMethod
object
pspReference
string
refusalReason
string
refusalReasonCode
string
threeDS2ResponseData
object
threeDS2Result
object
threeDSPaymentData
string
400
Bad Request
RESPONSE SCHEMA: APPLICATION/JSON
Array
code
string
adapterId
string
404
Not Found
RESPONSE SCHEMA: APPLICATION/JSON
type
string
title
string
status
integer <int32>
detail
string
instance
string
property name*
additional property
any
post/api/checkout/v1/orders/{order_id}/payments/{payment_id}/transaction
https://checkout-adyen-adapter-ord1260customer.ci.jetshopcloud.io/api/checkout/v1/orders/{order_id}/payments/{payment_id}/transaction
REQUEST SAMPLES
* Payload
Content type
application/json
Copy
null
RESPONSE SAMPLES
* 200
* 400
* 404
Content type
application/json
Copy
Expand all Collapse all
{
* "resultCode": "authenticationFinished",
* "action": {
* "isNullable": true,
* "schemaType": "string",
* "actualInstance": null
},
* "additionalData": {
* "property1": "string",
* "property2": "string"
},
* "amount": {
* "currency": "string",
* "value": 0
},
* "donationToken": "string",
* "fraudResult": {
* "accountScore": 0,
* "results": [
* {
* "accountScore": 0,
* "checkId": 0,
* "name": "string"
}
]
},
* "merchantReference": "string",
* "order": {
* "amount": {
* "currency": "string",
* "value": 0
},
* "expiresAt": "string",
* "orderData": "string",
* "pspReference": "string",
* "reference": "string",
* "remainingAmount": {
* "currency": "string",
* "value": 0
}
},
* "paymentMethod": {
* "brand": "string",
* "type": "string"
},
* "pspReference": "string",
* "refusalReason": "string",
* "refusalReasonCode": "string",
* "threeDS2ResponseData": {
* "acsChallengeMandated": "string",
* "acsOperatorID": "string",
* "acsReferenceNumber": "string",
* "acsSignedContent": "string",
* "acsTransID": "string",
* "acsURL": "string",
* "authenticationType": "string",
* "cardHolderInfo": "string",
* "cavvAlgorithm": "string",
* "challengeIndicator": "string",
* "dsReferenceNumber": "string",
* "dsTransID": "string",
* "exemptionIndicator": "string",
* "messageVersion": "string",
* "riskScore": "string",
* "sdkEphemPubKey": "string",
* "threeDSServerTransID": "string",
* "transStatus": "string",
* "transStatusReason": "string"
},
* "threeDS2Result": {
* "challengeCancel": "_01",
* "exemptionIndicator": "lowValue",
* "threeDSRequestorChallengeInd": "_01",
* "authenticationValue": "string",
* "cavvAlgorithm": "string",
* "dsTransID": "string",
* "eci": "string",
* "messageVersion": "string",
* "riskScore": "string",
* "threeDSServerTransID": "string",
* "timestamp": "string",
* "transStatus": "string",
* "transStatusReason": "string",
* "whiteListStatus": "string"
},
* "threeDSPaymentData": "string"
}
SUBMIT ADDITIONAL PAYMENT DETAILS TO COMPLETE THE ADYEN CHECKOUT PAYMENT.
Submit additional payment details to complete the Adyen Checkout payment.
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
Additional Adyen payment details
any
RESPONSES
200
Success
RESPONSE SCHEMA: APPLICATION/JSON
resultCode
string
Enum: "authenticationFinished" "authenticationNotRequired" "authorised"
"cancelled" "challengeShopper" "error" "identifyShopper" "partiallyAuthorised"
"pending" "presentToShopper" "received" "redirectShopper" "refused" "success"
additionalData
object
amount
object
donationToken
string
fraudResult
object
merchantReference
string
order
object
paymentMethod
object
pspReference
string
refusalReason
string
refusalReasonCode
string
shopperLocale
string
threeDS2ResponseData
object
threeDS2Result
object
threeDSPaymentData
string
400
Bad Request
RESPONSE SCHEMA: APPLICATION/JSON
type
string
title
string
status
integer <int32>
detail
string
instance
string
property name*
additional property
any
404
Not Found
RESPONSE SCHEMA: APPLICATION/JSON
type
string
title
string
status
integer <int32>
detail
string
instance
string
property name*
additional property
any
post/api/checkout/v1/orders/{order_id}/payments/{payment_id}/details
https://checkout-adyen-adapter-ord1260customer.ci.jetshopcloud.io/api/checkout/v1/orders/{order_id}/payments/{payment_id}/details
REQUEST SAMPLES
* Payload
Content type
application/json
Copy
null
RESPONSE SAMPLES
* 200
* 400
* 404
Content type
application/json
Copy
Expand all Collapse all
{
* "resultCode": "authenticationFinished",
* "additionalData": {
* "property1": "string",
* "property2": "string"
},
* "amount": {
* "currency": "string",
* "value": 0
},
* "donationToken": "string",
* "fraudResult": {
* "accountScore": 0,
* "results": [
* {
* "accountScore": 0,
* "checkId": 0,
* "name": "string"
}
]
},
* "merchantReference": "string",
* "order": {
* "amount": {
* "currency": "string",
* "value": 0
},
* "expiresAt": "string",
* "orderData": "string",
* "pspReference": "string",
* "reference": "string",
* "remainingAmount": {
* "currency": "string",
* "value": 0
}
},
* "paymentMethod": {
* "brand": "string",
* "type": "string"
},
* "pspReference": "string",
* "refusalReason": "string",
* "refusalReasonCode": "string",
* "shopperLocale": "string",
* "threeDS2ResponseData": {
* "acsChallengeMandated": "string",
* "acsOperatorID": "string",
* "acsReferenceNumber": "string",
* "acsSignedContent": "string",
* "acsTransID": "string",
* "acsURL": "string",
* "authenticationType": "string",
* "cardHolderInfo": "string",
* "cavvAlgorithm": "string",
* "challengeIndicator": "string",
* "dsReferenceNumber": "string",
* "dsTransID": "string",
* "exemptionIndicator": "string",
* "messageVersion": "string",
* "riskScore": "string",
* "sdkEphemPubKey": "string",
* "threeDSServerTransID": "string",
* "transStatus": "string",
* "transStatusReason": "string"
},
* "threeDS2Result": {
* "challengeCancel": "_01",
* "exemptionIndicator": "lowValue",
* "threeDSRequestorChallengeInd": "_01",
* "authenticationValue": "string",
* "cavvAlgorithm": "string",
* "dsTransID": "string",
* "eci": "string",
* "messageVersion": "string",
* "riskScore": "string",
* "threeDSServerTransID": "string",
* "timestamp": "string",
* "transStatus": "string",
* "transStatusReason": "string",
* "whiteListStatus": "string"
},
* "threeDSPaymentData": "string"
}
REMOVE A ADYEN 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 Adyen 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" "conflict" "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" "adyen-error"
"adyen-bad-request" "adyen-validation" "adyen-order-not-found"
"translation-not-found"
Error code
message
string
Detailed error information
adyenError
object
Error if originating from Adyen
401
Unauthorized
RESPONSE SCHEMA: APPLICATION/JSON
code
string
Enum: "internal-server-error" "unauthorized" "conflict" "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" "adyen-error"
"adyen-bad-request" "adyen-validation" "adyen-order-not-found"
"translation-not-found"
Error code
message
string
Detailed error information
adyenError
object
Error if originating from Adyen
404
Not Found
RESPONSE SCHEMA: APPLICATION/JSON
type
string
title
string
status
integer <int32>
detail
string
instance
string
property name*
additional property
any
post/api/checkout/v1/orders/{order_id}/payments/{payment_id}/remove
https://checkout-adyen-adapter-ord1260customer.ci.jetshopcloud.io/api/checkout/v1/orders/{order_id}/payments/{payment_id}/remove
RESPONSE SAMPLES
* 400
* 401
* 404
Content type
application/json
Copy
Expand all Collapse all
{
* "code": "cart-not-found",
* "message": "Cart with id:{id} now found.",
* "adyenError": {
* "errorCode": "string",
* "errorMessages": [
* "string"
],
* "correlationId": "string"
}
}
ADYEN 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
Adyen order
any
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" "conflict" "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" "adyen-error"
"adyen-bad-request" "adyen-validation" "adyen-order-not-found"
"translation-not-found"
Error code
message
string
Detailed error information
adyenError
object
Error if originating from Adyen
404
Not Found
RESPONSE SCHEMA: APPLICATION/JSON
code
string
Enum: "internal-server-error" "unauthorized" "conflict" "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" "adyen-error"
"adyen-bad-request" "adyen-validation" "adyen-order-not-found"
"translation-not-found"
Error code
message
string
Detailed error information
adyenError
object
Error if originating from Adyen
post/api/checkout/v1/callback/orders/{order_id}/payments/{payment_id}/validate
https://checkout-adyen-adapter-ord1260customer.ci.jetshopcloud.io/api/checkout/v1/callback/orders/{order_id}/payments/{payment_id}/validate
REQUEST SAMPLES
* Payload
Content type
application/json
Copy
null
RESPONSE SAMPLES
* 400
* 401
* 404
Content type
application/json
Copy
{
* "declineReasonMessage": "string"
}
ADYEN CHECKOUT WEBHOOK ENDPOINT
WEBHOOK/NOTIFICATION
Called by Adyen to react on webhooks
QUERY PARAMETERS
merchant
required
string
Merchant identifier
channel
required
string
Merchant channel
REQUEST BODY SCHEMA: APPLICATION/JSON
Adyen notification JSON data
any
RESPONSES
200
Success
RESPONSE SCHEMA: APPLICATION/JSON
string
post/api/checkout/v1/callback/orders/webhook
https://checkout-adyen-adapter-ord1260customer.ci.jetshopcloud.io/api/checkout/v1/callback/orders/webhook
REQUEST SAMPLES
* Payload
Content type
application/json
Copy
null
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
"string"
NORCE CALLBACKS
HANDLE SHIPPING CHANGED.
Shipping 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 Norce 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 (Norce.Checkout.AdyenAdapter.Application.Order.Shipping)
payments
Array of objects (Norce.Checkout.AdyenAdapter.Application.Order.Payment)
customer
object
consents
Array of objects (Norce.Checkout.AdyenAdapter.Application.Order.Consent)
hooks
Array of objects (Norce.Checkout.AdyenAdapter.Application.Order.Hook)
total
object
attributes
object
RESPONSES
200
Success
RESPONSE SCHEMA: APPLICATION/JSON
Array
op
string
path
string
value
any
post/api/checkout/v1/callback/orders/{order_id}/payments/{payment_id}/shipping-changed
https://checkout-adyen-adapter-ord1260customer.ci.jetshopcloud.io/api/checkout/v1/callback/orders/{order_id}/payments/{payment_id}/shipping-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 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 Norce 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 (Norce.Checkout.AdyenAdapter.Application.Order.Shipping)
payments
Array of objects (Norce.Checkout.AdyenAdapter.Application.Order.Payment)
customer
object
consents
Array of objects (Norce.Checkout.AdyenAdapter.Application.Order.Consent)
hooks
Array of objects (Norce.Checkout.AdyenAdapter.Application.Order.Hook)
total
object
attributes
object
RESPONSES
200
Success
RESPONSE SCHEMA: APPLICATION/JSON
Array
op
string
path
string
value
any
404
Not Found
RESPONSE SCHEMA: APPLICATION/JSON
type
string
title
string
status
integer <int32>
detail
string
instance
string
property name*
additional property
any
post/api/checkout/v1/callback/orders/{order_id}/payments/{payment_id}/cart-changed
https://checkout-adyen-adapter-ord1260customer.ci.jetshopcloud.io/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
* 404
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 (Norce.Checkout.AdyenAdapter.Application.Order.Shipping)
payments
Array of objects (Norce.Checkout.AdyenAdapter.Application.Order.Payment)
customer
object
consents
Array of objects (Norce.Checkout.AdyenAdapter.Application.Order.Consent)
hooks
Array of objects (Norce.Checkout.AdyenAdapter.Application.Order.Hook)
total
object
attributes
object
RESPONSES
200
Success
RESPONSE SCHEMA: APPLICATION/JSON
Array
op
string
path
string
value
any
400
Bad Request
RESPONSE SCHEMA: APPLICATION/JSON
type
string
title
string
status
integer <int32>
detail
string
instance
string
property name*
additional property
any
404
Not Found
RESPONSE SCHEMA: APPLICATION/JSON
type
string
title
string
status
integer <int32>
detail
string
instance
string
property name*
additional property
any
post/api/checkout/v1/callback/orders/{order_id}/payments/{payment_id}/state-changed
https://checkout-adyen-adapter-ord1260customer.ci.jetshopcloud.io/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
* 400
* 404
Content type
application/json
Copy
Expand all Collapse all
[
* {
* "op": "string",
* "path": "string",
* "value": null
}
]