createPaymentRequest

language

The language in which the payment form is displayed. For more information about supported language codes, see Supported languages. If the language parameter is not set, the language is derived from the browser's Accept-Language HTTP header field. If none of the browser languages are supported, the default is English, en. If the language you set is not supported, an error is returned.

[a-z]{2}

This is a one-dimensional associative array, where you can put any value that you would like to associate with the payment in the call to createPaymentRequest.

Array

Maximum 50 entries of maximum 255 characters each.

type

This is the authorization type. For more information, see Payment request types:

• payment (default)
• paymentAndCapture
• verifyCard
• credit
• subscription
• subscriptionAndCharge
• subscriptionAndReserve

string

ccToken

This is the credit card token value. By using a credit card token from a previous payment, your customer won't have to enter credit card details again. To enable this, select the Enable credit card token check box under Home > Terminal Settings in the Merchant Interface.

[0-9a-f]{41}

sale_reconciliation_identifier

This is the sales reconciliation identifier, used in the reconciliation CSV files you can download from the Merchant Information Interface, or by using the getCustomReport method. For more information, see getCustomReport.This parameter can only be used when the type parameter is set to paymentAndCapture.

String{0,100}

sale_invoice_number

This is the invoice number for the capture.

String{0,100}

fraud_service

Setting the fraud_service parameter lets you select a different fraud detection service on the payment level.

none

maxmind

red

test

cookie

This is the cookie that will be sent back to all your callback URLs. For example, if your cookie parameters are set to PHPSESSID=id1337;mycookie=mycookievalue;, the cookie header in the callback is Cookie: PHPSESSID=asdfasdfdf23; mycookie=mycookievalue

String

payment_source

This identifies the source of the payment. The default value is eCommerce.

eCommerce

mobi

moto

mail_order

telephone_order

shipping_method

Fraud detection services can use this parameter in the fraud detection calculations.

LowCost

DesignatedByCustomer

International

Military

NextDay

Other

StorePickup

TwoDayService

ThreeDayService

customer_created_date

This is the date when the customer account was first created in your shopping system. Fraud detection services use this parameter in the fraud detection calculations.

Date (yyyy-mm-dd)

organisation_number

this is the company registration number (CRN), and is used to identify the company and verify the fact that it is a entity registered with the relevant authority, for example, Companies House in the UK. Do not confuse this with the customer_info[vat_id], although in some countries the number may be the same.

To ensure that the organisation number field is pre-populated on the invoice payment form, set the organisation_number parameter.

String{0,20}

account_offer

If you set account_offer to required, the customer must have an account set up to be able to use invoice payment.

To disable the account for a specific customer, set account_offer to disabled.

required

disabled

ltd - limited company

plc - public limited company

public_institution - public institution

Other - all other company types

The last name for the customer's shipping address.

The first name for the customer's shipping address.

The postal code of the customer's shipping address.

The region of the customer's shipping address.

The country of the customer's shipping address as a 2 character ISO-3166 country code.

The city of the customer's shipping address.

The customer's email address.

The customer's telephone number, without spaces. This must include the country code. You can prefix the code with + (e.g. +446721846), or 00 (e.g. 00446721846), or omit the prefix (e.g. 446721846).

The birth date of the customer

Mandatory if your MCC code is 6012.

The last name for the customer's billing address.

Mandatory if your MCC code is 6012.

The first name for the customer's billing address.

The street address of the customer's billing address.

The city of the customer's billing address.

Mandatory for fraud detection.

The region of the customer's billing address.

Mandatory for fraud detection.

The postal code of the customer's billing address.

Mandatory if your MCC code is 6012.

Mandatory for fraud detection.

The country of the customer's billing address as a 2 character ISO-3166 country code. Northern Ireland is an exception; see here.

Mandatory for fraud detection.

The phone number of the bank where the credit card was issued.

The name of the bank where the credit card was issued.

Certain invoice payment providers require gender to be sent. Use this field to comply with that requirement.

If this parameter is required by the provider, but not set in the method call, the customer is asked for this information on the payment page (callback_form).

The customer's IP address.

Used for fraud detection.

A unique identifier of the customers session (eg. an md5 hash of the real session id). Used for fraud detection.

The language setting of the customers browser. Used for fraud detection.

The customers browser identification. Used for fraud detection.

description

Description of an item.

String (255)

itemId

The item identification.

String (100)

quantity

The quantity of the item. The value must be greater than zero.

Decimal

unitPrice

The unit price, excluding sales tax. The value must be greater than zero, unless the optional goodsType parameter is set to handling, in which case the field can be used to provide a discount.

Decimal

taxPercent

This is the tax percentage of the unit price.

Decimal

taxAmount

This is the total tax on an order line, before any discounts are applied. It is recommended to use taxAmount if possible. If you provide both taxPercent and taxAmount, the amount takes precedence.

Decimal

unitCode

The relevant measurement unit for the order line. For example, kg.

String (50)

discount

The order line's discount in percent.

Decimal

The goods type of the order line - shipment| handling| item| digital| discount| gift_card| info| physical| sales_tax

imageUrl

The full URL of the icon for the item

String (255)

As Swish only allows one open payment at a time, the callback_fail form for Swish could offer some explanation, such as "The customer may have an open payment" or "The customer should check their Swish app for open payments".

For Klarna payments, the open page (callback_open) is used for pending transactions.

For Klarna payments, the notification page (callback_notification) is used for transactions pending clarification.

This URL is called just before the payment is processed.

• To return a value that is not part of the normal POST parameters, you can prepend GET parameters to the URL.
• To allow the payment to proceed, you must return a HTTP response with code 200, and a HTML/TEXT response with the value "OKAY". Anything else results in an error message, and an aborted/declined transaction.

If the payment fails, the first 255 characters of your response is shown as an error message to the customer.