Get a checkout for form based payments

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.

Request
query Parameters
basketId
required
integer <int32>

The internal id of the basket used in the checkout.

ipAddress
required
string

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

userAgent
required
string

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

pricelistSeed
string

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.

cultureCode
string

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

Request Body schema:

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

Array
Name
string

The Name of the Entity. MaxLength: 50

Value
string

The Value of the Entity. MaxLength: max

Responses
200

Success

400

Bad Request

Key: BasketItemNotBuyable. Gets raised when the basket item is not buyable or when it is inactive.

Key: BasketItemQuantityLessThanZero. Gets raised when the basket item quantity is less than zero.

Key: DiscountCodeAlreadyUsed. Gets raised when the discount code is already used.

Key: InvalidCompanyOnBasket. Gets raised when the basket has an invalid company. The customer does not exist in this company.

Key: PaymentFailed. Gets raised when the payment fails.

Key: PromotionInvalid. Gets raised when the promotion is invalid.

Key: QuotationMissing. Gets raised when the basket is missing.

Key: BasketContainsSomeUnbuyableItems. Gets raised when the basket has some unbuyable items.

Key: BasketContainsNoBuyableItems. Gets raised when the basket does not have any buyable items.

500

Internal Server Error

post/ShoppingService.svc/rest/GetPaymentForm
Request samples
[
  • {
    }
]
Response samples
{
  • "Status": "string",
  • "StatusDescription": "string",
  • "BasketId": 0,
  • "OrderNo": "string",
  • "PaymentCode": "string",
  • "PaymentReference": "string",
  • "HostedPaymentPage": "string",
  • "RedirectUrl": "string",
  • "RedirectParameters": [
    ],
  • "IsSyncronous": true,
  • "PaymentServiceId": 0
}