Table Of Contents
  INTRODUCTION  INTEGRATION

Introduction

Retrieve user data to a customer.

This request is valid from api_version >= 3.11 only.

Valid combinations of params:

api_version getusertoken type Comments
>= 3.11 NO userdata

Retrieve user data in JSON format

HTTP Accept header in the API request has to be set to “Accept: application/json”
YES usertoken

Retrieve user token

user token may be passed to different merchant to copy actual user data to new merchant with preauthorization / authorization request

Integration

POST Request - Getuser
Account Parameters
request
required
Fixed Value: getuser
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
PERSONAL DATA Parameters
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
getusertoken
optional
Format LIST
Value Comment
yes get usertoken

Can be used to get a reference (usertoken) to a debtor which can be passed to another merchant account within the PAYONE platform.

This usertoken is valid for 15 minutes. This reference to a PAYONE debtor can be used in the parameter "usertoken" for authorization / preauthorization. The debtor-data will then be copied to the other merchant account.

Must not be used together with Parameter "type".
type
optional
Format LIST
Request Value Comment
getuser userdata Returns user data of debtor (in JSON only)
HTTP Accept header in the API request has to be set to “Accept: application/json” to indicate that a JSON response should be sent.
getuser userdata Get usertoken for further authorization/preauthorization

getuser: Can be used to retrieve debtor data. Must not be used together with “getusertoken”
Parameter (getusertoken = YES )

No other parameter required
Parameter (type  = userdata )

No other parameter required


Please pay attention:

HTTP Accept header in the API request has to be set to “Accept: application/json” to indicate that a JSON response should be sent.
Response Parameters
status
Permitted Values
APPROVED
ERROR
Parameter (getusertoken = YES , APPROVED )
usertoken
Format CHAR(30)

PAYONE User token, defined by PAYONE
HTTP Body (type = userdata, OK )
[content]
JSON

JSON structured data, structure see below.
Response Parameter (Error)
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               
https://api.pay1.de/post-gateway/
RESPONSE
                          
{ 
 "Status": "OK",
 "UserId": "19367592",
 "Person": {
   "Salutation": "Herr",
   "Title": "Dr.",
   "DateOfBirth": "19881231",
   "PersonalId": "8112189876",
   "LanguageCode": "de",
   "LanguageName": "German",
   "FirstName": "Max",
   "LastName": "Mustermann"
 },
 "Address": { 
   "AddressAddition": "Zusatz",
   "CountryCode": "DE",
   "CountryName": "Germany",
   "Street": "Fraunhoferstr. 2-4",
   "Zip": "24118",
   "City": "Kiel"
 },
 "Company": { 
   "CompanyName": "Musterfirma GmbH"
 },
 "ContactData": { 
   "Phone": "+49 431 25968-0",
   "Mail": "mail@example.com"
 },
 "BankAccount": {
   "Iban": "AT446000002599100003",
   "Bic": "TESTTEST",
   "BankAccountHolder": "Mustermann, Max",
   "BankCountryCode": "AT",
   "BankCountryName": "Austria"
 },
 "SepaMandate": {
   "Identification": "TM-49684801",
   "SignatureDate": "20190919",
   "ExpireDate": "20220919"
 }
}