- Created by PAYONE Admin on 2019-05-03
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 | Required | Format | Comment | ||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
+ |
Sub-Account ID, defined by PAYONE Format NUMERIC(5..6)
| ||||||||||||||||||||||||||||||||
+ |
Format LIST
| ||||||||||||||||||||||||||||||||
- |
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
| ||||||||||||||||||||||||||||||||
+ |
Specifies currency for this transaction Format LIST Permitted values ISO 4217 (currencies) 3-letter-codes Samples EUR USD GBP
| ||||||||||||||||||||||||||||||||
Parameter ( personal data ) | |||||||||||||||||||||||||||||||||
o |
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, .,-,_,/]
| ||||||||||||||||||||||||||||||||
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)
| ||||||||||||||||||||||||||||||||
+ |
Last name of customer; optional if company is used, i.e.: you may use
Format CHAR(2..50)
| ||||||||||||||||||||||||||||||||
- |
First name of customer; optional if company is used, i.e.: you may use
Format CHAR(1..50)
| ||||||||||||||||||||||||||||||||
- |
Company name of customer; The company name is optional if lastname is used, i.e.: you may use
Format CHAR(2..50)
| ||||||||||||||||||||||||||||||||
- |
Street number and name (required: at least one character) Format CHAR(1..50)
| ||||||||||||||||||||||||||||||||
- |
Postcode Format CHAR(2..10) Permitted Symbols
[0-9][A-Z][a-z][
| ||||||||||||||||||||||||||||||||
o |
City of customer Format CHAR(2..50) only optional if already recorded at existing customer referenced by userid/customerid | ||||||||||||||||||||||||||||||||
+ | |||||||||||||||||||||||||||||||||
o |
email-address of customer Format CHAR(5..254) Permitted Symbols
RFC 5322
| ||||||||||||||||||||||||||||||||
- |
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 | |||||||||||||||||||||||||||||||||
+ |
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
| ||||||||||||||||||||||||||||||||
+ |
Account number (BBAN)
Format NUMERIC(1..10)
| ||||||||||||||||||||||||||||||||
+ |
Sort code (BBAN) (only in DE)
Format NUMERIC(8)
| ||||||||||||||||||||||||||||||||
Parameter ( bank account data – Germany plus all other countries )optional if already recorded at existing customer referenced by userid/customerid | |||||||||||||||||||||||||||||||||
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 to be used for payment or to be checked Format CHAR(10..34) Permitted Symbols
[0-9][A-Z]
| ||||||||||||||||||||||||||||||||
+ |
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.
| ||||||||||||||||||||||||||||||||
Response "managemandate" | |||||||||
Common Parameter | Required | Format | Comment | ||||||
|---|---|---|---|---|---|---|---|---|---|
status | + | Default | APPROVED / ERROR | ||||||
Parameter (APPROVED) | |||||||||
+ |
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
| ||||||||
+ |
Status of SEPA mandate Format LIST
| ||||||||
+ |
Content of mandate text HTML-formatted, URL-encoded Format TEXT
| ||||||||
+ |
Creditor identifier as recorded at PAYONE Format CHAR(1..35)
| ||||||||
+ |
IBAN to be used for payment or to be checked Format CHAR(10..34) Permitted Symbols
[0-9][A-Z]
| ||||||||
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.
| ||||||||
Parameter (ERROR)-> current response for erroneous (wrong parameters) and invalid (invalid data in requests) requests; will be always used for erroneous requests | |||||||||
+ |
In case of error the PAYONE Platform returns an error code for your internal usage. Format NUMERIC(1..6)
| ||||||||
+ |
In case of error the PAYONE Platform returns an error message for your internal usage. Format CHAR(1..1024)
| ||||||||
- |
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)
| ||||||||
- No labels