SbPublicApiCartPaymentSessionRequest

snowbee.ecom.cart.SbPublicApiCartPaymentSessionRequest

object · non-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 raw schema

{
  "type": "object",
  "description": "Where the shopper returns after a redirect payment method, and who is paying",
  "properties": {
    "freight": {
      "description": "The delivery option the shopper chose, as it will be sent at checkout. Its gross freight is added to the amount authorised.",
      "oneOf": [
        {
          "type": "null"
        },
        {
          "$ref": "#/components/schemas/snowbee.SbPublicApiFreightInfo"
        }
      ]
    },
    "returnUrl": {
      "type": "string",
      "description": "Absolute URL the shopper is sent back to after a redirect, e.g. Vipps. The storefront's checkout return page.",
      "title": "String"
    },
    "shopperEmail": {
      "type": [
        "null",
        "string"
      ],
      "description": "Shopper email, passed to the payment provider for risk and receipts",
      "title": "String"
    }
  },
  "required": [
    "returnUrl"
  ],
  "title": "SbPublicApiCartPaymentSessionRequest"
}