Create payment

Payments API

Payment creation is elemental to the Mollie API: this is where most payment implementations start off. Note optional parameters are accepted for certain payment methods.

To wrap your head around the payment process, an explanation and flow charts can be found in the Overview.

Parameters

amount
decimal

The amount in EURO that you want to charge, e.g. 100.00 if you would want to charge €100.00.

description
string

The description of the payment you're creating. This will be shown to the consumer on their card or bank statement when possible, and in any exports you generate.

We recommend you use the order number so that you can always link the payment to the order. This is particulary useful for bookkeeping.

redirectUrl
string

The URL the consumer will be redirected to after the payment process. It could make sense for the redirectURL to contain a unique identifier – like your order ID – so you can show the right page referencing the order when the consumer returns.

webhookUrl
string

Set the webhook URL, where we will send payment status updates to.

method
string

Optional – Normally, a payment method selection screen is shown. However, when using this parameter, your customer will skip the selection screen and will be sent directly to the chosen payment method. The parameter enables you to fully integrate the payment method selection into your website, however note Mollie's country based conversion optimization is lost.

Possible values: creditcard sofort ideal mistercash banktransfer directdebit paypal bitcoin podiumcadeaukaart paysafecard kbc belfius

metadata
object

Optional – Provide any data you like in JSON notation, and we will save the data alongside the payment. Whenever you fetch the payment with our API, we'll also include the metadata. You can use up to 1kB of JSON.

locale
string

Optional – Allow you to preset the language to be used in the payment screens shown to the consumer. When this parameter is not provided, the browser language will be used instead (which is usually more accurate). You can provide any ISO 15897 locale, but our payment screens currently only support the following languages:

Possible values: en_US de_DE fr_FR fr_BE nl_NL nl_BE

recurringType
string

Optional – Learn more about the recurringType parameter.

customerId
string

Optional – The ID of the customer for whom the payment is being created. Learn more here.

mandateId
string

Optional – When creating recurring payments, a specific mandate ID may be supplied to indicate which of the consumer's accounts should be credited.

Mollie Connect/OAuth parameters

If you're creating an app with Mollie Connect/OAuth, the only mandatory extra parameter is the profileId parameter. With it, you can specify to which profile the payment belongs. Organizations can have multiple profiles for each of their websites. See Profiles API for more.

profileId
string

The payment profile's unique identifier, for example pfl_3RkSN1zuPE. This field is mandatory.

testmode
boolean

Optional – Set this to true to make this payment a test payment.

applicationFee
object

Optional – Adding an Application Fee allows you to charge the merchant a small sum for the payment and transfer this to your own account. Set the applicationFee parameter as a small object with it’s own amount and description. The application fee amount must be at least €1.00 less than the payment's amount parameter.

amount
decimal

The amount in EURO that the app wants to charge, e.g. 10.00 if the app would want to charge €10.00.

Note that you will need to invoice the merchant yourself. We will only collect the amount from the merchant and settle the amount with you.

description
string

The description of the application fee. This will appear on settlement reports to the merchant and to you.

Includes

Some endpoints allow you to indicate if you want more information to be included in the API response via the include querystring parameter.

• details.qrCode Include a QR code object (only available for Bitcoin and bank transfer payments).

Response

A payment object is returned, as described in Get payment.

Example

curl -X POST https://api.mollie.nl/v1/payments \
    -H "Authorization: Bearer test_dHar4XY7LxsDOtmnkVtjNVWXLSlXsM" \
    -d "amount=10.00" \
    -d "description=My first payment" \
    -d "redirectUrl=https://webshop.example.org/order/12345/" \
    -d "webhookUrl=https://webshop.example.org/payments/webhook/" \
    -d "metadata[order_id]=12345"

require 'mollie/api/client'

mollie = Mollie::API::Client.new('test_dHar4XY7LxsDOtmnkVtjNVWXLSlXsM')

begin
    payment = mollie.payments.create({
        :amount       => 10.00,
        :description  => 'My first payment',
        :redirect_url => 'https://webshop.example.org/order/12345/',
        :webhook_url  => 'https://webshop.example.org/payments/webhook/',
        :metadata     => {
            :order_id => '12345'
        }
    })

    #
    # Send the customer off to complete the payment.
    #
    redirect_to payment.payment_url
rescue Mollie::API::Exception => e
    $response.body << "API call failed: " << (CGI.escapeHTML e.message)
end

import Mollie, flask

mollie = Mollie.API.Client()
mollie.setApiKey('test_dHar4XY7LxsDOtmnkVtjNVWXLSlXsM')

try:
    payment = mollie.payments.create({
        'amount':      10.00,
        'description': 'My first payment',
        'redirectUrl': 'https://webshop.example.org/order/12345/',
        'webhookUrl':  'https://webshop.example.org/payments/webhook/',
        'metadata': {
            'order_nr': '12345'
        }
    })

    # Send the customer off to complete the payment.
    return flask.redirect(payment.getPaymentUrl())

except Mollie.API.Error as e:
    return 'API call failed: ' + e.message

Mollie = require('mollie-api-node');

mollie = new Mollie.API.Client;
mollie.setApiKey('test_dHar4XY7LxsDOtmnkVtjNVWXLSlXsM');

mollie.payments.create({
    amount:      10.00,
    description: 'My first payment',
    redirectUrl: 'https://webshop.example.org/order/12345/',
    webhookUrl:  'https://webshop.example.org/payments/webhook/',
    metadata: {
        orderId: '12345'
    }
},  function (payment) {
    if (payment.error) {
        console.error(payment.error);
        return response.end();
    }

    /*
     * Send the customer off to complete the payment.
     */
    response.writeHead(302, {
        Location: payment.getPaymentUrl()
    });
    return response.end();
});

require_once 'Mollie/API/Autoloader.php';

$mollie = new Mollie_API_Client;
$mollie->setApiKey('test_dHar4XY7LxsDOtmnkVtjNVWXLSlXsM');

try
{
    $payment = $mollie->payments->create(
        array(
            'amount'      => 10.00,
            'description' => 'My first payment',
            'redirectUrl' => 'https://webshop.example.org/order/12345/',
            'webhookUrl'  => 'https://webshop.example.org/payments/webhook/',
            'metadata'    => array(
                'order_id' => '12345'
            )
        )
    );

    /*
     * Send the customer off to complete the payment.
     */
    header("Location: " . $payment->getPaymentUrl());
    exit;
}
catch (Mollie_API_Exception $e)
{
    echo "API call failed: " . htmlspecialchars($e->getMessage());
    echo " on field " . htmlspecialchars($e->getField());
}

HTTP/1.1 201 Created
Content-Type: application/json; charset=utf-8

{
    "resource":        "payment",
    "id":              "tr_7UhSN1zuXS",
    "mode":            "test",
    "createdDatetime": "2017-05-31T09:26:45.0Z",
    "status":          "open",
    "expiryPeriod":    "PT15M",
    "amount":          10.00,
    "description":     "My first payment",
    "metadata": {
        "order_id": "12345"
    },
    "locale": "nl",
    "profileId": "pfl_QkEhN94Ba",
    "links": {
        "paymentUrl":  "https://www.mollie.com/payscreen/select-method/7UhSN1zuXS",
        "redirectUrl": "https://webshop.example.org/order/12345/",
        "webhookUrl":  "https://webshop.example.org/payments/webhook/"
    }
}