Multiple payment methods

Technical manual for integrating a payment component using multiple payment methods.

This technical manual is for integrating a payment component using multiple payment methods.

1. Add the HTML elements

  1. Add the component's CSS to the <head> of your checkout page:

    <link rel="stylesheet" href="https://testpay.multisafepay.com/sdk/components/v2/components.css">
    
  2. Add the component's script to the bottom of the <body> of your checkout page:

    <script src="https://testpay.multisafepay.com/sdk/components/v2/components.js"></script>
    
  3. Add the DOM element for the component's UI in the <body> of your checkout page:

    <div id="MultiSafepayPayment"></div>
    

Choose your payment button

Decide if you want to:

  • Generate a button with the component (see Step 2 below). Recommended.

  • Use an existing button, e.g. if your checkout already includes one.

  • Create your own button:

    <button id="payment-button"></button>
    

2. Initialize the component

Generate an API token

Payment components require a MultiSafepay API token. See API reference – Generate an API token.

✅   Tip! To keep your API key private, request the token from your own server.

Construct the component object

  1. Initialize an orderData object containing information about the customer's order collected during the checkout process:

    const orderData = {
        currency: 'EUR',
        amount: 10000,
        customer: {
            locale: 'en',
            country: 'NL',
            reference: 'Customer123'
        },    
        payment_options: {
            settings: {
                connect: {
                    group_cards: true
                }
            }
        },
        template : {
            settings: {
                embed_mode: true
            }
        }
    };
    
    Properties
    KeyRequired
    amountYes
    currencyYes
    customer.countryNo
    customer.localeNo
    customer.referenceYes, for recurring payments
    payment_options.settings.connect.group_cardsNo
    recurring.modelYes, for recurring payments
    template.settings.embed_modeNo

    How to process recurring payments

    Recurring payments is a solution that lets you store a customer’s payment details as a secure, encrypted token.

    Upon subsequent payments, customers can select their stored payment details and pay with a single click.

    To process recurring payments in your payment component:

    • Add the cardOnFile recurring model
    • Provide the relevant customer.reference
    const orderData = {
        currency: 'EUR',
        amount: 10000,
        customer: {
            locale: 'en',
            country: 'NL',
            reference: 'Customer123'
        },
        recurring: {
            model: 'cardOnFile'
        }
    };
    

    Success

    Your payment component now automatically renders a checkbox where customers can choose whether they would like to store their payment details for future visits.

    Recurring payments are supported for all credit card payments.

    Note: For test credit card details, see Test payment details – Credit and debit cards.

    To use recurring payments in your payment component, you need to enable recurring payments for your account. If you haven't already, email [email protected]

    Note: We use the orderData object to ensure the payment methods are enabled, e.g. for the currency, country, and transaction value.

  2. Construct a PaymentComponent object in the test environment using the orderData object and your API token:

    PaymentComponent = new MultiSafepay({
        env: 'test',
        apiToken: apiToken,
        order: orderData
    });
    

Initialize the component

Initialize the component using:

Payment component button
PaymentComponent.init('dropin', {
    container : '#MultiSafepayPayment',
    onSelect : state => {
        console.log('onSelect', state);
    }, 
    onError : state => {
        console.log('onError', state);
    },
    onLoad : state => {
        console.log('onLoad', state);
    },
    onSubmit : state => {
        if(PaymentComponent.hasErrors()) {
            let errors = PaymentComponent.getErrors();
            console.log(errors);
            return;
        }

        // Send state.paymentData to your server (createOrder)
        // Create an order from your server
        // Return the response from your server to the client-side
        // With the response, redirect the customer or log an error

        createOrder(PaymentComponent.getPaymentData()).then(response => {
            console.log(response);
            if(response.success) {
                PaymentComponent.init('redirection', {
                    order: response.data
                });
            }
        });
    }
});
Own or existing button
PaymentComponent.init('dropin', {
    container : '#MultiSafepayPayment',
    onSelect : state => {
        console.log('onSelect', state);
    }, 
    onError : state => {
        console.log('onError', state);
    },
    onLoad : state => {
        console.log('onLoad', state);
    }
});

In the method call, create event handlers for the following events:

Events
EventEvent handler
onErrorOccurs when there is an error in the payment component.
onLoadOccurs when the payment component UI is rendered.
onSelectOccurs when the customer selects an issuer with iDEAL.
onSubmitOccurs when the customer clicks the payment button (when using the button generated by the component).
onValidationOccurs when form validation changes. Can be used to disable the payment button until all fields are validated.

The PaymentComponent has the following methods:

Methods
MethodDescription
getErrorsReturns error messages or codes.
hasErrorsReturns a boolean value about whether errors were registered.
getOrderDataReturns an object containing a payment_data object and the full order configuration.
getPaymentDataReturns a payment_data object with a payload containing the customer's payment details, used to create orders, and the gateway.

3. Create an order

Handle the interaction

✅   Tip! This step only applies if using your own or an existing payment button.

  1. Assign the button element to a variable:

    const paymentButton = document.querySelector('#payment-button');
    
  2. Create an event handler for the payment button:

    • When the customer clicks the payment button, call the component's getPaymentData() method.
    • Send the response to your server and create an order.
    • Return the reponse from your server to the client-side to redirect the customer.

Redirect the customer

The component's redirection handler redirects the customer to the relevant page:

  • If customer actions are required to complete the payment (e.g. by completing 3D Secure or iDEAL issuer authentication), the customer is redirected to the relevant page. If successful, the customer is then redirected to the redirect_url, i.e. the "success page".
  • If no customer action is required to complete the payment, the customer is redirected to the redirect_url, i.e. the "success page".
  • If the customer chooses to pay by bank transfer, the component displays the banking details needed for customers to complete payment.
  • If a QR code is available for customers to complete payment on their mobile device, the component displays the QR code.

Avoid duplicate orders

When using your own payment button, if the customer clicks it again before they are redirected, this can create duplicate orders.

To avoid duplicate orders, disable the button until you have attempted to create an order.

Then, check response.success:

  • If true, don't re-enable the button, and proceed with the redirect.

  • If false, re-enable the button for the customer to try again.

    paymentButton.addEventListener('click', e => {
        paymentButton.addAttribute('disabled');
        if (PaymentComponent.hasErrors()) {
            let errors = PaymentComponent.getErrors();
            console.log(errors);
            return false;
        }
        createOrder(PaymentComponent.getPaymentData()).then(response => {
            if(!response || !response.success) {
                paymentButton.disabled = false;
                console.log(response);
            } else {
                PaymentComponent.init('redirection', {
                    order: response.data
                });
            }
        });
    });
    

Create an order

Create an order from your server, appending the payment_data collected from the payment component UI to the order data.

See API reference – Create order > Payment component.

4. Go live

To test the payment methods, see Testing payment methods - [(/docs/testing#test-payment-details).

When you're ready to process real payments, make the following changes:

  1. In Step 1: Add the elements, replace the test JavaScript library with the live JavaScript library:

    <script src="https://pay.multisafepay.com/sdk/components/v2/components.js"></script>
    

    Next, replace the test CSS file with the live CSS file:

    <link rel="stylesheet" href="https://pay.multisafepay.com/sdk/components/v2/components.css">
    
  2. In Step 2: Construct the component object, change the environment from test to live:

    PaymentComponent = new MultiSafepay({
        env: 'live',
        apiToken: apiToken,
        order: orderData
    });
    
  3. In Step 3: Create an order, change the test endpoint to the live endpoint:

    https://api.multisafepay.com/v1/json/orders
    


💬

Support

Email [email protected]

Top of page


Did this page help you?