Pre-Authorization - APM

post

https://sandbox.payabl.com/pay/backoffice/payment_preauthorize

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Payment method id

paymentmethod_id	Name	Description
1	Cards	All credit card types: MasterCard, VISA, Maestro, JCB, AMEX
5	Local payment methods	A suite of alternative payment channels and wallets like: Alipay, iDeal, MyBank, Paysafecard, POLi
17	Direct Bank Transfer	Direct Bank Transfer (Sofort)
18	Bitcoin	Crypto currency system
116	Trustly	Trustly provides payments directly from bank accounts in Europe, and is a popular way to pay in the Nordic countries.
117	PayPal	PayPal is an online payment service that lets customers use their PayPal account to make online purchases.
118	EPS & Giropay	EPS and Giropay allow account holders to easily and quickly pay for purchases using their own online banking service.
120	Przelewy24	Przelewy24 is a real-time bank transfer payment method. Customers based in Poland can use it to transfer funds directly to merchants from their bank accounts.
123	Instant Bank Transfer	Open banking is a banking practice that provides third-party financial service providers open access to consumer banking, transaction, and other financial data from banks and non-bank financial institutions

Response parameters

Parameter name	Type	Description
status	numeric	0 = successful, 2000 = pending, any other value is an error code.
errormessage	alphanumeric	error messages of the payment gateway or empty
transactionid	numeric	payment gateway transaction identification for interfaces preauthorize and authorize
amount	numeric	The amount field contains the transaction’s total amount. This is the amount that will be transmitted to the authorizing system.
currency	char	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
orderid	alphanumeric	The field orderid is optional and exclusively for the merchants convenience.
redirect_url	URL	Used only with Transactions with ‘pending’ errormessage.
user_id	numeric	user_id
payment_guarantee	char	Guarantee of payment for the transaction.

Body Params

merchantid

string

required

Defaults to gateway_test

The merchant identification number issued during account creation.

orderid

string

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

amount

double

required

Defaults to 1.23

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

currency

string

required

Defaults to EUR

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_method

int32

required

Defaults to 17

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

signature

string

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_success

string

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

url_failed

string

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

notification_url

string

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

language

string

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

external_id

string

255 characters. Merchant’s unique id, internal comment

salutation

string

Salutation. Mr., Mrs.

title

string

Title. Dr., Prof.

gender

string

Gender. M – male F – female

firstname

string

First name

lastname

string

Last name

birthday

string

The customer's birthday

street

string

Street of the customer's address.

house

string

The house number of the customer.

postbox

string

Post office box

zip

string

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

city

string

The customer's city

state

string

The state/province (USA and Canada only)

country

string

The country of customer. ISO 3166 alpha3 format only

string

required

Defaults to [email protected]

A RFC 822 compliant email address

phone

string

The customer's phone number. Only numbers

fax

string

The customer's phone number

mobile

string

The mobile number of the customer

company

string

The company

customerid

string

An internal customer id in the merchant’s shop system

customerip

string

The customer's IP address

custom1

string

The custom field for the merchant

custom2

string

The custom field for the merchant

custom3

string

The custom field for the merchant

shipping_country_code

string

3 characters, ISO 3166-1. Used for PayPal

shipping_state

string

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

shipping_address_line_1

string

max 50 characters. Used for PayPal

shipping_address_line_2

string

max 50 characters. Used for PayPal

shipping_postal_code

string

max 16 characters. Used for PayPal

shipping_first_name

string

max 150 characters. Used for PayPal

shipping_last_name

string

max 150 characters. Used for PayPal

shop_url

string

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

Responses

Payment method id

Response parameters

200200

400400