Skip to content
COMMERCE SERVICES
/
Shopping Service
/
Checkout
/
Check balance of gift card

Documentation ShoppingService (1.1)

Entities and methods to handle baskets and payments.

Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers

https://customer-slug.api-se.norce.tech/commerce/shopping/1.1/

Basket

Operations

Checkout

Operations

Get a checkout for form based payments

Request

GetPaymentForm starts a forms based checkout by populating a code snippet in some of the RedirectParameters. If the checkout supports modifications of the Storm basket in any way, a new call to GetPaymentForm must be made in order to update the code snippet with correct values. See Checkout Form Payment for more information about the checkout process.

Query
basketIdinteger(int32)required

The internal id of the basket used in the checkout.

ipAddressstringrequired

The ipaddress of the current user. This should not be the ip of the application.

userAgentstringrequired

The userAgent of the current user's browser or application.

pricelistSeedstring

A comma separated list of internal pricelist ids to use, if any. PriceLists supplied must be valid, either from the application's public priceList or any customer or company priceLists or any valid client priceLists. For clients configured to use priceListSeed exclusively in the API only the supplied priceLists will be used. If this is not configured, the supplied priceLists will be appended to the valid priceLists. If none is supplied, the default value for the application will be used in combination with any customer or company priceLists. This applies to both configurations.

cultureCodestring

Specifies in which language to display culture specific information. If none is supplied, value is resolved from Application.

Body
required

General: 'Mobile'='True' to enable javascript for mobile phones.

Array [
Namestring

The Name of the Entity. MaxLength: 50.

Valuestring

The Value of the Entity. MaxLength: max.

]
curl -i -X POST \
  'https://customer-slug.api-se.norce.tech/commerce/shopping/1.1/GetPaymentForm?basketId=0&ipAddress=string&userAgent=string' \
  -H 'Content-Type: application/json' \
  -d '[
    {
      "Name": "string",
      "Value": "string"
    }
  ]'

Responses

Success

Body
Statusstring

String response. OK if successful, otherwise may have different values depending on PSP. MaxLength: 50.

StatusDescriptionstring

Descriptive text for the status. MaxLength: 255.

BasketIdinteger or null(int32)

Internal id of the associated basket.

OrderNostring

Order number if order's been created. MaxLength: 50.

PaymentCodestring

Internal identifier of this specific payment attempt. MaxLength: int.

PaymentReferencestring

External identifier of this specific payment attempt, usually from the PSP. MaxLength: 50.

HostedPaymentPagestring

Used when a payment should be finalized on a different platform, e.g. sending a link by SMS to customer. MaxLength: 50.

RedirectUrlstring

Configurated redirection URL after successful payment. MaxLength: 255.

RedirectParametersArray of objects(NameValue)(NameValue)

PSP specific data returned for the payment. See PSP documentation.

IsSyncronousboolean or null

Indicates if the payment attempt was synchronous or not.

PaymentServiceIdinteger or null(int32)

Internal id of the payment service used.

Response
{
  "Status": "string",
  "StatusDescription": "string",
  "BasketId": 0,
  "OrderNo": "string",
  "PaymentCode": "string",
  "PaymentReference": "string",
  "HostedPaymentPage": "string",
  "RedirectUrl": "string",
  "RedirectParameters": [
    { … }
  ],
  "IsSyncronous": true,
  "PaymentServiceId": 0
}

Check balance of gift card

Request

PaymentGiftCardCheck checks current balance of a gift card. The balance is returned in Response.RedirectParameters with name = 'Balance'. The Currency is returned with name = 'CurrencyCode'.

Query
cardNostringrequired
cvcstring
paymentMethodIdinteger(int32)required
cultureCodestring

Specifies in which language to display culture specific information. If none is supplied, value is resolved from Application.

curl -i -X POST \
  'https://customer-slug.api-se.norce.tech/commerce/shopping/1.1/PaymentGiftCardCheck?cardNo=string&paymentMethodId=0'

Responses

Success

Body
Statusstring

String response. OK if successful, otherwise may have different values depending on PSP. MaxLength: 50.

StatusDescriptionstring

Descriptive text for the status. MaxLength: 255.

BasketIdinteger or null(int32)

Internal id of the associated basket.

OrderNostring

Order number if order's been created. MaxLength: 50.

PaymentCodestring

Internal identifier of this specific payment attempt. MaxLength: int.

PaymentReferencestring

External identifier of this specific payment attempt, usually from the PSP. MaxLength: 50.

HostedPaymentPagestring

Used when a payment should be finalized on a different platform, e.g. sending a link by SMS to customer. MaxLength: 50.

RedirectUrlstring

Configurated redirection URL after successful payment. MaxLength: 255.

RedirectParametersArray of objects(NameValue)(NameValue)

PSP specific data returned for the payment. See PSP documentation.

IsSyncronousboolean or null

Indicates if the payment attempt was synchronous or not.

PaymentServiceIdinteger or null(int32)

Internal id of the payment service used.

Response
{
  "Status": "string",
  "StatusDescription": "string",
  "BasketId": 0,
  "OrderNo": "string",
  "PaymentCode": "string",
  "PaymentReference": "string",
  "HostedPaymentPage": "string",
  "RedirectUrl": "string",
  "RedirectParameters": [
    { … }
  ],
  "IsSyncronous": true,
  "PaymentServiceId": 0
}

Purchase a basket

Request

Purchase a basket

Query
basketIdinteger(int32)required

The internal id of the current basket.

ipAddressstringrequired

The user's ipAddress.

userAgentstringrequired

The user agent of the user's browser.

pricelistSeedstring

A comma separated list of internal pricelist ids to use, if any. PriceLists supplied must be valid, either from the application's public priceList or any customer or company priceLists or any valid client priceLists. For clients configured to use priceListSeed exclusively in the API only the supplied priceLists will be used. If this is not configured, the supplied priceLists will be appended to the valid priceLists. If none is supplied, the default value for the application will be used in combination with any customer or company priceLists. This applies to both configurations.

cultureCodestring

Specifies in which language to display culture specific information. If none is supplied, value is resolved from Application.

curl -i -X POST \
  'https://customer-slug.api-se.norce.tech/commerce/shopping/1.1/Purchase?basketId=0&ipAddress=string&userAgent=string'

Responses

Success

Body
Statusstring

String response. OK if successful, otherwise may have different values depending on PSP. MaxLength: 50.

StatusDescriptionstring

Descriptive text for the status. MaxLength: 255.

BasketIdinteger or null(int32)

Internal id of the associated basket.

OrderNostring

Order number if order's been created. MaxLength: 50.

PaymentCodestring

Internal identifier of this specific payment attempt. MaxLength: int.

PaymentReferencestring

External identifier of this specific payment attempt, usually from the PSP. MaxLength: 50.

HostedPaymentPagestring

Used when a payment should be finalized on a different platform, e.g. sending a link by SMS to customer. MaxLength: 50.

RedirectUrlstring

Configurated redirection URL after successful payment. MaxLength: 255.

RedirectParametersArray of objects(NameValue)(NameValue)

PSP specific data returned for the payment. See PSP documentation.

IsSyncronousboolean or null

Indicates if the payment attempt was synchronous or not.

PaymentServiceIdinteger or null(int32)

Internal id of the payment service used.

Response
{
  "Status": "string",
  "StatusDescription": "string",
  "BasketId": 0,
  "OrderNo": "string",
  "PaymentCode": "string",
  "PaymentReference": "string",
  "HostedPaymentPage": "string",
  "RedirectUrl": "string",
  "RedirectParameters": [
    { … }
  ],
  "IsSyncronous": true,
  "PaymentServiceId": 0
}

DeliveryMethods

Operations

InfoTypes

Operations

OnHand

Operations

OrderRequest

Operations

Payments

Operations

Promotions

Operations

Subscriptions

Operations