# 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.

Endpoint: POST /GetPaymentForm
Version: 1.1

## Query parameters:

  - `basketId` (integer, required)
    The internal id of the basket used in the checkout.

  - `ipAddress` (string, required)
    The ipaddress of the current user. This should not be the ip of the application.

  - `userAgent` (string, required)
    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 fields (application/json):

  - `Name` (string)
    The Name of the Entity. MaxLength: 50.

  - `Value` (string)
    The Value of the Entity. MaxLength: max.

## Response 200 fields (application/json):

  - `Status` (string)
    String response. OK if successful, otherwise may have different values depending on PSP. MaxLength: 50.

  - `StatusDescription` (string)
    Descriptive text for the status. MaxLength: 255.

  - `BasketId` (integer,null)
    Internal id of the associated basket.

  - `OrderNo` (string)
    Order number if order's been created. MaxLength: 50.

  - `PaymentCode` (string)
    Internal identifier of this specific payment attempt. MaxLength: int.

  - `PaymentReference` (string)
    External identifier of this specific payment attempt, usually from the PSP. MaxLength: 50.

  - `HostedPaymentPage` (string)
    Used when a payment should be finalized on a different platform, e.g. sending a link by SMS to customer. MaxLength: 50.

  - `RedirectUrl` (string)
    Configurated redirection URL after successful payment. MaxLength: 255.

  - `RedirectParameters` (array)
    PSP specific data returned for the payment. See PSP documentation.

  - `RedirectParameters.Name` (string)
    The Name of the Entity. MaxLength: 50.

  - `RedirectParameters.Value` (string)
    The Value of the Entity. MaxLength: max.

  - `IsSyncronous` (boolean,null)
    Indicates if the payment attempt was synchronous or not.

  - `PaymentServiceId` (integer,null)
    Internal id of the payment service used.