REST API Easy Collect

Easy Collect is a SEPA direct debit solution provided by Worldline. It allows merchants to collect payments directly from customers' bank accounts by managing SEPA mandates and executing direct debit transactions. 

Mandate approvals are carried out using a One-Time Password (OTP) sent to the customer via SMS or email. Once a SEPA mandate is approved, it can be used immediately for payment or stored for future debit operations.

Get started

To start accepting Easy Collect payments, onboarding with NEXI is required. During the onboarding process, you must provide:

  • Creditor ID – A unique identifier used to authorize Easy Collect payments.

  • Bank account details – Your account details where funds will be settled.

Contact NEXI Helpdesk with the above details to activate the Easy Collect payment method for your merchant profile.

Integration Options

Easy Collect supports flexible integration paths depending on your payment flow requirements. You can choose from the following options:

Mandate only

Use Mandate only flow when you want to create a SEPA mandate which can be used later for payment. This flow is supported via Hosted Payment Page and Hosted forms integration.

Hosted Payment Page

To make a mandate only request via our hosted payment page, call Create checkout session with the below additional information:

{
    "easyCollect": {
        "eventToken": "MANDATE_ONLY"
    }
}

Hosted forms

To make a mandate only request via our Hosted forms, call Create payment with the below information:

{
    "paymentMethods": {
        "integrationType": "HOSTED",
        "type": "EASYCOLLECT",
        "easyCollect": {
            "eventToken": "MANDATE_ONLY"
        }
    }
}


Payment Only

To submit the payment for a mandate that has been already created using the Mandate only request, you need to call Create payment by using Direct integration. The mandateId provided in the response to mandate only request should be referenced in the payment only request.

{
    "paymentMethods": {
        "integrationType": "DIRECT",
        "type": "EASYCOLLECT",
        "easyCollect": {
            "eventToken": "PAYMENT_ONLY",
            "mandateId": "MANDATE123456789"
        }
    }
}


Mandate with Payment

Use mandate with payment flow when you want to submit the payment along with creation of mandate. This flow is supported via Hosted Payment Page and Hosted forms integration.

Hosted Payment Page

To make a mandate with payment request via our hosted payment page, call Create checkout session with the below additional information:

{
    "easyCollect": {
        "eventToken": "MANDATE_WITH_PAYMENT"
    }
}

Hosted forms

To make a mandate with payment request via our Hosted forms, call Create payment with the below information:

{
    "paymentMethods": {
        "integrationType": "HOSTED",
        "type": "EASYCOLLECT",
        "easyCollect": {
            "eventToken": "MANDATE_WITH_PAYMENT"
        }
    }
}


Refund payment

Refunds are supported for Easy Collect payments via the Refund payment with reference endpoint.