- Created by PAYONE Admin, last modified by BS PAYONE on 2019-09-19
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 |
|
YES | usertoken |
|
Request "getuser" | |||||||||||||||
Common Parameter | Required | Format | Comment | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
+ | Format | ||||||||||||||
o | Either userid or customerid must be given. Format | ||||||||||||||
o | Either userid or customerid must be given. Format | ||||||||||||||
- | 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 for authorization / preauthorization. The debtor-data will then be copied to the other merchant account. Must not be used together with Parameter "type". Format yes get usertoken | ||||||||||||||
o | Type of request: Format 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. Get usertoken for further authorization/preauthorization | ||||||||||||||
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 " getuser " | |||
---|---|---|---|
Common Parameter | Required | Format | Comment |
status | + | Default | APPROVED / OK / ERROR |
Parameter (getusertoken = YES , APPROVED ) | |||
usertoken | + | Format | |
HTTP Body (type = userdata, OK ) | |||
[content] | + | JSON | JSON structured data, structure see below. |
Parameter (ERROR) | |||
+ | In case of error the PAYONE Platform returns an error code for your internal usage. Format | ||
+ | In case of error the PAYONE Platform returns an error message for your internal usage. Format |
Sample response for "getuser with JSON to request userdata"
Full structure of JSON response: see JSON-Responses
{ "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" } }
Content
- No labels