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


Introduction

Retrieve user data to a customer.

This request is valid from api_version >= 3.11 only.


Valid combinations of params:

api_versiongetusertokentypeComments
>= 3.11NOuserdata
  • Retrieve user data in JSON format
  • HTTP Accept header in the API request has to be set to “Accept: application/json”

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



Request "getuser"

Common Parameter

RequiredFormatComment

aid

+


Sub-Account ID, defined by PAYONE

Format

NUMERIC(5..6)

userid

o


Either userid or customerid must be given.

PAYONE User ID, defined by PAYONE

Format

NUMERIC(6..12)

customerid

o


Either userid or customerid 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.

getusertoken

-


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

LIST

ValueComment

yes

get usertoken

type

o


Type of request:

  • getuser: Can be used to retrieve debtor data. Must not be used together with “getusertoken”

Format

LIST
RequestValueComment
getuseruserdata

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.

getuserusertoken

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+

PAYONE User token, defined by PAYONE

Format

CHAR(30)

HTTP Body (type = userdata, OK )

[content]

+

JSON

JSON structured data, structure see below.
Examples refer to chapter “JSON Responses”

Parameter (ERROR)

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)

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