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)	Business name.
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 and 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)	Additional address information.

cardDetails

Parameter	Type	Description	Constraints	Required
cardProvider	String	The provider for the credit-card [amex, mastercard, visa, etc].		✅
browserInformation	browserInformation Object	Browser information details.		✅
encryptedCardDetails	encryptedCardDetails Object	Encrypted card details.		✅

browserInformation

Parameter	Type	Description	Constraints	Required
shopperIp	String(1...39)	IPv4 or IPv6 address for the consumer.		✅
accept	String	Content-type accepted by the client browser.		✅
userAgent	String	User-Agent of the consumer' browser.		✅

encryptedCardDetails

Parameter	Type	Description	Constraints	Required
data	String	Client-side encrypted card details.	Find more details here .	✅

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.		✅

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.

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 year ago