Platform
Page tree
Skip to end of metadata
Go to start of metadata

Introduction

Create a pending mandate – used for SEPA Direct Debit.

Mandate will be activated and persisted by a payment-request (preauthorization / authorization) or by customer management (updateuser) – this request has to follow a “managemandate”-request within 2 hours.


Request "managemandate"

Common Parameter

RequiredFormatComment

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

mandate_identification

-


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


currency

+


Specifies currency for this transaction


Format

LIST

Permitted values

 ISO 4217 (currencies) 3-letter-codes

Samples

EUR
USD
GBP

Parameter ( personal data )

customerid

o


  • either existing customerid
  • or existing userid
  • or lastname/city/(bankcountry)/IBAN/BIC

must be given.

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

o


Debtor ID (PAYONE)

userid must already exist and mode (test/live) must must match. If userid is used then personal data are loaded automatically.

PAYONE User ID, defined by PAYONE

Format

NUMERIC(6..12)

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)

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)

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

Format

CHAR(1..50)

zip

-


Postcode

Format

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

city

o


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"

email

o


email-address of customer

Format

CHAR(5..254)
Permitted Symbols
RFC 5322

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

Parameter ( bank account data – Germany only )

optional if already recorded at existing customer referenced by userid/customerid

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

bankaccount

+


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

+


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)

Parameter ( bank account data – Germany plus all other countries )

optional if already recorded at existing customer referenced by userid/customerid

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

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)
Permitted Symbols
[0-9][A-Z]


Response "managemandate"

Common Parameter

RequiredFormatComment

status

+

Default

APPROVED / ERROR

Parameter (APPROVED)

mandate_identification

+


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

mandate_status

+


Status of SEPA mandate

Format

LIST
ValueComment
pending

indicates a new created mandate

Pending mandate has to be used within 2 hours by authorization / preauthorization to complete a payment.

activeindicates an existing / active mandate

mandate_text

+


Content of mandate text

HTML-formatted, URL-encoded

Format

TEXT

creditor_identifier

+


Creditor identifier as recorded at PAYONE

Format

CHAR(1..35)

iban

+


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)
Permitted Symbols
[0-9][A-Z]

Parameter (ERROR)

-> current response for erroneous (wrong parameters) and invalid (invalid data in requests) requests; will be always used for erroneous requests

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)


Content


  • No labels