Schemas

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

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.

details

Parameter	Type	Description	Constraints	Required
merchantCountry	String	The country code where the transaction is processed.	ISO 3166-1 alpha-2 country code.
serverUrl	String	The URL to the Mobile Pay Server.
allowedCardNetworks	String	The supported card networks for Payment via Apple Pay.	The possible values are: mastercard, visa.
merchantName	String	The name to display on the the payment sheet.

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