Skip to end of metadata
Go to start of metadata

Introduction

With the "authorization" request the payment process is initiated. According to the type of payment, specific functions are carried out.

This request is only available in the "Shop" version.

Credit card

Card data is verified

Card is charged immediately

Debit payment

Account data is verified

Debit payment is carried out

Online transfer

Account data is verified where applicable

Online transfer session is initialised

Amount will be charged to the account directly after payment is completed

e-wallet

E-wallet session is initialised

Amount will be charged to the account directly after payment is completed

Prepayment

Not supported by this request!

Invoice

Payment process is initialised

Cash on delivery

Payment process is initialised

Financing

For payment type BillSAFE and Klarna it is mandatory to create an invoice after positive acknowledge of this request based on the returned clearing account data. Billing and delivery address need to be identical.

 

PAYONE Business

The request is booked to the transaction account immediately after the successful payment. The time of payment therefore depends on the type of payment. The only exception is payment by invoice or cash on delivery – in this case the request is booked immediately independent of the payment.

The TransactionStatus informs you about the status of the requests. The TransactionStatus communicates, among other things, incoming payments when using the payment type invoice/prepayment and return debit notes or chargebacks if applicable (see Parameter for the TransactionStatus query).

Module invoicing

For invoicing via the PAYONE Platform you must submit all items that shall appear on the invoice. To do so, submit the parameters id[n], pr[n], no[n], de[n], va[n]. Start with item n=1. For all following articles use n=2, n=3, and so on. Accordingly, id[2],pr[2],no[2],de[2],va[2] are the parameters for item 2, and so on.

Attention

  • If a parameter is missing, the whole item will not be considered!
  • [n] starting with [1]; serially numbered; max [400]


Request "authorization"

Common Parameter

RequiredFormatShort explanation

aid

+


Sub-Account ID, defined by PAYONE

Format

NUMERIC(5..6)

clearingtype

+


Format

LIST 
valueCommentDescription / Comments
elvDebit payment

According to the new regulation on the transfer of funds (Geldtransferverordnung) address data (name, street, zip, city) is mandatory for cross border bank transfers (EEA / EWR), e.g.: CH, SM, MC, PM, JE, GG. This is mandatory from 2017-11-19.

Please use request “updateuser” to update customers address data.

This means that the whole address for bank transfers needs to be provided.

ccCredit card
recInvoice
codCash on deliverynot allowed for vauthorization, createaccess, updateaccess
vorPrepaymentnot allowed for vauthorization, createaccess, updateaccess
sbOnline Bank Transfernot allowed for vauthorization, createaccess, updateaccess
wlte-walletnot allowed for vauthorization, createaccess, updateaccess
fncFinancingnot allowed for vauthorization, createaccess, updateaccess
cshCash or Hybrid Paymentsnot allowed for vauthorization, createaccess, updateaccess

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

+


Specifies currency for this transaction


Format

LIST 

Permitted values

 ISO 4217 (currencies) 3-letter-codes

Samples

EUR
USD
GBP

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

recurrence

-


Indicates recurring payments. Currently only supported for PayPal.

Format

LIST 

valueComments

none

a non recurring payment, i.e. a single authorization which might be captures at once or later in one or multiple charges

oneclick

a form of payment on which the cardholder is authenticated only on the initial transaction. Follow-up transactions are authorized without active interaction of the cardholder

recurring

a recurring payment, which has an a priori defined frequency and limit/threshold

installment

a recurring payment, which has an a priori defined frequency, limit/threshold and end date

transaction_param

-


Optional parameter for merchant information (per payment request)

Format

CHAR(1..50)
Permitted Symbols
[0-9][A-Z][a-z][.-_/]

Parameter ( PAYONE Secure Invoice )

clearingsubtype

+


Only valid with “clearingtype=rec”. Used for PAYONE Secure Invoice.

Format

LIST 

Parameter ( PAYONE Business )

settleaccount

-


Carry out settlement of outstanding balances. The request is booked and the resulting balance is settled by means of a collection, e.g. a refund.

Format

LIST 
ValueComment
yesSettlement of outstanding balances is carried out.
noDo not carry out settlement of outstanding balances, book request only.
autoThe system decides - depending on type of payment and balance - if a settlement of balances can be carried out or not. (default)

document_date



Document date (YYYYMMDD)

Format

DATE(8), YYYYMMDD

booking_date

-


Booking date (YYYYMMDD)

Format

DATE(8), YYYYMMDD

due_time

-


Due date (Unixtimestamp)

Format

Unixtimestamp

Parameter ( BillSAFE, Klarna, module Invoicing )

financingtype

+


Used with "clearingtype=fnc" to identify Financing type

Format

LIST 

ValueCommentServer-APIClient-APIFrontend

RPV

Ratepay Open Invoice

(tick)(tick)(tick)

RPS

Ratepay Installments

(tick)(tick)

RPP

Ratepay Prepayment

(tick)(tick)(tick)

RPD

Ratepay Direct Debit

(tick)(tick)(tick)

PYV

Unzer Invoice

(tick)(tick)

PYS

Unzer Installment

(tick)(tick)

PYM

Unzer Monthly

(tick)(tick)

PYD

Unzer Direct Debit

(tick)(tick)
PPIPayPal Installment(tick)(tick)

KLV

Klarna Checkout Invoice

(tick)(tick)

KLS

Klarna Checkout Installment

(tick)(tick)
KISKlarna Payments "Slice it" (Installments)(tick)

KIVKlarna Payments "Pay now" (Invoice)(tick)

KDDKlarna Payments "Pay now" (Direct Debit)(tick)

KBTKlarna Payments "Pay now" (Bank Transfer)(tick)

workorderid

o


The workorderid is a technical id returned from the PAYONE platform to identify a workorder. A workorder is a part of a payment process (identified by a txid). The workorderid is used for the genericpayment request.

Format

CHAR(1..50)

invoiceid

-


Merchant's invoice number

Format

CHAR(1..20)

invoice_deliverymode

-


Parameter defines how documents like invoice, credit notes and reminders should be sent to the customer.

Format

LIST 
ValueComments

M

Postal Mail

P

PDF (via email)

N

no delivery


invoice_deliverydate

-


Delivery date (YYYYMMDD)

Format

DATE(8), YYYYMMDD

invoice_deliveryenddate

-


Delivery end date (YYYYMMDD)

Format

DATE(8), YYYYMMDD

invoiceappendix

-


Dynamic text on the invoice

Format

CHAR(1..255)

it[n]

+


Parameter it[n] specifies the item type of a shopping cart item.

Format

LIST 

Array

Array elements [n] starting with [1]; serially numbered; max [400]


it[n]

Comments


goodsGoods
shipment

Shipping charges


handling

Handling fee

  • Not to be used with PDT
voucherVoucher / discount
  • Not to be used with PDT

id[n]

+


Product number, SKU, etc. of this item

Format

CHAR(1..32)

Array

Array elements [n] starting with [1]; serially numbered; max [400]

Permitted Symbols
[0-9][A-Z][a-z][()[]{} +-_#/:]

pr[n]

+


Unit gross price of the item in smallest unit! e.g. cent

Format

NUMERIC(10) max. 19 999 999 99

Array

Array elements [n] starting with [1]; serially numbered; max [400]

no[n]

+


Quantity of this item

Format

NUMERIC(6)

Array

Array elements [n] starting with [1]; serially numbered; max [400]

de[n]

+


Description of this item. Will be printed on documents to customer.

Format

CHAR(1..255)

Array

Array elements [n] starting with [1]; serially numbered; max [400]

Example
de[1]=Product 1
de[2]=Product 2
de[3]=Product 3
...
de[400]=Product 400

va[n]

-


VAT rate (% or bp)

Format

NUMERIC(4)

Array

Array elements [n] starting with [1]; serially numbered; max [400]

sd[n]

-


Delivery date (YYYYMMDD)

Format

DATE(8), YYYYMMDD

Array

Array elements [n] starting with [1]; serially numbered; max [400]

ed[n]

-


Delivery period end date (YYYYMMDD)

Format

DATE(8), YYYYMMDD

Array

Array elements [n] starting with [1]; serially numbered; max [400]

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

o


Value specifies business relation between merchant and customer

Format

LIST 
valueComment

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

o


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


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

f    
m
d

* 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


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 ( debit payment )

iban

o


IBAN to be used for payment or to be checked

Format

CHAR(10..34)
Permitted Symbols
[0-9][A-Z]

bic

o


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. 

bankcountry

o


Account type/ country for use with BBAN (i.e. bankcode, bankaccount): DE

DE: Mandatory with bankcode, bankaccount, optional with IBAN

For other countries than DE please use IBAN or IBAN/BIC

Format

LIST 

bankaccount

o


Account number (BBAN)

  • DE: bankcountry, bankcode and bankaccount may be used. Then IBAN will be generated by PAYONE platform and used for SEPA transactions.
  • Not DE: Please use IBAN or IBAN / BIC.

Format

NUMERIC(1..10)

bankcode

o


Sort code (BBAN) (only in DE)

  • DE: bankcountry, bankcode and bankaccount may be used. Then IBAN will be generated by PAYONE platform and used for SEPA transactions.
  • Not DE: Please use IBAN or IBAN / BIC.

Format

NUMERIC(8)

bankaccountholdero

Account holder


Format

CHAR(1..50)

mandate_identification

o


A SEPA mandate can be created if a payment is initiated (amount > 0). Can be used to enforce a merchant specific mandate identification. The mandate_identification has to be unique.

Format

CHAR(1..35)
Permitted Symbols
[A-Z,a-z,0-9,+,-,.,(,)]

If the mandate_identification is not set PAYONE will create an unique mandate identification (pattern: PO-nnnnnnnnnn).

PPS (PAYONE Payment Service): This parameter must not be used! For PPS the PAYONE platform defines the mandate_identification

Parameter ( online transfer )         

onlinebanktransfertype

+


Format

LIST 

Value

Comment

Server-APIClient-API

Frontend

BCTBancontact(tick)(tick)(minus)
EPSeps – online transfer (AT)(tick)(tick)(tick)
GPYgiropay (DE)(tick)(tick)(tick)
IDLiDEAL (NL)(tick)(tick)(tick)
MBCMultibanco(tick)(tick)(minus)
MYBMyBank(tick)(tick)(minus)
P24Przelewy24 (PL)(tick)(tick)(tick)
PFFPostFinance E-Finance (CH)(tick)(tick)(tick)
PFCPostFinance Card (CH)(tick)(tick)(tick)
PNTSOFORT Überweisung(tick)(tick)(tick)
TRLTrustly(tick)(tick)(minus)
VKPVerkkopankki(tick)(tick)(minus)

bankcountry

+


Account type/ country for use with BBAN (i.e. bankcode, bankaccount): DE

DE: Mandatory with bankcode, bankaccount, optional with IBAN

For other countries than DE please use IBAN or IBAN/BIC

Format

LIST 
ValuesonlinebanktransfertypePayment type
BEBCTBancontact
ATEPSEPS
DEGPYGiropay
NLIDLiDEAL
PTMBCMultibanco
ITMYBMyBank
PLP24Przelewy24 (P24)
CHPFCPostFinanceCard
CHPFFPost E-Finance
DE;AT;CH;NL;PL;BEPNTSOFORT
DE;DK;EE;ES;FI;IT;MT;NL;NO;PL;SETRLTrustly
FIVKPVerkkopankki

bankaccount

o


Account number (BBAN)

  • DE: bankcountry, bankcode and bankaccount may be used. Then IBAN will be generated by PAYONE platform and used for SEPA transactions.
  • Not DE: Please use IBAN or IBAN / BIC.

Format

NUMERIC(1..10)

bankcode

o


Sort code (BBAN) (only in DE)

  • DE: bankcountry, bankcode and bankaccount may be used. Then IBAN will be generated by PAYONE platform and used for SEPA transactions.
  • Not DE: Please use IBAN or IBAN / BIC.

Format

NUMERIC(8)

bankgrouptype

o


Issuer of Online-Bank-Transfer used for iDEAL and EPS

Format

LIST 

iban

o


IBAN to be used for payment or to be checked

Format

CHAR(10..34)
Permitted Symbols
[0-9][A-Z]

bic

o


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}

ipo

Mandatory for P24 (PAC)

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

Format

CHAR(1..39)

Parameter ( e-wallet )

wallettype

+


Used with "clearingtype=wlt" to identify wallet payment types

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}

Parameter ( cash on delivery )

shippingprovider

+


Shipping Provider

Format

LIST 
Shipping ProviderComment
DHL

DHL, Germany

Parameter ( credit card )

cardpan

+


Primary account number of credit card

Format

NUMERIC(13..19)

  • if your system handles "cardpan" directly you can not be PCI DSS SAQ A compliant.
  • for simple PCI DSS SAQ A compliance please use PAYONE hosted iFrames together with pseudocardpan.

cardtype

+


Card type of credit card

Format

LIST 
valueCommentBIN-Range for automatic card type detection

V

Visa

4

M

MasterCard

51-55,2221-2720

A

American Express

34, 37
DDiners / Discover

300-305,3095,36,38,39

601, 64, 65

CDiscover

J

JCB

3528-3589

O

Maestro International

50, 56-58,602, 61, 620, 627, 63, 67
PChina Union Pay62212600-62299800,624-626, 6282-6288
UUATP / Airplus1220, 1920 -> coming soon; not available yet
Ggirocard68 *

*girocard is currently only viable for e-commerce-payments via Apple Pay.

cardexpiredate

+


Credit card expiry date YYMM


Format

NUMERIC(4), YYMM

cardcvc2

o


Credit card security number

Format

NUMERIC(3..4)

For SAQ A compliance: PAYONE Frontend hosted iFrame must be used. This parameter must not be used.

cardissuenumber

-


Card issue number (only Maestro UK cards)

Format

NUMERIC(1..2)

cardholder

-


Cardholder of credit card.


Format

CHAR(1..50)

ecommercemode

-


Specifies how the payment transaction should be processed - if not default.

Format

LIST 

valueComments

internet

eCommerce Transaction (SSL secured)

3dsecure

3-D Secure transaction (can be enabled alternatively in the risk settings)

moto

Mail or telephone order transaction

Parameter ( credit card with pseudo card number )

pseudocardpan

+


Pseudo primary account number for a credit card.

Format

NUMERIC(16..19)

Parameter ( 3-D Secure )

xid

o


  • either "xid" (from previous 3dscheck)
  • or "successurl", "errorurl", "backurl" must be given.

3-D Secure transaction ID (if the request "3dscheck" was used previous transactions), i.e.:

Format

CHAR(1..60)

cavv

-


3-D Secure authentication value

Format

CHAR(1..40)

eci

-


3-D Secure e-commerce indicator

Format

CHAR(1..2)

successurl

o


  • either "xid" (from previous 3dscheck)
  • or "successurl", "errorurl", "backurl" must be given
  • or default "successurl" and "backurl" for a portal are configured within PMI

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

+


  • either "xid" (from previous 3dscheck)
  • or "successurl", "errorurl", "backurl" must be given.

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

o


  • either "xid" (from previous 3dscheck)
  • or "successurl", "errorurl", "backurl" must be given
  • or default "successurl" and "backurl" for a portal are configured within PMI

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}


Response "authorization"

Common Parameter

Required

Format

Comment

status

+

Default

APPROVED / REDIRECT / ERROR / PENDING

Parameter (APPROVED)

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 (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 (REDIRECT) (3-D Secure/online transfer/e-wallet)

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)

Parameter ( credit card – if AVS has been ordered)

protect_result_avs

-

A1

AVS return value, see AVS-Returns (protect_result_avs)

Parameter ( prepayment/invoice/cash on delivery )

clearing_bankaccountholder

+

AN..35

Recipient bank account holder

clearing_bankcountry

+

Default

Recipient account type/ country (e.g. DE, AT, etc.)

clearing_bankaccount

+

AN..26

Recipient account number

clearing_bankcode

o

AN..11

Recipient sort code

clearing_bankiban

-

AN..35

Recipient IBAN

clearing_bankbic

-

AN..11

Recipient BIC

clearing_bankcity

-

AN..50

Recipient city or bank

clearing_bankname

-

AN..50

Recipient bank name

clearing_instructionnote

o

AN..200

For KLV, KLS: A URL pointing to a PDF of the invoice (If invoice by post or by e-mail isn’t activated). The URL is valid for 30 days.

Parameter ( direct debit )

mandate_identification

-

AN..35

used mandate_identification for debit payment

mandate_dateofsignature

-

N..10

date when mandate has been created

(format YYYYMMDD)

creditor_identifier

-

AN..35

used CID for debit payment

creditor_name

-

AN..35

as recorded in PAYONE Platform

creditor_street

-

AN..35

as recorded in PAYONE Platform

creditor_zip

-

AN..10

as recorded in PAYONE Platform

creditor_city

-

AN..50

as recorded in PAYONE Platform

creditor_country

-

Default

Country (ISO 3166)

creditor_email

-

AN..254

as recorded in PAYONE Platform

clearing_date

-

N..8

only provided if due_time is not specified

clearing_amount

-

N..10

only provided if due_time is not specified


Content


  • No labels