POST/v1/tenants/{tenantId}/ecom_stores/{eComStoreId}/carts/{cartId}/payment_session

Open a payment session for a cart Experimental

Creates an Adyen Drop-in session for the cart's current gross total plus the chosen delivery option's gross freight. The store's credentials stay in SnowBee; the response holds only what the Drop-in needs in the browser. Complete the session in the Drop-in, then check out the cart with the paymentId and the Drop-in's sessionResult. Available for stores with web payment configured.

Parameters

tenantIdpathstringnon-nullrequired
eComStoreIdpathstringnon-nullrequired
cartIdpathstringnon-nullrequired

Request body (required)

application/jsonobjectnon-null

Where the shopper returns after a redirect payment method, and who is paying

freightobjectnullableoptional

The delivery option the shopper chose, as it will be sent at checkout. Its gross freight is added to the amount authorised.

Show child fields

carrierAgreementCodestringnon-nullrequired

Example"6838716034162098000"

carrierCodestringnon-nullrequired

Example"porterbuddy"

carrierNamestringnullableoptional

Example"Porterbuddy"

carrierProductCodestringnon-nullrequired

Example"8747679326213767168"

carrierProductNamestringnullableoptional

Example"Evening delivery"

carrierProductPayloadobjectnullableoptional

Provider-specific extra data

Show child fields

partnerNamestringnullableoptional: Partner name from provider
partnerNumberstringnullableoptional: Partner number from provider

freightVatRatestringnullableoptional

VAT rate for freight as a percentage

Format: BigDecimal

Example"25.00"

netFreightAmountstringnullableoptional

Net freight/shipping cost amount (excl. VAT)

Format: BigDecimal

Example"49.00"

returnUrlstringnon-nullrequired

Absolute URL the shopper is sent back to after a redirect, e.g. Vipps. The storefront's checkout return page.

shopperEmailstringnullableoptional

Shopper email, passed to the payment provider for risk and receipts

View schema definition

Responses

201Response

application/jsonobjectnon-null

A Drop-in session for the cart. Mount the Drop-in with sessionId, sessionData, clientKey and environment; pass paymentId and the Drop-in's sessionResult to checkout.

amountstringnon-nullrequired: Amount the session authorises: the cart's gross total
Format: BigDecimal
Example"100.0"
clientKeystringnon-nullrequired: Adyen client key for the Drop-in
currencyIsoCodestringnon-nullrequired: ISO 4217 currency
Example"NOK"
environmentstringnon-nullrequired: test or live
Example"test"
paymentIdstringnon-nullrequired: Payment ID; hand it back at checkout
sessionDatastringnon-nullrequired: Adyen session data for the Drop-in
sessionIdstringnon-nullrequired

View schema definition

400Response

application/jsonobjectnon-null

errorstringnon-nullrequired: Stable error code
Example"INVALID_REQUEST"
messagestringnon-nullrequired: Human-readable error message
Example"Invalid customer ID format"
resolutionstringnon-nullrequired: Suggested next action
Example"Correct the customer ID and retry the request"

View schema definition

401Response

application/jsonobjectnon-null

errorstringnon-nullrequired: Stable error code
Example"INVALID_REQUEST"
messagestringnon-nullrequired: Human-readable error message
Example"Invalid customer ID format"
resolutionstringnon-nullrequired: Suggested next action
Example"Correct the customer ID and retry the request"

View schema definition

403Response

application/jsonobjectnon-null

errorstringnon-nullrequired: Stable error code
Example"INVALID_REQUEST"
messagestringnon-nullrequired: Human-readable error message
Example"Invalid customer ID format"
resolutionstringnon-nullrequired: Suggested next action
Example"Correct the customer ID and retry the request"

View schema definition

404Response

application/jsonobjectnon-null

errorstringnon-nullrequired: Stable error code
Example"INVALID_REQUEST"
messagestringnon-nullrequired: Human-readable error message
Example"Invalid customer ID format"
resolutionstringnon-nullrequired: Suggested next action
Example"Correct the customer ID and retry the request"

View schema definition

409The store takes no web payments, its Adyen integration is unavailable, or the provider refused to open a session

The store takes no web payments, its Adyen integration is unavailable, or the provider refused to open a session

application/jsonobjectnon-null

errorstringnon-nullrequired: Stable error code
Example"INVALID_REQUEST"
messagestringnon-nullrequired: Human-readable error message
Example"Invalid customer ID format"
resolutionstringnon-nullrequired: Suggested next action
Example"Correct the customer ID and retry the request"

View schema definition

422Empty or unpriced cart

Empty or unpriced cart

application/jsonobjectnon-null

errorstringnon-nullrequired: Stable error code
Example"INVALID_REQUEST"
messagestringnon-nullrequired: Human-readable error message
Example"Invalid customer ID format"
resolutionstringnon-nullrequired: Suggested next action
Example"Correct the customer ID and retry the request"

View schema definition