COMMERCE SERVICES
/
Shopping Service
/
Schemas
/
PaymentMethod

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/

Schemas

Payment

PaymentCodeinteger(int32)

System generated id for this particular payment. Client specific.

Amountnumber(decimal)

Payment amount, including VAT.

CardNostring

Card number if payment has been made by credit card or gift card. Populated by PSP. MaxLength: max.

PaymentMethodIdinteger(int32)

Internal id of the payment method for this payment. Application specific.

PaymentServiceIdinteger(int32)

Internal id of the payment service for this payment. System specific. Indicates the PSP.

{
  "PaymentCode": 0,
  "Amount": 0,
  "CardNo": "string",
  "PaymentMethodId": 0,
  "PaymentServiceId": 0
}

PaymentMethod

Idinteger(int32)

Internal id for this payment method.

Namestring

Descriptive name of the payment method. MaxLength: 50.

TypeIdinteger(int32)

Internal type id for this payment method.

TypeNamestring

Clear text name of the type of this payment method. MaxLength: 50.

Descriptionstring

Free text description of the payment method. MaxLength: max.

PartNostring

Part number for this payment method, if configured. MaxLength: 50.

Pricenumber(decimal)

Price, excluding VAT, to use this payment method, if configured.

VatRatenumber(decimal)

A rate to multiply with price to get price inc VAT. 25% VAT equals a VatRate of 1.25.

ImagePathstring

MaxLength: 500. Obsolete! - Use ImageKey with preset

IsSelectedboolean

Indicates if this is the currently selected payment method for the Checkout. Only one may have this flag set to true. Use UpdatePaymentMethod3 to set this property.

Serviceobject(PaymentService)(PaymentService)
ImageKeystring or null(guid)

A unique id for the image at our image server. Url for images are formed like http://[client specific CDN]/{ImageKey}. Preset, height and width can be sent as parameters.

IsForCompanyOnlyboolean

Indicates if this payment method is only allowed for companies. Cannot be combined with IsForPersonOnly.

IsForPersonOnlyboolean

Indicates if this payment method is only allowed for persons. Cannot be combined with IsForCompanyOnly.

{
  "Id": 0,
  "Name": "string",
  "TypeId": 0,
  "TypeName": "string",
  "Description": "string",
  "PartNo": "string",
  "Price": 0,
  "VatRate": 0,
  "ImagePath": "string",
  "IsSelected": true,
  "Service": {
    "Id": 0,
    "Name": "string",
    "Description": "string",
    "ImagePath": "string",
    "ImageKey": "string"
  },
  "ImageKey": "string",
  "IsForCompanyOnly": true,
  "IsForPersonOnly": true
}

PaymentResponse

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.

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

Basket

Operations

Checkout

Operations

DeliveryMethods

Operations

InfoTypes

Operations

OnHand

Operations

OrderRequest

Operations

Payments

Operations

Promotions

Operations

Subscriptions

Operations