Special remarks - Multibanco

Preauthorization

Request "preauthorization"

Common Parameter

Required

Comment

aid

+

Sub-Account ID, defined by PAYONE

Format

NUMERIC(5..6)

clearingtype

+

Fixed Value

sb

reference

+

Merchant reference number for the payment process (case insensitive)

Format

CHAR(1..20)

Permitted Symbols

[0-9][a-z][A-Z], .,-,_,/

amount

+

Specifies the total gross amount of a payment transaction.

Value is given in smallest currency unit, e.g. Cent of Euro; Pence of Pound sterling; Öre of Swedish krona.

The amount must be less than or equal to the amount of the corresponding booking.

Format

NUMERIC(1..10)

Permitted values

max. +/- 19 999 999 99

currency

+

Fixed Value

EUR

param

-

Individual parameter (per payment process)

Format

CHAR(1..255)

narrative_text

-

Dynamic text element on account statements

Format

CHAR(1..81)

(3 lines with 27 characters each) and credit card statements.

customer_is_present

-

Indicates whether customer is “present” and can enter their data in the shop (=yes). Or customer is not present and can not enter any data (=no).

Format

LIST

Permitted Values

yes

no

Parameter ( personal data )

customerid

-

Merchant's customer ID, defined by you / merchant to refer to the customer record

Format

CHAR(1..20)

Permitted Symbols

[0-9, a-z, A-Z, .,-,_,/]

"customerid" can be used to identify a customer record.
If "customerid" is used then stored customer data are loaded automatically.

userid

-

PAYONE User ID, defined by PAYONE

Format

NUMERIC(6..12)

businessrelation

-

Value specifies business relation between merchant and customer

Format

LIST

value	Comment
b2c	Indicates business to private customer
b2b	indicates business to business customer (company)

salutation

-

The customer's salutation

Format

CHAR(1..10)

title

-

Title of the customer

Format

CHAR(1..20)

Samples

Dr

Prof.

Dr.-Ing.

firstname

-

First name of customer; optional if company is used, i.e.: you may use

"company"
or "lastname"
or "firstname" plus "lastname"

Format

CHAR(1..50)

lastname

+

Last name of customer; optional if company is used, i.e.: you may use

"company"
or "lastname"
or "firstname" plus "lastname"

Format

CHAR(2..50)

company

-

Company name of customer; The company name is optional if lastname is used, i.e.: you may use

"company"
or "lastname"
or "firstname" plus "lastname"

Format

CHAR(2..50)

street

-

Street number and name (required: at least one character)

Format

CHAR(1..50)

addressaddition

-

Specifies an additional address line for the invoice address of the customer.

Format

CHAR(1..50)

Samples

7th floor

c/o Maier

zip

-

Postcode

Format

CHAR(2..10)

Permitted Symbols

[0-9][A-Z][a-z][_.-/ ]

city

-

City of customer

Format

CHAR(2..50)

country

+

Specifies country of address for the customer

Format

LIST

Permitted values

ISO 3166 2-letter-codes

Samples

DE

GB

US

Some countries require additional information in parameter "state"

state

-

Specifies state / region of country for the customer.

"state" is required for these countries: US, CA, CN, JP, MX, BR, AR, ID, TH, IN and must not be used for all other countries.

Format

LIST

Permitted values

ISO 3166-2 States (regions)  2-letter-codes

Samples US

AK

AL

AR

Samples CA

AB

BC

email

-

email-address of customer

Format

CHAR(5..254)

Permitted Symbols

RFC 5322

Special Remark email validation:

Max. length for email is 254 characters. Validation is set up in the following way:

Username = Max. 63 characters
Domain Name = Max. 63 characters
Domain Suffixes = Max. 4 suffixes with max. 124 characters

Example: username[63]@domain_name[63].suffix[60].suffix[60].suffix[4]

"@" and "." is counted as a character as well; in case of a total of three suffixes, this would allow a total of 254 characters.

telephonenumber

-

Phone number of customer

Format

CHAR(1..30)

birthday

-

Date of birth of customer

Format

DATE(8), YYYYMMDD

Samples

20190101

19991231

language

-

Language indicator (ISO 639) to specify the language that should be presented to the customer (e.g. for error messages, frontend display).

If the language is not transferred, the browser language will be used. For a non-supported language English will be used.

Format

LIST

Permitted values

ISO 639-1 (Language) 2-letter-codes

vatid

-

VAT identification number. Used for b2b transactions to indicate VAT number of customer.

Format

CHAR(1..50)

gender

-

Gender of customer (female / male / diverse* )

Format

LIST

Permitted values

* currently not in use

personalid

-

Person specific numbers or characters, e.g. number of passport / ID card

Format

CHAR(1..32)

Permitted Symbols

[0-9][A-Z][a-z][+-./()]

ip

-

Customer's IP-V4-address (123.123.123.123) or IP-V6-address

Format

CHAR(1..39)

Parameter ( delivery data )

shipping_firstname

-

First name of delivery address

Format

CHAR(1..50)

shipping_lastname

-

Surname of delivery address

Format

CHAR(1..50)

shipping_company

-

Company Name of the delivery address

Format

CHAR(2..50)

shipping_street

-

Street number and name of delivery address

Format

CHAR(2..50)

shipping_zip

-

Postcode of delivery address

Format

CHAR(2..10)

Permitted Symbols

[0-9][A-Z][a-z][_.-/ ]

shipping_addressaddition

-

Specifies an additional address line for the delivery address of the customer, e.g. "7th floor", "c/o Maier".

Format

CHAR(1..50)

shipping_city

-

City of delivery address

Format

CHAR(2..50)

shipping_state

o

Specifies state of country of delivery address for the customer

"shipping_state" is required for these countries: US, CA, CN, JP, MX, BR, AR, ID, TH, IN (if shipping_country is given) and must not be used in all other countries.

Format

LIST

Permitted values

ISO 3166-2 States (regions)  2-letter-codes

Samples US

AK

AL

AR

Samples CA

AB

BC

shipping_country

-

Specifies country of delivery address for the customer

Format

LIST

Permitted values

ISO 3166 2-letter-codes

Samples

DE

GB

US

Some countries require additional information in parameter shipping_state

Parameter ( online transfer )

onlinebanktransfertype

+

Fixed Value

MBC

bankcountry

+

Fixed Value

PT

iban

-

Bank Identifier Code to be used for payment or to be checked

Format

CHAR(8 or 11) Only capital letters and digits, no spaces

Permitted Symbols

[0-9][A-Z]

BIC is optional for all Bank transfers within SEPA. For Accounts from Banks outside of SEPA, BIC is still required.

bic

-

Bank Identifier Code to be used for payment or to be checked

Format

CHAR(8 or 11) Only capital letters and digits, no spaces

Permitted Symbols

[0-9][A-Z]

BIC is optional for all Bank transfers within SEPA. For Accounts from Banks outside of SEPA, BIC is still required.

successurl

+

URL for "payment successful"

Format

CHAR(2..255)

Scheme

<scheme>://<host>/<path>

<scheme>://<host>/<path>?<query>

scheme-pattern: [a-zA-Z]{1}[a-zA-Z0-9]{1,9}

errorurl

+

URL for "faulty payment"

Format

CHAR(2..255)

Scheme

<scheme>://<host>/<path>

<scheme>://<host>/<path>?<query>

scheme-pattern: [a-zA-Z]{1}[a-zA-Z0-9]{1,9}

backurl

+

URL for "Back" or "Cancel"

Format

CHAR(2..255)

Scheme

<scheme>://<host>/<path>

<scheme>://<host>/<path>?<query>

scheme-pattern: [a-zA-Z]{1}[a-zA-Z0-9]{1,9}

preauthorization example request

mid=23456 (your mid)
portalid=12345123 (your portalid)
key=abcdefghijklmn123456789 (your key)
api_version=3.10
mode=test (set to „live“ for live-requests)
request=preauthorization
encoding=UTF-8

aid=12345 (your aid)
clearingtype=sb
reference=Ref123456
amount=300
currency=EUR
lastname=Dos Santos
country=PT

onlinebanktransfertype=MBC
bankcountry=PT

successurl=http://www.your-success.url
errorurl=http://www.your-error.url
backurl=http://www.your-back.url

Common Parameter	Required	Comment
Response "preauthorization"
status	+	Permitted Values REDIRECT ERROR
Parameter (REDIRECT)
txid	+	The txid specifies the payment process within the PAYONE platform Format NUMERIC(9..12)
userid	+	PAYONE User ID, defined by PAYONE Format NUMERIC(6..12)
redirecturl	+	Redirect URL → zMerchant system has to redirect customer to this URL to complete payment Format CHAR(2..2000)
Parameter (ERROR)
errorcode	+	In case of error the PAYONE Platform returns an error code for your internal usage. Format NUMERIC(1..6)
errormessage	+	In case of error the PAYONE Platform returns an error message for your internal usage. Format CHAR(1..1024)
customermessage	-	The customermessage is returned to your system in order to be displayed to the customer. (Language selection is based on the end customer's language, parameter "language") Format CHAR(1..1024)

preauthorization example response REDIRECT

status=REDIRECT
redirecturl=http://www.aliasregistrationpage.com
txid=345678901
userid=123456789

Capture

Common Parameter	Required	Short explanation
Request "capture"
txid	+	The txid specifies the payment process within the PAYONE platform Format NUMERIC(9..12)
sequencenumber	o	Sequence number for this transaction within the payment process (1..n), e.g. PreAuthorization: 0, 1. Capture: 1, 2. Capture: 2 Required for multi partial capture (starting with the 2^nd capture) Format NUMERIC(1..3) Permitted values 0..127
amount	+	Specifies the total gross amount of a payment transaction. Value is given in smallest currency unit, e.g. Cent of Euro; Pence of Pound sterling; Öre of Swedish krona. The amount must be less than or equal to the amount of the corresponding booking. Format NUMERIC(1..10) Permitted values max. +/- 19 999 999 99
currency	+	Fixed Value EUR
narrative_text	-	Dynamic text element on account statements Format CHAR(1..81) (3 lines with 27 characters each) and credit card statements.

capture example request

mid=23456 (your mid)
portalid=12345123 (your portalid)
key=abcdefghijklmn123456789 (your key)
api_version=3.10
mode=test (set to „live“ for live-requests)
request=capture
encoding=UTF-8

txid=345678901
amount=300
currency=EUR

Response "capture"

Common Parameter

Required

Comment

status

+

Permitted Values

APPROVED

PENDING ???

ERROR

Parameter (APPROVED)

txid

+

The txid specifies the payment process within the PAYONE platform

Format

NUMERIC(9..12)

settleaccount

o ????

Provides information about whether a settlement of balances has been carried out.

Format

LIST

Value	Comment
yes	Settlement of outstanding balances has been carried out.
no	Settlement of outstanding balances has not been carried out.

Parameter (PENDING)

txid

+

The txid specifies the payment process within the PAYONE platform

Format

NUMERIC(9..12)

userid

+

PAYONE User ID, defined by PAYONE

Format

NUMERIC(6..12)

Parameter (ERROR)

errorcode

+

In case of error the PAYONE Platform returns an error code for your internal usage.

Format

NUMERIC(1..6)

errormessage

+

In case of error the PAYONE Platform returns an error message for your internal usage.

Format

CHAR(1..1024)

capture example response

status=APPROVED
txid=345678901
settleaccount=no

Authorization

Request "authorization"

Common Parameter

Required

Short explanation

aid

+

Sub-Account ID, defined by PAYONE

Format

NUMERIC(5..6)

clearingtype

+

Fixed Value

sb

reference

+

Merchant reference number for the payment process (case insensitive)

Format

CHAR(1..20)

Permitted Symbols

[0-9][a-z][A-Z], .,-,_,/

amount

+

Specifies the total gross amount of a payment transaction.

Value is given in smallest currency unit, e.g. Cent of Euro; Pence of Pound sterling; Öre of Swedish krona.

The amount must be less than or equal to the amount of the corresponding booking.

Format

NUMERIC(1..10)

Permitted values

max. +/- 19 999 999 99

currency

+

Fixed Value

EUR

param

-

Individual parameter (per payment process)

Format

CHAR(1..255)

narrative_text

-

Dynamic text element on account statements

Format

CHAR(1..81)

(3 lines with 27 characters each) and credit card statements.

customer_is_present

-

Indicates whether customer is “present” and can enter their data in the shop (=yes). Or customer is not present and can not enter any data (=no).

Format

LIST

Permitted Values

yes

no

transaction_param

-

Optional parameter for merchant information (per payment request)

Format

CHAR(1..50)

Permitted Symbols

[0-9][A-Z][a-z][.-_/]

Parameter ( personal data )

customerid

-

Merchant's customer ID, defined by you / merchant to refer to the customer record

Format

CHAR(1..20)

Permitted Symbols

[0-9, a-z, A-Z, .,-,_,/]

"customerid" can be used to identify a customer record.
If "customerid" is used then stored customer data are loaded automatically.

userid

-

PAYONE User ID, defined by PAYONE

Format

NUMERIC(6..12)

businessrelation

-

Value specifies business relation between merchant and customer

Format

LIST

value	Comment
b2c	Indicates business to private customer
b2b	indicates business to business customer (company)

salutation

-

The customer's salutation

Format

CHAR(1..10)

title

-

Title of the customer

Format

CHAR(1..20)

Samples

Dr

Prof.

Dr.-Ing.

firstname

-

First name of customer; optional if company is used, i.e.: you may use

"company"
or "lastname"
or "firstname" plus "lastname"

Format

CHAR(1..50)

lastname

+

Last name of customer; optional if company is used, i.e.: you may use

"company"
or "lastname"
or "firstname" plus "lastname"

Format

CHAR(2..50)

company

-

Company name of customer; The company name is optional if lastname is used, i.e.: you may use

"company"
or "lastname"
or "firstname" plus "lastname"

Format

CHAR(2..50)

street

-

Street number and name (required: at least one character)

Format

CHAR(1..50)

addressaddition

-

Specifies an additional address line for the invoice address of the customer.

Format

CHAR(1..50)

Samples

7th floor

c/o Maier

zip

-

Postcode

Format

CHAR(2..10)

Permitted Symbols

[0-9][A-Z][a-z][_.-/ ]

city

-

City of customer

Format

CHAR(2..50)

state

-

Specifies state / region of country for the customer.

"state" is required for these countries: US, CA, CN, JP, MX, BR, AR, ID, TH, IN and must not be used for all other countries.

Format

LIST

Permitted values

ISO 3166-2 States (regions)  2-letter-codes

Samples US

AK

AL

AR

Samples CA

AB

BC

country

+

Specifies country of address for the customer

Format

LIST

Permitted values

ISO 3166 2-letter-codes

Samples

DE

GB

US

Some countries require additional information in parameter "state"

email

-

email-address of customer

Format

CHAR(5..254)

Permitted Symbols

RFC 5322

Special Remark email validation:

Max. length for email is 254 characters. Validation is set up in the following way:

Username = Max. 63 characters
Domain Name = Max. 63 characters
Domain Suffixes = Max. 4 suffixes with max. 124 characters

Example: username[63]@domain_name[63].suffix[60].suffix[60].suffix[4]

"@" and "." is counted as a character as well; in case of a total of three suffixes, this would allow a total of 254 characters.

telephonenumber

-

Phone number of customer

Format

CHAR(1..30)

birthday

-

Date of birth of customer

Format

DATE(8), YYYYMMDD

Samples

20190101

19991231

language

-

Language indicator (ISO 639) to specify the language that should be presented to the customer (e.g. for error messages, frontend display).

If the language is not transferred, the browser language will be used. For a non-supported language English will be used.

Format

LIST

Permitted values

ISO 639-1 (Language) 2-letter-codes

vatid

-

VAT identification number. Used for b2b transactions to indicate VAT number of customer.

Format

CHAR(1..50)

gender

-

Gender of customer (female / male / diverse* )

Format

LIST

Permitted values

* currently not in use

personalid

-

Person specific numbers or characters, e.g. number of passport / ID card

Format

CHAR(1..32)

Permitted Symbols

[0-9][A-Z][a-z][+-./()]

ip

-

Customer's IP-V4-address (123.123.123.123) or IP-V6-address

Format

CHAR(1..39)

Parameter ( delivery data )

shipping_firstname

-

First name of delivery address

Format

CHAR(1..50)

shipping_lastname

-

Surname of delivery address

Format

CHAR(1..50)

shipping_company

-

Company Name of the delivery address

Format

CHAR(2..50)

shipping_street

-

Street number and name of delivery address

Format

CHAR(2..50)

shipping_addressaddition

-

Specifies an additional address line for the delivery address of the customer, e.g. "7th floor", "c/o Maier".

Format

CHAR(1..50)

shipping_zip

-

Postcode of delivery address

Format

CHAR(2..10)

Permitted Symbols

[0-9][A-Z][a-z][_.-/ ]

shipping_city

-

City of delivery address

Format

CHAR(2..50)

shipping_state

-

Specifies state of country of delivery address for the customer

"shipping_state" is required for these countries: US, CA, CN, JP, MX, BR, AR, ID, TH, IN (if shipping_country is given) and must not be used in all other countries.

Format

LIST

Permitted values

ISO 3166-2 States (regions)  2-letter-codes

Samples US

AK

AL

AR

Samples CA

AB

BC

shipping_country

-

Specifies country of delivery address for the customer

Format

LIST

Permitted values

ISO 3166 2-letter-codes

Samples

DE

GB

US

Some countries require additional information in parameter shipping_state

Parameter ( online transfer )

onlinebanktransfertype

+

Fixed Value

MBC

bankcountry

+

Fixed Value

PT

iban

-

IBAN to be used for payment or to be checked

Format

CHAR(10..34)

Permitted Symbols

[0-9][A-Z]

bic

-

Bank Identifier Code to be used for payment or to be checked

Format

CHAR(8 or 11) Only capital letters and digits, no spaces

Permitted Symbols

[0-9][A-Z]

BIC is optional for all Bank transfers within SEPA. For Accounts from Banks outside of SEPA, BIC is still required.

successurl

+

URL for "payment successful"

Format

CHAR(2..255)

Scheme

<scheme>://<host>/<path>

<scheme>://<host>/<path>?<query>

scheme-pattern: [a-zA-Z]{1}[a-zA-Z0-9]{1,9}

errorurl

+

URL for "faulty payment"

Format

CHAR(2..255)

Scheme

<scheme>://<host>/<path>

<scheme>://<host>/<path>?<query>

scheme-pattern: [a-zA-Z]{1}[a-zA-Z0-9]{1,9}

backurl

+

URL for "Back" or "Cancel"

Format

CHAR(2..255)

Scheme

<scheme>://<host>/<path>

<scheme>://<host>/<path>?<query>

scheme-pattern: [a-zA-Z]{1}[a-zA-Z0-9]{1,9}

authorization example request

mid=23456 (your mid)
portalid=12345123 (your portalid)
key=abcdefghijklmn123456789 (your key)
api_version=3.10
mode=test (set to „live“ for live-requests)
request=authorization
encoding=UTF-8

aid=12345 (your aid)
clearingtype=sb
reference=Ref123456
amount=300
currency=EUR
lastname=Dos Santos
country=PT

onlinebanktransfertype=MBC
bankcountry=PT

successurl=http://www.your-success.url
errorurl=http://www.your-error.url
backurl=http://www.your-back.url

Common Parameter	Required	Comment
Response "authorization"
status	+	Permitted Values REDIRECT ERROR
Parameter (REDIRECT)
txid	+	The txid specifies the payment process within the PAYONE platform Format NUMERIC(9..12)
userid	+	PAYONE User ID, defined by PAYONE Format NUMERIC(6..12)
redirecturl	+	Redirect URL → zMerchant system has to redirect customer to this URL to complete payment Format CHAR(2..2000)
Parameter (ERROR)
errorcode	+	In case of error the PAYONE Platform returns an error code for your internal usage. Format NUMERIC(1..6)
errormessage	+	In case of error the PAYONE Platform returns an error message for your internal usage. Format CHAR(1..1024)
customermessage	-	The customermessage is returned to your system in order to be displayed to the customer. (Language selection is based on the end customer's language, parameter "language") Format CHAR(1..1024)

authorization example response

status=REDIRECT
redirecturl=http://www.aliasregistrationpage.com
txid=345678901
userid=123456789

Specials

Partial Captures are supported but the account of the customer will be debit with the Preauthorization ?????
Partial Refunds are not supported ?????
Reversal is not supported ?????

Page tree

Preauthorization

Request "preauthorization"

Common Parameter

Parameter ( personal data )

Parameter ( delivery data )

Parameter ( online transfer )

Response "preauthorization"

Common Parameter

Parameter (REDIRECT)

Parameter (ERROR)

Capture

Request "capture"

Common Parameter

Response "capture"

Parameter (APPROVED)

Parameter (PENDING)

Parameter (ERROR)

Authorization

Request "authorization"

Common Parameter

Parameter ( personal data )

Parameter ( delivery data )

Parameter ( online transfer )

Response "authorization"

Common Parameter

Parameter (REDIRECT)

Parameter (ERROR)

Specials

Examples of Usage

Sale

Order & Delivery

Social Media

PAYONE

Help

Intranet Tools