
Mastercard
Integration
We offer this payment methods for the following integration modes. Learn in our dedicated guides about their individual differences:
Find a high level overview in the "Process flows" chapter.
Depending on the integration mode, differences apply:
Hosted Checkout Page
Add the following properties to a standard CreateHostedCheckout request:
{
"HostedCheckoutSpecificInput": {
"ReturnUrl": "https://yourReturnUrl.com"
},
"Order": {
"AmountOfMoney": {
"Amount": 100,
"CurrencyCode": "EUR"
}
}
}
Properties | Remarks |
---|---|
hostedCheckoutSpecificInput.returnURL |
The URL we redirect your customers to after the payment has been finalised |
order.amountOfMoney amount currencyCode |
amount: The gross amount you want to charge for this order |
Hosted Tokenization Page
Add the following properties to a standard Create Payment request (including mandatory 3-D Secure v2 parameters) after you have tokenised the card:
{
"CardPaymentMethodSpecificInput": {
"Token": "tokenId",
"ThreeDSecure": {
"RedirectionData": {
"ReturnUrl": "https://yourRedirectionUrl.com"
}
}
},
"Order": {
"AmountOfMoney": {
"Amount": 100,
"CurrencyCode": "EUR"
},
"Customer": {
"Device": {
"AcceptHeader":
"text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8,application/signed-exchange;v=b3",
"Locale": "en_EN",
"TimezoneOffsetUtcMinutes": -180,
"UserAgent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/75.0.3770.142 Safari/537.36",
"Browserdata": {
"ColorDepth": 24,
"JavaScriptEnabled": false,
"ScreenHeight": "1080",
"ScreenWidth": "1920"
}
}
}
}
}
Properties | Remarks |
---|---|
cardPaymentMethodSpecificInput.Token |
Token: The tokenised credit card credentials you have received by tokenising the credentials/getting the token. Learn more in our dedicated Hosted Tokenization Page guide |
cardPaymentMethodSpecificInput.ThreeDSecure redirectionData.returnURL skipAuthentication |
returnURL: The URL we redirect your customers to after the payment has been finalised |
order.amountOfMoney Amount CurrencyCode |
amount: The gross amount you want to charge for this order |
customer.device acceptHeader locale timezoneOffsetUtcMinutes userAgent browserdata colorDepth javaScriptEnabled screenHeight screenWidth |
Minimum properties to comply with SCA for 3-D Secure authentication Check our dedicated guide to learn how to request 3-D Secure correctly and our API reference for more information about the properties. |
Server-to-server
Add the following properties to a standard CreatePayment request (including mandatory 3-D Secure v2 parameters):
{
"CardPaymentMethodSpecificInput": {
"PaymentProductId": XXX,
"SkipAuthentication": false,
"Card": {
"CardholderName": "John Doe",
"CardNumber": "0000000000000000",
"Cvv": 123,
"ExpiryDate": 1236
},
"ThreeDSecure": {
"RedirectionData": {
"ReturnUrl": "https://yourRedirectionUrl.com"
}
}
},
"Order": {
"AmountOfMoney": {
"Amount": 100,
"CurrencyCode": "EUR"
},
"Customer": {
"Device": {
"AcceptHeader": "text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8,application/signed-exchange;v=b3",
"Locale": "en_EN",
"TimezoneOffsetUtcMinutes": -180,
"UserAgent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/75.0.3770.142 Safari/537.36",
"Browserdata": {
"ColorDepth": 24,
"JavaScriptEnabled": false,
"ScreenHeight": "1080",
"ScreenWidth": "1920"
}
}
}
}
}
Properties | Remarks |
---|---|
cardPaymentMethodSpecificInput.paymentProductId cardPaymentMethodSpecificInput.card cardholderName cardPaymentMethodSpecificInput.ThreeDSecure redirectionData.returnURL skipAuthentication |
paymentProductId: The numeric identifier of the payment method on our platform. Find this id in the "Overview" chapter
returnURL: The URL we redirect your customers to after the payment has been finalised |
order.amountOfMoney Amount CurrencyCode |
amount: The gross amount you want to charge for this order |
customer.device acceptHeader locale timezoneOffsetUtcMinutes userAgent browserdata colorDepth javaScriptEnabled screenHeight screenWidth |
Minimum properties to comply with SCA for 3-D Secure authentication Check our dedicated guide to learn how to request 3-D Secure correctly and our API reference for more information about the properties. |