Norce Checkout - Adyen Checkout Adapter API (1.0.0)

Build 2026-01-12 14:01:28

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

Download OpenAPI description
Languages
Servers

https://docs.norce.io/

Schemas

Payments

Operations

Adyen Checkout Callbacks

Operations

Adyen Checkout Webhook endpoint

Operations

Norce Callbacks

Operations

Update payment

Request

Hook on changes to update payment.

Path
order_idstringrequired

Order identifier

payment_idstringrequired

Payment identifier

Headers
x-merchantstringrequired

Merchant identifier.

Example: norce
x-channelstringrequired

Channel identifier

Example: 1
Body

Updated order

idstring
merchantstring
channelstring
referencestring
createdstring(date-time)
lastModifiedstring(date-time)
stateobject
culturestring
currencystring
countrystring
cartobject
shippingsArray of objects(Norce.Checkout.AdyenAdapter.Application.Order.Shipping)
paymentsArray of objects(Norce.Checkout.AdyenAdapter.Application.Order.Payment)
customerobject
consentsArray of objects(Norce.Checkout.AdyenAdapter.Application.Order.Consent)
hooksArray of objects(Norce.Checkout.AdyenAdapter.Application.Order.Hook)
totalobject
attributesobject
curl -i -X POST \
  'https://docs.norce.io/api/checkout/v1/callback/orders/{order_id}/payments/{payment_id}/update-payment' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json-patch+json' \
  -H 'x-channel: 1' \
  -H 'x-merchant: norce' \
  -d '{
    "id": "string",
    "merchant": "string",
    "channel": "string",
    "reference": "string",
    "created": "2019-08-24T14:15:22Z",
    "lastModified": "2019-08-24T14:15:22Z",
    "state": {
      "currentStatus": 0,
      "transitions": [
        {
          "status": 0,
          "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.1,
            "excludingVat": 0.1
          },
          "total": {
            "includingVat": 0.1,
            "excludingVat": 0.1
          },
          "originalTotal": {
            "includingVat": 0.1,
            "excludingVat": 0.1
          },
          "vatRate": 0.1,
          "discounts": [
            {
              "type": 0,
              "name": "string",
              "code": "string",
              "value": {
                "includingVat": 0.1,
                "excludingVat": 0.1
              },
              "attributes": {
                "property1": null,
                "property2": null
              }
            }
          ],
          "attributes": {
            "property1": null,
            "property2": null
          }
        }
      ],
      "discounts": [
        {
          "type": 0,
          "name": "string",
          "code": "string",
          "value": {
            "includingVat": 0.1,
            "excludingVat": 0.1
          },
          "attributes": {
            "property1": null,
            "property2": null
          }
        }
      ],
      "total": {
        "includingVat": 0.1,
        "excludingVat": 0.1
      },
      "attributes": {
        "property1": null,
        "property2": null
      }
    },
    "shippings": [
      {
        "id": "string",
        "merchant": "string",
        "channel": "string",
        "state": 0,
        "reference": "string",
        "tmsReference": "string",
        "orderId": "string",
        "adapterId": "string",
        "name": "string",
        "total": {
          "includingVat": 0.1,
          "excludingVat": 0.1
        },
        "vatRate": 0.1,
        "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.1
          }
        ],
        "attributes": {
          "property1": null,
          "property2": null
        }
      }
    ],
    "payments": [
      {
        "id": "string",
        "adapterId": "string",
        "name": "string",
        "merchant": "string",
        "channel": "string",
        "currency": "string",
        "type": 0,
        "orderId": "string",
        "amount": 0.1,
        "upperLimitAmount": 0.1,
        "state": 0,
        "reference": "string",
        "attributes": {
          "property1": null,
          "property2": null
        },
        "recurring": {
          "token": "string",
          "description": "string",
          "attributes": {
            "property1": null,
            "property2": null
          }
        }
      }
    ],
    "customer": {
      "billing": {
        "type": 0,
        "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": 0,
        "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": 0,
      "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.1,
      "excludingVat": 0.1
    },
    "attributes": {
      "property1": null,
      "property2": null
    }
  }'

Responses

OK

Bodyapplication/jsonArray [
operationstring
pathstring
valueany
]
Response
application/json
[ { "operation": "string", "path": "string", "value": null } ]

Handle state updated. If the state transitions back to checkout from processing, any ongoing adyen transaction will be cancelled.

Request

Hook on state changes to cancel ongoing Adyen transactions.

Path
order_idstringrequired

Order identifier

payment_idstringrequired

Payment identifier

Headers
x-merchantstringrequired

Merchant identifier.

Example: norce
x-channelstringrequired

Channel identifier

Example: 1
Body

Updated order

idstring
merchantstring
channelstring
referencestring
createdstring(date-time)
lastModifiedstring(date-time)
stateobject
culturestring
currencystring
countrystring
cartobject
shippingsArray of objects(Norce.Checkout.AdyenAdapter.Application.Order.Shipping)
paymentsArray of objects(Norce.Checkout.AdyenAdapter.Application.Order.Payment)
customerobject
consentsArray of objects(Norce.Checkout.AdyenAdapter.Application.Order.Consent)
hooksArray of objects(Norce.Checkout.AdyenAdapter.Application.Order.Hook)
totalobject
attributesobject
curl -i -X POST \
  'https://docs.norce.io/api/checkout/v1/callback/orders/{order_id}/payments/{payment_id}/state-updated' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json-patch+json' \
  -H 'x-channel: 1' \
  -H 'x-merchant: norce' \
  -d '{
    "id": "string",
    "merchant": "string",
    "channel": "string",
    "reference": "string",
    "created": "2019-08-24T14:15:22Z",
    "lastModified": "2019-08-24T14:15:22Z",
    "state": {
      "currentStatus": 0,
      "transitions": [
        {
          "status": 0,
          "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.1,
            "excludingVat": 0.1
          },
          "total": {
            "includingVat": 0.1,
            "excludingVat": 0.1
          },
          "originalTotal": {
            "includingVat": 0.1,
            "excludingVat": 0.1
          },
          "vatRate": 0.1,
          "discounts": [
            {
              "type": 0,
              "name": "string",
              "code": "string",
              "value": {
                "includingVat": 0.1,
                "excludingVat": 0.1
              },
              "attributes": {
                "property1": null,
                "property2": null
              }
            }
          ],
          "attributes": {
            "property1": null,
            "property2": null
          }
        }
      ],
      "discounts": [
        {
          "type": 0,
          "name": "string",
          "code": "string",
          "value": {
            "includingVat": 0.1,
            "excludingVat": 0.1
          },
          "attributes": {
            "property1": null,
            "property2": null
          }
        }
      ],
      "total": {
        "includingVat": 0.1,
        "excludingVat": 0.1
      },
      "attributes": {
        "property1": null,
        "property2": null
      }
    },
    "shippings": [
      {
        "id": "string",
        "merchant": "string",
        "channel": "string",
        "state": 0,
        "reference": "string",
        "tmsReference": "string",
        "orderId": "string",
        "adapterId": "string",
        "name": "string",
        "total": {
          "includingVat": 0.1,
          "excludingVat": 0.1
        },
        "vatRate": 0.1,
        "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.1
          }
        ],
        "attributes": {
          "property1": null,
          "property2": null
        }
      }
    ],
    "payments": [
      {
        "id": "string",
        "adapterId": "string",
        "name": "string",
        "merchant": "string",
        "channel": "string",
        "currency": "string",
        "type": 0,
        "orderId": "string",
        "amount": 0.1,
        "upperLimitAmount": 0.1,
        "state": 0,
        "reference": "string",
        "attributes": {
          "property1": null,
          "property2": null
        },
        "recurring": {
          "token": "string",
          "description": "string",
          "attributes": {
            "property1": null,
            "property2": null
          }
        }
      }
    ],
    "customer": {
      "billing": {
        "type": 0,
        "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": 0,
        "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": 0,
      "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.1,
      "excludingVat": 0.1
    },
    "attributes": {
      "property1": null,
      "property2": null
    }
  }'

Responses

OK

Bodyapplication/jsonArray [
operationstring
pathstring
valueany
]
Response
application/json
[ { "operation": "string", "path": "string", "value": null } ]

Handle shipping changed.Deprecated

Request

Shipping changed.

Path
order_idstringrequired

Order identifier

payment_idstringrequired

Payment identifier

Headers
x-merchantstringrequired

Merchant identifier.

Example: norce
x-channelstringrequired

Channel identifier

Example: 1
Body

Updated Norce order

idstring
merchantstring
channelstring
referencestring
createdstring(date-time)
lastModifiedstring(date-time)
stateobject
culturestring
currencystring
countrystring
cartobject
shippingsArray of objects(Norce.Checkout.AdyenAdapter.Application.Order.Shipping)
paymentsArray of objects(Norce.Checkout.AdyenAdapter.Application.Order.Payment)
customerobject
consentsArray of objects(Norce.Checkout.AdyenAdapter.Application.Order.Consent)
hooksArray of objects(Norce.Checkout.AdyenAdapter.Application.Order.Hook)
totalobject
attributesobject
curl -i -X POST \
  'https://docs.norce.io/api/checkout/v1/callback/orders/{order_id}/payments/{payment_id}/shipping-changed' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json-patch+json' \
  -H 'x-channel: 1' \
  -H 'x-merchant: norce' \
  -d '{
    "id": "string",
    "merchant": "string",
    "channel": "string",
    "reference": "string",
    "created": "2019-08-24T14:15:22Z",
    "lastModified": "2019-08-24T14:15:22Z",
    "state": {
      "currentStatus": 0,
      "transitions": [
        {
          "status": 0,
          "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.1,
            "excludingVat": 0.1
          },
          "total": {
            "includingVat": 0.1,
            "excludingVat": 0.1
          },
          "originalTotal": {
            "includingVat": 0.1,
            "excludingVat": 0.1
          },
          "vatRate": 0.1,
          "discounts": [
            {
              "type": 0,
              "name": "string",
              "code": "string",
              "value": {
                "includingVat": 0.1,
                "excludingVat": 0.1
              },
              "attributes": {
                "property1": null,
                "property2": null
              }
            }
          ],
          "attributes": {
            "property1": null,
            "property2": null
          }
        }
      ],
      "discounts": [
        {
          "type": 0,
          "name": "string",
          "code": "string",
          "value": {
            "includingVat": 0.1,
            "excludingVat": 0.1
          },
          "attributes": {
            "property1": null,
            "property2": null
          }
        }
      ],
      "total": {
        "includingVat": 0.1,
        "excludingVat": 0.1
      },
      "attributes": {
        "property1": null,
        "property2": null
      }
    },
    "shippings": [
      {
        "id": "string",
        "merchant": "string",
        "channel": "string",
        "state": 0,
        "reference": "string",
        "tmsReference": "string",
        "orderId": "string",
        "adapterId": "string",
        "name": "string",
        "total": {
          "includingVat": 0.1,
          "excludingVat": 0.1
        },
        "vatRate": 0.1,
        "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.1
          }
        ],
        "attributes": {
          "property1": null,
          "property2": null
        }
      }
    ],
    "payments": [
      {
        "id": "string",
        "adapterId": "string",
        "name": "string",
        "merchant": "string",
        "channel": "string",
        "currency": "string",
        "type": 0,
        "orderId": "string",
        "amount": 0.1,
        "upperLimitAmount": 0.1,
        "state": 0,
        "reference": "string",
        "attributes": {
          "property1": null,
          "property2": null
        },
        "recurring": {
          "token": "string",
          "description": "string",
          "attributes": {
            "property1": null,
            "property2": null
          }
        }
      }
    ],
    "customer": {
      "billing": {
        "type": 0,
        "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": 0,
        "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": 0,
      "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.1,
      "excludingVat": 0.1
    },
    "attributes": {
      "property1": null,
      "property2": null
    }
  }'

Responses

OK

Bodyapplication/jsonArray [
operationstring
pathstring
valueany
]
Response
application/json
[ { "operation": "string", "path": "string", "value": null } ]

Handle Cart changedDeprecated

Request

Cart changed.

Path
order_idstringrequired

Order identifier

payment_idstringrequired

Payment identifier

Headers
x-merchantstringrequired

Merchant identifier.

Example: norce
x-channelstringrequired

Channel identifier

Example: 1
Body

Updated Norce order

idstring
merchantstring
channelstring
referencestring
createdstring(date-time)
lastModifiedstring(date-time)
stateobject
culturestring
currencystring
countrystring
cartobject
shippingsArray of objects(Norce.Checkout.AdyenAdapter.Application.Order.Shipping)
paymentsArray of objects(Norce.Checkout.AdyenAdapter.Application.Order.Payment)
customerobject
consentsArray of objects(Norce.Checkout.AdyenAdapter.Application.Order.Consent)
hooksArray of objects(Norce.Checkout.AdyenAdapter.Application.Order.Hook)
totalobject
attributesobject
curl -i -X POST \
  'https://docs.norce.io/api/checkout/v1/callback/orders/{order_id}/payments/{payment_id}/cart-changed' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json-patch+json' \
  -H 'x-channel: 1' \
  -H 'x-merchant: norce' \
  -d '{
    "id": "string",
    "merchant": "string",
    "channel": "string",
    "reference": "string",
    "created": "2019-08-24T14:15:22Z",
    "lastModified": "2019-08-24T14:15:22Z",
    "state": {
      "currentStatus": 0,
      "transitions": [
        {
          "status": 0,
          "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.1,
            "excludingVat": 0.1
          },
          "total": {
            "includingVat": 0.1,
            "excludingVat": 0.1
          },
          "originalTotal": {
            "includingVat": 0.1,
            "excludingVat": 0.1
          },
          "vatRate": 0.1,
          "discounts": [
            {
              "type": 0,
              "name": "string",
              "code": "string",
              "value": {
                "includingVat": 0.1,
                "excludingVat": 0.1
              },
              "attributes": {
                "property1": null,
                "property2": null
              }
            }
          ],
          "attributes": {
            "property1": null,
            "property2": null
          }
        }
      ],
      "discounts": [
        {
          "type": 0,
          "name": "string",
          "code": "string",
          "value": {
            "includingVat": 0.1,
            "excludingVat": 0.1
          },
          "attributes": {
            "property1": null,
            "property2": null
          }
        }
      ],
      "total": {
        "includingVat": 0.1,
        "excludingVat": 0.1
      },
      "attributes": {
        "property1": null,
        "property2": null
      }
    },
    "shippings": [
      {
        "id": "string",
        "merchant": "string",
        "channel": "string",
        "state": 0,
        "reference": "string",
        "tmsReference": "string",
        "orderId": "string",
        "adapterId": "string",
        "name": "string",
        "total": {
          "includingVat": 0.1,
          "excludingVat": 0.1
        },
        "vatRate": 0.1,
        "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.1
          }
        ],
        "attributes": {
          "property1": null,
          "property2": null
        }
      }
    ],
    "payments": [
      {
        "id": "string",
        "adapterId": "string",
        "name": "string",
        "merchant": "string",
        "channel": "string",
        "currency": "string",
        "type": 0,
        "orderId": "string",
        "amount": 0.1,
        "upperLimitAmount": 0.1,
        "state": 0,
        "reference": "string",
        "attributes": {
          "property1": null,
          "property2": null
        },
        "recurring": {
          "token": "string",
          "description": "string",
          "attributes": {
            "property1": null,
            "property2": null
          }
        }
      }
    ],
    "customer": {
      "billing": {
        "type": 0,
        "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": 0,
        "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": 0,
      "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.1,
      "excludingVat": 0.1
    },
    "attributes": {
      "property1": null,
      "property2": null
    }
  }'

Responses

OK

Bodyapplication/jsonArray [
operationstring
pathstring
valueany
]
Response
application/json
[ { "operation": "string", "path": "string", "value": null } ]