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.
POST Request - managemandate
|
request
required
|
Fixed Value: managemandate
|
|
mid
required
|
your merchant ID, 5-digit numeric
|
|
aid
required
|
your subaccount ID, 5-digit numeric
|
|
portalId
required
|
your Portal ID, 7-digit numeric
|
|
key
required
|
your key value, alpha-numeric
|
|
clearingtype
required
|
Fixed Value elv
|
|
mode
required
|
Fixed Value test/live
Can be either test environment (test) or live environment (live) |
|
currency
required
|
Format LIST
Permitted values ISO 4217 (currencies) 3-letter-codes
Samples
EUR USD GBP |
|
customerid
optional
|
Format CHAR(1..20)
Permitted Symbols [0-9, a-z, A-Z, .,-,_,/]
Merchant's customer ID, defined by you / merchant to refer to the customer record. "customerid" can be used to identify a customer record.
If "customerid" is used then stored customer data are loaded automatically. |
||||||
|
userid
optional
|
Format NUMERIC(6..12)
PAYONE User ID, defined by PAYONE |
||||||
|
salutation
optional
|
Format CHAR(1..10)
The customer's salutation |
||||||
|
title
optional
|
Format CHAR(1..20)
Samples
Dr Prof. Dr.-Ing. Title of the customer |
||||||
|
firstname
optional
|
Format CHAR(1..50)
First name of customer; optional if company is used, i.e.: you may use "company" or "lastname" or "firstname" plus "lastname" |
||||||
|
lastname
required
|
Format CHAR(2..50)
Last name of customer; optional if company is used, i.e.: you may use "company" or "lastname" or "firstname" plus "lastname" |
||||||
|
company
optional
|
Format CHAR(2..50)
Comany name of customer; optional if company is used, i.e.: you may use "company" or "lastname" or "firstname" plus "lastname" |
||||||
|
street
optional
|
Format CHAR(1..50)
Street number and name (required: at least one character) |
||||||
|
addressaddition
optional
|
Format CHAR(1..50)
Samples
7th floor c/o Maier Specifies an additional address line for the invoice address of the customer. |
||||||
|
zip
optional
|
Format CHAR(2..50)
Permitted Symbols [0-9][A-Z][a-z][_.-/ ]
Postcode |
||||||
|
city
required
|
Format CHAR(2..50)
City of customer |
||||||
|
country
required
|
Format LIST
Permitted values ISO 3166 2-letter-codes
Samples
DE GB US Specifies country of address for the customer. Some countries require additional information in parameter "state"
|
||||||
|
state
required
|
Format LIST
Permitted values ISO 3166-2 States (regions) 2-letter-codes
Specifies state / region of country for the customer. |
||||||
|
email
optional
|
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 "@" and "." is counted as a character as well; in case of a total of three suffixes, this would allow a total of 254 characters. email-address of customer |
||||||
|
telephonenumber
optional
|
Format CHAR(1..30)
Phone number of customer |
||||||
|
birthday
optional
|
Format DATE(8), YYYYMMDD
Samples
20190101 19991231 Date of birth of customer |
||||||
|
language
optional
|
Format LIST
Permitted values ISO 639-1 (Language)2-letter-codes
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. |
||||||
|
vatid
optional
|
Format CHAR(1..50)
VAT identification number. Used for b2b transactions to indicate VAT number of customer. |
||||||
|
gender
optional
|
Format LIST
Permitted values f / m / d
Gender of customer (female / male / diverse* ) * currently not in use |
||||||
|
personalid
optional
|
Format CHAR(1..32)
Permitted Symbols [0-9][A-Z][a-z][+-./()]
Person specific numbers or characters, e.g. number of passport / ID card |
||||||
|
ip
optional
|
Format CHAR(1..39)
Customer's IP-V4-address (123.123.123.123) or IP-V6-address |
|
bankcountry
required
|
Format LIST
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 |
|
iban
optional
|
Format CHAR(8 or 11) Only capital letters and digits, no spaces
Permitted Symbols [0-9][A-Z]
Bank Identifier Code to be used for payment or to be checked |
|
bic
optional
|
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. |
|
bankaccount
optional
|
Format NUMERIC(1..10)
DE: bankcountry, bankcode and bankaccount may be used. Then IBAN will be generated by PAYONE platform and used for SEPA transactions. |
|
bankcode
optional
|
Format NUMERIC(8)
DE: bankcountry, bankcode and bankaccount may be used. Then IBAN will be generated by PAYONE platform and used for SEPA transactions. |
|
bankaccountholder
optional
|
Format CHAR(1..50)
Account holder |
|
status
|
Permitted Values
APPROVED
ERROR |
|
mandate_identification
|
Format CHAR(1..35)
Permitted Symbols [A-Z,a-z,0-9,+,-,.,(,)]
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. PPS (PAYONE Payment Service): This parameter must not be used! For PPS the PAYONE platform defines the mandate_identification If the mandate_identification is not set PAYONE will create an unique mandate identification |
||||||
|
mandate_status
|
Format LIST
Status of SEPA mandate |
||||||
|
mandate_text
|
Format TEXT
Content of mandate text HTML-formatted, URL-encoded |
||||||
|
creditor_identifier
|
Format CHAR(1..35)
Creditor identifier as recorded at PAYONE |
||||||
|
iban
|
Format CHAR(8 or 11) Only capital letters and digits, no spaces
Permitted Symbols [0-9][A-Z]
Bank Identifier Code to be used for payment or to be checked. |
||||||
|
bic
|
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. |
|
errorcode
|
Format NUMERIC(1..6)
In case of error the PAYONE Platform returns an error code for your internal usage. |
|
errormessage
|
Format CHAR(1..1024)
In case of error the PAYONE Platform returns an error message for your internal usage. |
|
customermessage
|
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") |
Host: api.pay1.de
Content-Type: application/x-www-form-urlencoded
Payload
aid=52078
bankaccount=
bankaccountholder=Siegfried Sepa
bankcode=
bankcountry=DE
bic=
city=Kiel
clearingtype=elv
country=DE
currency=EUR
email=Siegfried.Sepa@payone.com
encoding=UTF-8
firstname=Siegfried
gender=m
iban=DE11210501706179573239
ip=172.19.0.34
key=17031f73e2c6f9755788bddfff04169b
language=de
lastname=Sepa
mid=14648
mode=test
portalid=2037267
request=managemandate
salutation=Herr
street=Fraunhoferstr. 2-4
zip=24118
RESPONSE
status=APPROVED
mandate_identification=TM-10052817
mandate_status=pending
mandate_text=%3Cdiv+class%3D%22mandatetext%22%3E%0A%3Cp%3E%0A%3Cstrong%3ESEPA-Lastschriftmandat%3C%2Fstrong%3E%0A%3C%2Fp%3E%0A%3Cp%3E%0A++++++++++++++++++++++++++++Zahlungsempf%26auml%3Bnger%3A+Payone+Test+Kiel%2C+DE%3Cbr%3E%0A++++++++++++++++Gl%26auml%3Bubiger-Identifikationsnummer%3A+TESTTESTTEST%3Cbr%3E%0A++++++++++++++++Mandatsreferenz%3A+TM-10052817%3C%2Fp%3E%0A%3Cp%3EIch+erm%26auml%3Bchtige+den+Zahlungsempf%26auml%3Bnger%2C+Zahlungen+von+meinem+Konto+mittels+Lastschrift+einzuziehen.+Zugleich+weise+ich+mein+Kreditinstitut+an%2C+die+von+dem+Zahlungsempf%26auml%3Bnger+auf+mein+Konto+gezogenen+Lastschriften+einzul%26ouml%3Bsen.%3C%2Fp%3E%0A%3Cp%3EHinweis%3A+Ich+kann+innerhalb+von+acht+Wochen%2C+beginnend+mit+dem+Belastungsdatum%2C+die+Erstattung+des+belasteten+Betrages+verlangen.+Es+gelten+dabei+die+mit+meinem+Kreditinstitut+vereinbarten+Bedingungen.%3C%2Fp%3E%0A%3Cdl%3E%0A%3Cdt%3EName+des+Zahlungspflichtigen%3A%3C%2Fdt%3E%0A%3Cdd%3ESiegfried+Sepa%3C%2Fdd%3E%0A%3Cdt%3EStra%26szlig%3Be+und+Hausnummer%3A%3C%2Fdt%3E%0A%3Cdd%3EFraunhoferstr.+2-4%3C%2Fdd%3E%0A%3Cdt%3EPostleitzahl%3A+%3C%2Fdt%3E%0A%3Cdd%3E24118%3C%2Fdd%3E%0A%3Cdt%3EOrt%3A+%3C%2Fdt%3E%0A%3Cdd%3EKiel%3C%2Fdd%3E%0A%3Cdt%3ELand%3A%3C%2Fdt%3E%0A%3Cdd%3EDE%3C%2Fdd%3E%0A%3Cdt%3EE-Mail%3A%3C%2Fdt%3E%0A%3Cdd%3ESiegfried.Sepa%40payone.com%3C%2Fdd%3E%0A%3Cdt%3EBankkontonummer+-+IBAN%3A%3C%2Fdt%3E%0A%3Cdd%3EDEXX21050170XXXXXX3239%3C%2Fdd%3E%0A%3C%2Fdl%3E%0A%3Cp%3E%0A%3Cspan+class%3D%22mandatetext_cityofsignature%22%3EKiel%3C%2Fspan%3E%2C+04.10.2023%2C+Siegfried+Sepa%3C%2Fp%3E%0A%3C%2Fdiv%3E%0A
creditor_identifier=TESTTESTTEST
iban=DE11210501706179573239