Single payment method

Technical manual for integrating a payment component using a single payment method.

This technical manual is for integrating a payment component using a single payment method.

1. Add the HTML elements

Add the following elements to your checkout page:

  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>
    

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'
        },
        template : {
            settings: {
                embed_mode: true
            }
        }
    };
    
    Properties
    KeyRequiredValue
    amountYesThe value of the order.
    Format: Number without decimal points, e.g. 100 euro is formatted as 10000
    currencyYesThe currency of the order.
    Format: ISO-4217 , e.g. EUR
    customer.countryNoThe customer's country code. Checks the availability of the payment method.
    Format: ISO-3166-1 alpha-2 , e.g. NL
    customer.localeNoThe customer's language. Sets the language of the payment component UI.
    Format: ISO-3166-1 alpha-2 , e.g. NL
    Supported languages: EN, ES, FR, IT, NL
    customer.referenceYes, for recurring paymentsYour unique customer reference.
    recurring.modelYes, for recurring paymentsThe tokenization model.
    template.settings.embed_modeNoA template designed to blend in seamlessly with your ecommerce platform.
    Format: Boolean

    How to process recurring payments

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

    For 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 cardholder data 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 method is enabled and the currency, country, and transaction amount are supported.

  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

  1. Call the PaymentComponent.init() method with the following arguments:

    PaymentComponent.init('payment', {
        container: '#MultiSafepayPayment',
        gateway: '<GATEWAY>',
        onLoad: state => {
            console.log('onLoad', state);
        },
        onError: state => {
            console.log('onError', state);
        }
    });
    
  2. Replace the <GATEWAY> placeholder with the relevant payment gateway identifier.

    Gateway IDs
    Payment methodGateway ID
    Bank transferBANKTRANS
    BancontactMISTERCASH
    Betaal per maandSANTANDER
    Credit cardsCREDITCARD
    Direct debitDIRDEB
    iDEALIDEAL
    In3IN3
    PayPalPAYPAL
    SofortDIRECTBANK
  3. Create event handlers for the following events:

    Events
    EventEvent handler
    onErrorCalled when an error occurs in the payment component.
    onLoadCalled 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.

    Note: The PaymentComponent uses the following methods:

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

3. Create an order

Handle the interaction

  1. Assign the button element to a variable:

    PaymentComponent.getPaymentData()
    
  2. Create an event handler for the payment button to:

    • 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 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 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 to the redirect.

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

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

Use the createOrder() function to pass the orderData to your server.

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.

Redirect the customer

  1. From your server, pass the response to the create order request to the customer's device.

  2. Check that response.success is true.

  3. Handle the response

    Call the PaymentComponent.init() method using the following arguments:

    PaymentComponent.init('redirection', {
        order: response.data
    });
    

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

    • If customer action is required to complete 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 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.

4. Go live

To test the payment method, use our Testing.

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

  1. In Step 1: Add the HTML elements, replace the:

    • Test JavaScript library with the live JavaScript library:
    <script src="https://pay.multisafepay.com/sdk/components/v2/components.js"></script>
    
    • 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?