JSON-Responses

Introduction

The PAYONE Platform API is designed for key-/value-pairs. However you may use the PAYONE API with JSON-responses as well.

Therefore the HTTP Accept header in the API request has to be set to “Accept: application/json” to indicate that a JSON response should be sent.
Only the response will be in JSON – the request itself will still be key/value.

Here you’ll find a table with the original Response-parameter and the JSON-structure/-element.

API response parameter	JSON structure	JSON element	Comments
salutation	Person	Salutation
title	Person	Title
firstname	Person	FirstName
lastname	Person	LastName
birthday	Person	DateOfBirth	Format “yyyymmdd”
personalid	Person	PersonalId
language	Person	LanguageCode	ISO 639, e.g. "de"
language	Person	LanguageName	English language name, e.g. "German"
gender	Person	GenderCode	MALE \| FEMALE
street	Address	Street
addressaddition	Address	AddressAddition
zip	Address	Zip
city	Address	City
country	Address	CountryCode	ISO 3166-2, e.g. "DE"
country	Address	CountryName	English country name, e.g. "Germany"
state	Address	StateCode	ISO 3166-2 region code
state	Address	StateName
shipping_firstname	ShippingAddress	FirstName
shipping_lastname	ShippingAddress	LastName
shipping_company	ShippingAddress	Company
shipping_street	ShippingAddress	Street
shipping_addressaddition	ShippingAddress	AddressAddition
shipping_zip	ShippingAddress	Zip	ISO 3166-2, e.g. "DE"
shipping_city	ShippingAddress	City	English country name, e.g. "Germany"
shipping_country	ShippingAddress	CountryCode
shipping_country	ShippingAddress	CountryName
shipping_state	ShippingAddress	StateCode
shipping_state	ShippingAddress	StateName
company	Company	CompanyName
vatid	Company	VatId
telephonenumber	ContactData	Phone
email	ContactData	Mail

API response parameter	JSON structure	JSON element
clearing_bankaccountholder	Clearing.BankAccount	BankAccountHolder
clearing_bankcountry	Clearing.BankAccount	BankCountry
clearing_bankaccount	Clearing.BankAccount	BankAccount
clearing_bankcode	Clearing.BankAccount	BankCode
clearing_bankiban	Clearing.BankAccount	Iban
clearing_bankbic	Clearing.BankAccount	Bic
clearing_bankcity	Clearing.BankAccount	BankCity
clearing_bankname	Clearing.BankAccount	BankName
clearing_instructionnote	Clearing	InstructionNote
clearing_legalnote	Clearing	LegalNote
clearing_duedate	Clearing	DueDate
clearing_reference	Clearing	Reference

API response parameter	JSON structure	JSON element	Comments
protect_result_avs	Risk	AvsResult
pseudocardpan	CreditCard	PseudoCardPan
truncatedcardpan	CreditCard	MaskedCardPan	In fact a masked credit card number (e.g. 411111xxxxxx1111) will be returned. So the JSON-name is more correct.
cardexpiredate	CreditCard	CardExpireDate
cardholder	CreditCard	CardHolder

API response parameter		JSON element (identical to [key])
add_paydata[allowedCardTypes]	AddPayData	allowedCardTypes
add_paydata[callbackUrl]	AddPayData	callbackUrl
add_paydata[merchantCheckoutId]	AddPayData	merchantCheckoutId
add_paydata[version]	AddPayData	version
add_paydata[b2b-installment]	AddPayData	b2b-installment
add_paydata[delivery-address-elv]	AddPayData	delivery-address-elv
…[key]	AddPayData	key