iDEAL

Mobile integration

MyCheckout hosted payment pages is the optimal solution if you're looking for the quickest way to accept payments and a hassle-free experience for your consumers. This integration option will use the full redirect of a consumer on mobile device to a designed checkout page in their browser.

Before you begin

Make sure you've been boarded with iDEAL
Build your server integration

Make a payment

Make a Create hosted checkout API call, submitting the required properties. To redirect the consumer back to the app after they finish the payment, you need to provide a deeplink to your app in the returnUrl property.

Below, you'll find an example API call with the essential data. To add more information with additional properties, please visit to our API Reference.

Property	Data type	Required
order	object	yes
amountOfMoney	object	yes
currencyCode	string	yes
amount	integer	yes
customer	object	yes
merchantCustomerId	string	yes
billdingAddress	object	yes
countryCode	string	yes
hostedCheckoutSpecificInput	object	yes
locale	string	no
variant	string	no
returnUrl	string	no

Create hosted checkout

AmountOfMoney amountOfMoney = new AmountOfMoney();
amountOfMoney.setAmount(100L);
amountOfMoney.setCurrencyCode("EUR");

Address address = new Address();
address.setCountryCode("NL");

Customer customer = new Customer();
customer.setBillingAddress(address);
customer.setMerchantCustomerId("1234");

Order order = new Order();
order.setAmountOfMoney(amountOfMoney);
order.setCustomer(customer);

CreateHostedCheckoutRequest createHostedCheckoutRequest = new CreateHostedCheckoutRequest();
createHostedCheckoutRequest.setOrder(order);

CreateHostedCheckoutResponse response = client.merchant("merchantId").hostedcheckouts().create(createHostedCheckoutRequest);

var amountOfMoney = new AmountOfMoney();
amountOfMoney.Amount = 100L;
amountOfMoney.CurrencyCode = "EUR";

var address = new Address();
address.CountryCode = "NL";

var customer = new Customer();
customer.BillingAddress = address;
customer.MerchantCustomerId = "1234";

var order = new Order();
order.AmountOfMoney = amountOfMoney;
order.Customer = customer;

var createHostedCheckoutRequest = new CreateHostedCheckoutRequest();
createHostedCheckoutRequest.Order = order;

var response = await client.V1.WithNewMerchant("merchantId").Hostedcheckouts.Create(createHostedCheckoutRequest);

var body = {
  "order": {
    "amountOfMoney": {
      "amount": 1000,
      "currencyCode": "EUR"
    },
    "customer": {
      "merchantCustomerId" : "1234",
      "billingAddress": {
        "countryCode": "NL"
      }
    }
  }
}

const sdkResponse = await client.v1.hostedcheckouts.create("merchantId", body);

$amountOfMoney = new AmountOfMoney();
$amountOfMoney->amount = 100;
$amountOfMoney->currencyCode = 'EUR';

$address = new Address();
$address->countryCode = 'NL';

$customer = new Customer();
$customer->billingAddress = $address;
$customer->merchantCustomerId = '1234';

$order = new Order();
$order->amountOfMoney = $amountOfMoney;
$order->customer = $customer;

$createHostedCheckoutRequest = new CreateHostedCheckoutRequest();
$createHostedCheckoutRequest->order = $order

org.tuckey.web.filters.urlrewrite.UrlRewriteWrappedResponse@3731dbd = $client->v1()->merchant('merchantId')->hostedcheckouts()->create($createHostedCheckoutRequest);

amount_of_money = AmountOfMoney()
amount_of_money.amount = 100
amount_of_money.currency_code = 'EUR'

address = Address()
address.country_code = 'NL'

customer = Customer()
customer.billing_address = address
customer.merchant_customer_id = '1234'

order = Order()
order.amount_of_money = amount_of_money
order.customer = customer

create_hosted_checkout_request = CreateHostedCheckoutRequest()
create_hosted_checkout_request.order = order

response = client.v1().merchant('merchantId').hostedcheckouts().create(create_hosted_checkout_request)

amount_of_money = Domain::AmountOfMoney.new
amount_of_money.amount = 100
amount_of_money.currency_code = 'EUR'

address = Domain::Address.new
address.country_code = 'NL'

customer = Domain::Customer.new
customer.billing_address = address
customer.merchant_customer_id = '1234'

order = Domain::Order.new
order.amount_of_money = amount_of_money
order.customer = customer

create_hosted_checkout_request = Domain::CreateHostedCheckoutRequest.new
create_hosted_checkout_request.order = order

response = client.v1.merchant('merchantId').hostedcheckouts.create(create_hosted_checkout_request)

var amountOfMoney domain.AmountOfMoney
amountOfMoney.Amount = connectsdk.NewInt64(100)
amountOfMoney.CurrencyCode = connectsdk.newString("EUR")

var address domain.Address
address.CountryCode = connectsdk.newString("NL")

var customer domain.Customer
customer.BillingAddress = &address
customer.MerchantCustomerID = connectsdk.NewString("1234")

var order domain.Order
order.AmountOfMoney = &amountOfMoney
order.Customer = &customer

var createHostedCheckoutRequest domain.CreateHostedCheckoutRequest
createHostedCheckoutRequest.Order = &order

response, err := client.V1().Merchant("merchantId").Hostedcheckouts().Create(createHostedCheckoutRequest, nil)

{
    "order": {
        "amountOfMoney": {
            "currencyCode": "EUR",
            "amount": 1000
        },
        "customer": {
            "merchantCustomerId": 1234,
            "billingAddress": {
                "countryCode": "NL"
            }
        }
    },
    "hostedCheckoutSpecificInput": {
        "returnUrl": "https://example.org/",
        "locale": "en_GB",
        "variant": "138"
    }
}

Create hosted checkout response

{
  "RETURNMAC": "55c6d5ad-ac05-410c-b60c-c2b5479fa3d3",
  "hostedCheckoutId": "0667c1c5-****-71ff-****-53760ae5ef9d",
  "partialRedirectUrl": "pay1.preprod.checkout.worldline-solutions.com/checkout/*****......."
}

From the response, the important properties are:

hostedCheckoutId – can be used in subsequent API calls to retrieve the transaction details (with Get hosted checkout status API call);
partialRedirectUrl – is used to create the URL to which the customer needs to be redirected.

By default, we configure every account with the subdomain payment, so you can always connect https://payment. with the partialRedirectUrl, for example: https://payment.pay1.preprod.checkout.worldline-solutions.com/checkout/13801.......

For more information on customizing the checkout page, please refer to our MyCheckout hosted payment pages guide.

The hostedCheckoutId is only valid for 2 hours. Ensure to store the createdPaymentOutput.payment.id from Get hosted checkout status response to be able to retrieve data after 2 hours have elapsed via Get payment API call. Alternatively, we can also send a webhook event that will contain it.

iDEAL

Mobile integration

Before you begin

Make a payment

Next steps