v1

latestOpenAPI 3.1.02026-07-247030.0 KB

Pre-Authorization - APM

post/pay/backoffice/payment_preauthorize

Request body

merchantidstring required

The merchant identification number issued during account creation.

orderidstring

max 40 characters. The field orderid is optional and exclusively for the merchants convenience.

amountnumber double required

The amount field contains the transaction’s total amount. This is the amount that will be transmitted to the authorizing system.

currencystring required

The currency field contains the alphanumeric currency code for the transaction, according to ISO 4217, e.g. EUR, USD, AUD, CAD, NOK, SEK, CHF. to http://www.xe.com/iso4217.php

payment_methodinteger required

Valid payment method id, e.g. 17 = Sofort

signaturestring required

The signature field contains a 40-figure hexadecimal value. This signature value is a checksum designed to protect the merchant account from unauthorized access.

url_successstring

The customer will be redirected to url_success, if transaction successful.

url_failedstring

The customer will be redirected to url_failed, if transaction failed.

notification_urlstring

This parameter can be used to override the account notification url setup on our system.

languagestring

The language in which the error messages will be displayed. Default value en or de. ISO-639-1 alpha 2

external_idstring

255 characters. Merchant’s unique id, internal comment

salutationstring

Salutation. Mr., Mrs.

titlestring

Title. Dr., Prof.

genderstring

Gender. M – male F – female

firstnamestring

First name

lastnamestring

Last name

birthdaystring

The customer's birthday

streetstring

Street of the customer's address.

housestring

The house number of the customer.

postboxstring

Post office box

zipstring

The customer's postal code (USA and Canada only)

citystring

The customer's city

statestring

The state/province (USA and Canada only)

countrystring

The country of customer. ISO 3166 alpha3 format only

emailstring required

A RFC 822 compliant email address

phonestring

The customer's phone number. Only numbers

faxstring

The customer's phone number

mobilestring

The mobile number of the customer

companystring

The company

customeridstring

An internal customer id in the merchant’s shop system

customeripstring

The customer's IP address

custom1string

The custom field for the merchant

custom2string

The custom field for the merchant

custom3string

The custom field for the merchant

shipping_country_codestring

3 characters, ISO 3166-1. Used for PayPal

shipping_statestring

max 3 characters. ISO 3166-2. Used for PayPal

shipping_address_line_1string

max 50 characters. Used for PayPal

shipping_address_line_2string

max 50 characters. Used for PayPal

shipping_postal_codestring

max 16 characters. Used for PayPal

shipping_first_namestring

max 150 characters. Used for PayPal

shipping_last_namestring

max 150 characters. Used for PayPal

shop_urlstring

max 255 characters starting with http or https. Used when several websites are used on 1 account

Response

200