reservation

terminal

The terminal determines the payment method and currency. For more information, see AltaPay's Payment Gateway. This is the title of your terminal, found under Home > Terminal Settings in the Merchant Interface. You can use variables in the terminal parameter. For example, if you want to call My EUR Terminal, you can set the terminal parameter value to 'My {currency} Terminal', where {currency} references the value of the currency parameter.

string

X

shop_orderid

This is the internal ID of the order in your webshop. In most integrations, you can use the same order ID for up to four orders. For PayPal and MobilePay payments, you can only use it for a singe successful transaction. The shop_orderid value is posted back to you, so you know the order to which the payment refers.

[a-zA-Z0-9-]{1,100}

X

amount

This is the payment amount. If you are setting up a subscription, it is the default amount for each capture. You must use a dot as the decimal separator, and the amount can have maximum 2 decimals.

float

X

currency

This is the payment currency. It must be specified in an ISO-4217 format, either using the 3-digit numeric code, or the 3-letter character code. For more information about ISO-4217 currency codes, see https://en.wikipedia.org/wiki/ISO_4217.

[0-9]{3} or

[A-Z]{3}

X

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

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)

The sales tax amount. Indicates how much of the gross amount that was sales tax, e.g. VAT (UK) or Moms (DK).

The surcharge amount to apply to the payment. You can retrieve the surcharge value based on a previously completed payment or a terminal, creditcard token, and currency combination - using the calculateSurcharge method. For more information, see calculateSurcharge.

This is the id of the setup agreement payment.

This should be provided only in case of charging verify card agreement.

This is the type of the agreement.

In case the reservation type parameter is subscription, subscriptionAndCharge or subscriptionAndReserve and no agreement[type] is provided, it will create a recurring agreement.

Possible values:

• recurring (Notes: Strong Customer Authentication takes place.)
• instalment (Notes: Strong Customer Authentication takes place.)
• unscheduled (Notes: Strong Customer Authentication takes place.)

This is the type of the unscheduled agreement.

In case the reservation type parameter is subscriptionAndCharge or subscriptionAndReserve and the agreement[type]=unscheduled, the agreement[unscheduled_type] parameter is mandatory.

Possible values:

• incremental (Notes: No cardholder authentication required)
• resubmission (Notes: No cardholder authentication required)
• delayedCharges (Notes: No cardholder authentication required)
• reauthorisation (Notes: No cardholder authentication required)
• noShow (Notes: No cardholder authentication required)
• charge (Notes: Strong Customer Authentication takes place.)

This is a link to a page on the merchant side where the customer can manage the agreement.

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. This value is going to be used as Plan Description when initiating an agreement on MobilePay.

String (255)

itemId

The item identification. This value is going to be used as the Plan when initiating an agreement on MobilePay. The value for goodsType should be set to subscription_model

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 | subscription_model

imageUrl

The full URL of the icon for the item

String (255)

Result

Transactions