Initiate a transaction

post

https://pay4.sandbox.payabl.com/pay/payment/init

Form Data

merchantid

string

required

Defaults to gateway_test

The merchant identification number issued during account creation.

orderid

string

Defaults to API-Iframe-Test1

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

amount

float

required

Defaults to 8.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

signature

string

required

Defaults to ddf0659438b91981376169d8a77fd80f39fbfd08

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

payment_method

int32

Valid payment method id, e.g. 1 = Credit Card

url_return

string

required

Defaults to https://payabl.com/results

Used for redirecting the customer after the end of transaction. Format: http://www.result.com

recurring_id

string

The recurring_id field is just needed, if you want to send recurring transactions. Therefore the first transaction needs to be classified with INIT. In that transaction the cvc_code is mandatory.

language

string

Defaults to en

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

external_id

string

Merchant unique id

salutation

string

salutation. Format: Mr., Mrs.

title

string

title. Format: Dr., Prof.

gender

string

Defaults to M

gender. Format: M – male F – female

firstname

string

required

Defaults to George

max. 30 characters. First name of the customer

lastname

string

required

Defaults to Giraffe

max. 30 characters. Surname of the customer

birthday

int32

birthday. Format: ddmmyyyy. Mandatory for AFT

street

string

street. Mandatory for AFT

house

string

house number

postbox

string

post office box

zip

string

max. 10 characters. The customer's postal code. Mandatory for AFT

city

string

city. Mandatory for AFT

state

string

required

max. 30 characters. The state/province (USA and Canada only).

country

string

Format: country (ISO 3166 alpha3). Mandatory for AFT

string

required

Defaults to [email protected]

e-mail address

phone

int32

phone number. Only numbers

fax

int32

fax number. Format: (blank, +, -, (, ))

mobile

int32

mobile number. Format: (blank, +, -, (, ))

company

string

company

customerid

string

internal customer id in the merchant’s shop system

customerip

string

required

Defaults to 192.168.2.2

customer IP (IPv4). Format: NNN.NNN.NNN.NNN

custom1

string

custom field for merchant. Format: ^(?:(\s*)|(?=[^ ])(?:[A-Za-z0-9.:,;-+*/ ]{1,25}[A-Za-z0-9.:,;-+*/ ]{0,13}))$

custom2

string

custom field for merchant. Format: ^(?:(\s*)|(?=[^ ])(?:[A-Za-z0-9.:,;-+*/ ]{1,25}[A-Za-z0-9.:,;-+*/ ]{0,13}))$

custom3

string

custom field for merchant. Format: ^(?:(\s*)|(?=[^ ])(?:[A-Za-z0-9.:,;-+*/ ]{1,25}[A-Za-z0-9.:,;-+*/ ]{0,13}))$

notification_url

string

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

shop_url

string

max 255 characters starting with http or https.

Responses

200200

400400