Schemas

Schemas used in requests/responses of our API:

consumer

Parameter	Type	Description	Constraints	Required
name	name Object	Customer name.
address	address Object	Customer address.		✅
email	String	Email provided by customer.		✅
businessName	String(1...35)	The name of the purchasing business.
phone	String	Customer phone number.
gender	String(1...2000)	Gender of the customer.	The possible values are: `m`, `f` , or `null`.
dateOfBirth	String	Date of birth of the customer.

name

Parameter	Type	Description	Constraints	Required
firstName	String(1...35)	Customer first name.		✅
lastName	String(1...35)	Customer last name.		✅
middleName	String(1...35)	Customer middle name.

address

Parameter	Type	Description	Constraints	Required
street	String(1...100)	Street.
houseNumber	String(1...35)	House number.
postalCode	String(1...35)	Postal code.
city	String(1...35)	City.
countryCode	String	Country code.	ISO 3166-1 country code.	✅
state	String(1...40)	State.
additionalData	String(1...35)	Any additional address details.

item

Parameter	Type	Description	Constraints	Required
code	String(1...50)	A code that identifies the item.		✅
name	String(1...50)	A human readable name for the item.
description	String(1...100)	Item description.
unitPrice	Int(1...99999999)	Unit price (including VAT) of the item, specified in the smallest currency subunit, as for example eurocents.		✅
quantity	Int(1...1000000000)	The number of items.		✅
vatAmount	Int(1...99999999)	VAT amount of one unit, specified in the smallest currency subunit, as for example eurocents.		✅
vatRate	Number(0...99.9)	Percentage of VAT applied. Only the first decimal value will be taken into account, the rest will be ignored.		✅
type	String/Enum	Enum for the item line type.	PHYSICAL DIGITAL DISCOUNT GIFT_CARD STORE_CREDIT SHIPPING_FEE SALES_TAX SURCHARGE

action

Parameter	Type	Description	Constraints	Required
redirect	redirect Object	Next action to be performed by merchant (or consumer) to complete the payment.

redirect

Parameter	Type	Description	Constraints	Required
url	String	URL where consumer should be redirected to by the merchant to perform the payment.

returnUrls

Parameter	Type	Description	Constraints	Required
success	String(1...2000)	Return URL to use when the transaction succeeds.		✅
cancelled	String(1...2000)	Return URL to use when the transaction is cancelled.		✅
expired	String(1...2000)	Return URL to use when the transaction is expired.		✅
failed	String(1...2000)	Return URL to use when the transaction is failed.		✅

refund

Parameter	Type	Description	Constraints	Required
refundedAmount	Int(0...99999999)	Amount in the smallest currency subunit, as for example eurocents, that has already been refunded.		✅
refundedPendingAmount	Int(1...99999999)	Amount in the smallest currency subunit, as for example eurocents, that has been requested to be refunded.		✅

Updated about 1 month ago