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

Create a new Adyen Checkout order

Request

Requires an existing Norce order.

Path
order_idstringrequired

Order identifier

Headers
x-merchantstringrequired

Merchant identifier.

Example: norce
x-channelstringrequired

Channel identifier

Example: 1
curl -i -X POST \
  'https://docs.norce.io/api/checkout/v1/orders/{order_id}/payments' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'x-channel: 1' \
  -H 'x-merchant: norce'

Responses

OK

Bodyapplication/json
paymentIdstring

Norce Payment Id

clientKeystring
localestring
environmentinteger(int32)
Enum01
amountobject
paymentMethodsResponseobject
paymentMethodsConfigurationobject
Response
application/json
{ "paymentId": "string", "clientKey": "string", "locale": "string", "environment": 0, "amount": { "currency": "string", "value": 0.1 }, "paymentMethodsResponse": { "paymentMethods": [], "storedPaymentMethods": [] }, "paymentMethodsConfiguration": { "property1": [], "property2": [] } }

Complete an order using a recurring payment token

Request

Complete an order using a recurring payment token.

Path
order_idstringrequired

Order identifier

Headers
x-merchantstringrequired

Merchant identifier.

Example: norce
x-channelstringrequired

Channel identifier

Example: 1
Body

Recurring payment token information

recurringPaymentTokenstring
recurringShopperReferencestring
curl -i -X POST \
  'https://docs.norce.io/api/checkout/v1/orders/{order_id}/payments/recurring/subscription/complete' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json-patch+json' \
  -H 'x-channel: 1' \
  -H 'x-merchant: norce' \
  -d '{
    "recurringPaymentToken": "string",
    "recurringShopperReference": "string"
  }'

Responses

OK

Bodyapplication/json
resultCodeinteger(int32)
Enum12345678910
actionobject
additionalDataobject
amountobject
donationTokenstring
fraudResultobject
merchantReferencestring
orderobject
paymentMethodobject
pspReferencestring
refusalReasonstring
refusalReasonCodestring
threeDS2ResponseDataobject
threeDS2Resultobject
threeDSPaymentDatastring
Response
application/json
{ "resultCode": 1, "action": { "isNullable": true, "schemaType": "string", "actualInstance": null }, "additionalData": { "property1": "string", "property2": "string" }, "amount": { "currency": "string", "value": 0 }, "donationToken": "string", "fraudResult": { "accountScore": 0, "results": [] }, "merchantReference": "string", "order": { "amount": {}, "expiresAt": "string", "orderData": "string", "pspReference": "string", "reference": "string", "remainingAmount": {} }, "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": 1, "exemptionIndicator": 1, "threeDSRequestorChallengeInd": 1, "authenticationValue": "string", "cavvAlgorithm": "string", "dsTransID": "string", "eci": "string", "messageVersion": "string", "riskScore": "string", "threeDSServerTransID": "string", "timestamp": "string", "transStatus": "string", "transStatusReason": "string", "whiteListStatus": "string" }, "threeDSPaymentData": "string" }

Get an existing Adyen Checkout order

Request

Used to get an existing Adyen Checkout Order with payment methods.

Path
order_idstringrequired

Order identifier

payment_idstringrequired

Payment identifier

Headers
x-merchantstringrequired

Merchant identifier.

Example: norce
x-channelstringrequired

Channel identifier

Example: 1
curl -i -X GET \
  'https://docs.norce.io/api/checkout/v1/orders/{order_id}/payments/{payment_id}' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'x-channel: 1' \
  -H 'x-merchant: norce'

Responses

OK

Bodyapplication/json
paymentIdstring

Norce Payment Id

clientKeystring
localestring
environmentinteger(int32)
Enum01
amountobject
paymentMethodsResponseobject
paymentMethodsConfigurationobject
Response
application/json
{ "paymentId": "string", "clientKey": "string", "locale": "string", "environment": 0, "amount": { "currency": "string", "value": 0.1 }, "paymentMethodsResponse": { "paymentMethods": [], "storedPaymentMethods": [] }, "paymentMethodsConfiguration": { "property1": [], "property2": [] } }

Start a transaction

Request

Sends payment parameters (like amount, country, and currency) together with other required input details collected from the shopper.

Path
order_idstringrequired

Order identifier

payment_idstringrequired

Payment identifier

Headers
x-merchantstringrequired

Merchant identifier.

Example: norce
x-channelstringrequired

Channel identifier

Example: 1
Body

Transaction data from Adyen front-end

property name*Array of arrays(Newtonsoft.Json.Linq.JToken)additional property
curl -i -X POST \
  'https://docs.norce.io/api/checkout/v1/orders/{order_id}/payments/{payment_id}/transaction' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json-patch+json' \
  -H 'x-channel: 1' \
  -H 'x-merchant: norce' \
  -d '{
    "property1": [
      []
    ],
    "property2": [
      []
    ]
  }'

Responses

OK

Bodyapplication/json
resultCodeinteger(int32)
Enum12345678910
actionobject
additionalDataobject
amountobject
donationTokenstring
fraudResultobject
merchantReferencestring
orderobject
paymentMethodobject
pspReferencestring
refusalReasonstring
refusalReasonCodestring
threeDS2ResponseDataobject
threeDS2Resultobject
threeDSPaymentDatastring
Response
application/json
{ "resultCode": 1, "action": { "isNullable": true, "schemaType": "string", "actualInstance": null }, "additionalData": { "property1": "string", "property2": "string" }, "amount": { "currency": "string", "value": 0 }, "donationToken": "string", "fraudResult": { "accountScore": 0, "results": [] }, "merchantReference": "string", "order": { "amount": {}, "expiresAt": "string", "orderData": "string", "pspReference": "string", "reference": "string", "remainingAmount": {} }, "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": 1, "exemptionIndicator": 1, "threeDSRequestorChallengeInd": 1, "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.

Request

Submit additional payment details to complete the Adyen Checkout payment.

Path
order_idstringrequired

Order identifier

payment_idstringrequired

Payment identifier

Headers
x-merchantstringrequired

Merchant identifier.

Example: norce
x-channelstringrequired

Channel identifier

Example: 1
Body

Additional Adyen payment details

authenticationDataobject
detailsobject
paymentDatastring
threeDSAuthenticationOnlybooleanDeprecated
curl -i -X POST \
  'https://docs.norce.io/api/checkout/v1/orders/{order_id}/payments/{payment_id}/details' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json-patch+json' \
  -H 'x-channel: 1' \
  -H 'x-merchant: norce' \
  -d '{
    "authenticationData": {
      "authenticationOnly": true
    },
    "details": {
      "md": "string",
      "paReq": "string",
      "paRes": "string",
      "authorizationToken": "string",
      "billingToken": "string",
      "cupsecureplusSmscode": "string",
      "facilitatorAccessToken": "string",
      "oneTimePasscode": "string",
      "orderID": "string",
      "payerID": "string",
      "payload": "string",
      "paymentID": "string",
      "paymentStatus": "string",
      "redirectResult": "string",
      "resultCode": "string",
      "returnUrlQueryString": "string",
      "threeDSResult": "string",
      "threeds2ChallengeResult": "string",
      "threeds2Fingerprint": "string",
      "vaultToken": "string"
    },
    "paymentData": "string",
    "threeDSAuthenticationOnly": true
  }'

Responses

OK

Bodyapplication/json
resultCodeinteger(int32)
Enum12345678910
additionalDataobject
amountobject
donationTokenstring
fraudResultobject
merchantReferencestring
orderobject
paymentMethodobject
pspReferencestring
refusalReasonstring
refusalReasonCodestring
shopperLocalestring
threeDS2ResponseDataobject
threeDS2Resultobject
threeDSPaymentDatastring
Response
application/json
{ "resultCode": 1, "additionalData": { "property1": "string", "property2": "string" }, "amount": { "currency": "string", "value": 0 }, "donationToken": "string", "fraudResult": { "accountScore": 0, "results": [] }, "merchantReference": "string", "order": { "amount": {}, "expiresAt": "string", "orderData": "string", "pspReference": "string", "reference": "string", "remainingAmount": {} }, "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": 1, "exemptionIndicator": 1, "threeDSRequestorChallengeInd": 1, "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 an Adyen Checkout order

Request

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.

Path
order_idstringrequired

Order identifier

payment_idstringrequired

Payment identifier

Headers
x-merchantstringrequired

Merchant identifier.

Example: norce
x-channelstringrequired

Channel identifier

Example: 1
curl -i -X POST \
  'https://docs.norce.io/api/checkout/v1/orders/{order_id}/payments/{payment_id}/remove' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'x-channel: 1' \
  -H 'x-merchant: norce'

Responses

OK

Response
No content

Adyen Checkout Callbacks

Operations

Adyen Checkout Webhook endpoint

Operations

Norce Callbacks

Operations