Mollie

App · 24 actions

Take payments, send payment links, issue refunds and run subscriptions with Mollie.

Actions

ActionWhat it does
Cancel paymentCancel a payment that can still be canceled, such as an open or pending one.
Cancel refundCancel a refund while it is still queued or pending, within about two hours of creating it.
Cancel subscriptionCancel a customer's subscription, so it makes no more payments.
Create customerCreate a customer, so you can link their payments and charge them again later.
Create paymentCreate a payment and get the checkout link to send your customer to.
Create payment linkCreate a link you can share for someone to pay you.
Create SEPA mandateRecord a customer's signed SEPA Direct Debit mandate, so you can charge their bank account with recurring payments and subscriptions.
Create subscriptionCharge a customer with a valid mandate the same amount at a regular interval.
Delete customerDelete a customer.
Delete payment linkDelete a payment link that has not been opened or paid yet.
Get customerGet a customer's details.
Get paymentGet a payment with its status, amounts and checkout link.
Get payment linkGet a payment link with its address and whether it has been paid.
List chargebacksList the chargebacks on your payments, newest first.
List customersList your customers, newest first.
List payment linksList your payment links, newest first.
List payment methodsList the payment methods enabled on your account, with their minimum and maximum amounts.
List paymentsList your payments, newest first.
List refundsList your refunds across all payments, newest first.
List subscriptionsList the subscriptions of all your customers, newest first.
Refund paymentRefund all or part of a paid payment, in the payment's own currency.
Revoke mandateRevoke a customer's mandate.
Update customerChange a customer's name, email or language.
Update payment linkChange a payment link's description, or archive it so no one can pay through it.

Cancel payment

Cancel a payment that can still be canceled, such as an open or pending one.

Inputs

Paymentpayment_idtextRequired
The payment, whose ID starts with tr_.

Outputs

dataobject
The response from Mollie.
Example output
{
  "data": {
    "_links": {
      "checkout": {
        "href": "example",
        "type": "example"
      },
      "dashboard": {
        "href": "example",
        "type": "example"
      }
    },
    "amount": {
      "currency": "example",
      "value": "example"
    },
    "amountRefunded": {
      "currency": "example",
      "value": "example"
    },
    "amountRemaining": {
      "currency": "example",
      "value": "example"
    },
    "createdAt": "example",
    "customerId": "example",
    "description": "example",
    "expiresAt": "example",
    "id": "example",
    "isCancelable": true,
    "mandateId": "example",
    "method": "example",
    "mode": "example",
    "paidAt": "example",
    "redirectUrl": "example",
    "resource": "example",
    "sequenceType": "example",
    "status": "example",
    "subscriptionId": "example",
    "webhookUrl": "example"
  }
}

Cancel refund

Cancel a refund while it is still queued or pending, within about two hours of creating it.

Inputs

Paymentpayment_idtextRequired
The payment, whose ID starts with tr_.
Refund IDrefund_idtextRequired
The refund, whose ID starts with re_.

Outputs

dataobject
The response from Mollie.
Example output
{
  "data": {}
}

Cancel subscription

Cancel a customer's subscription, so it makes no more payments.

Inputs

Customercustomer_idtextRequired
The Mollie customer.
Subscriptionsubscription_idtextRequired
The subscription, whose ID starts with sub_.

Outputs

dataobject
The response from Mollie.
Example output
{
  "data": {
    "amount": {
      "currency": "example",
      "value": "example"
    },
    "canceledAt": "example",
    "createdAt": "example",
    "customerId": "example",
    "description": "example",
    "id": "example",
    "interval": "example",
    "mandateId": "example",
    "method": "example",
    "mode": "example",
    "nextPaymentDate": "example",
    "resource": "example",
    "startDate": "example",
    "status": "example",
    "times": 1,
    "timesRemaining": 1
  }
}

Create customer

Create a customer, so you can link their payments and charge them again later.

Inputs

Namenametext
The customer's full name.
Emailemailtext
The customer's email address.
Languagelocaletext
The language of Mollie's payment pages for this customer.One of: en_US (English (US)), en_GB (English (UK)), en_BE (English (Belgium)), en_NL (English (Netherlands)), nl_NL (Dutch), nl_BE (Dutch (Belgium)), de_DE (German), de_AT (German (Austria)), de_CH (German (Switzerland)), de_LU (German (Luxembourg)), and 21 more.

Outputs

dataobject
The response from Mollie.
Example output
{
  "data": {
    "createdAt": "example",
    "email": "example",
    "id": "example",
    "locale": "example",
    "mode": "example",
    "name": "example",
    "resource": "example"
  }
}

Create payment

Create a payment and get the checkout link to send your customer to.

Inputs

AmountamountnumberRequired
The amount to charge, for example 10.00.At least 0.
Currencycurrencytext
The currency of the amount. Test payments support only euros.One of: EUR, USD, GBP, AED, AUD, BRL, CAD, CHF, CZK, DKK, and 19 more. Default: EUR.
DescriptiondescriptiontextRequired
What the payment is for. Customers may see it on their statement.
Return pageredirect_urltext
Where to send the customer after they pay. Needed for every payment except recurring ones.
Cancel pagecancel_urltext
Where to send the customer if they cancel. Leave empty to use the return page.
Status updates URLwebhook_urltext
A web address Mollie calls whenever this payment's status changes.
Payment methodmethodtext
Only offer this payment method. Leave empty to let the customer choose.One of: alma, applepay (Apple Pay), bacs (BACS Direct Debit), bancomatpay (BANCOMAT Pay), bancontact, banktransfer (Bank transfer), belfius, billie, billink, bizum, and 26 more.
Languagelocaletext
The language of Mollie's payment pages.One of: en_US (English (US)), en_GB (English (UK)), en_BE (English (Belgium)), en_NL (English (Netherlands)), nl_NL (Dutch), nl_BE (Dutch (Belgium)), de_DE (German), de_AT (German (Austria)), de_CH (German (Switzerland)), de_LU (German (Luxembourg)), and 21 more.
Customercustomer_idtext
The Mollie customer.
Payment typesequence_typetext
One-off by default. Choose First to set up recurring charges, or Recurring to charge a customer's saved mandate.One of: oneoff (One-off), first (First of a recurring series), recurring.
Mandatemandate_idtext
For a recurring payment: the mandate to charge. Leave empty to use any valid one.

Outputs

dataobject
The response from Mollie.
Example output
{
  "data": {
    "_links": {
      "checkout": {
        "href": "example",
        "type": "example"
      },
      "dashboard": {
        "href": "example",
        "type": "example"
      }
    },
    "amount": {
      "currency": "example",
      "value": "example"
    },
    "amountRefunded": {
      "currency": "example",
      "value": "example"
    },
    "amountRemaining": {
      "currency": "example",
      "value": "example"
    },
    "createdAt": "example",
    "customerId": "example",
    "description": "example",
    "expiresAt": "example",
    "id": "example",
    "isCancelable": true,
    "mandateId": "example",
    "method": "example",
    "mode": "example",
    "paidAt": "example",
    "redirectUrl": "example",
    "resource": "example",
    "sequenceType": "example",
    "status": "example",
    "subscriptionId": "example",
    "webhookUrl": "example"
  }
}

Create a link you can share for someone to pay you.

Inputs

DescriptiondescriptiontextRequired
What the payment is for. Customers may see it on their statement.
Amountamountnumber
The amount to pay. Leave empty to let the customer enter one.At least 0.
Currencycurrencytext
The currency of the amount. Test payments support only euros.One of: EUR, USD, GBP, AED, AUD, BRL, CAD, CHF, CZK, DKK, and 19 more. Default: EUR.
Return pageredirect_urltext
Where to send the customer after they pay.
Status updates URLwebhook_urltext
A web address Mollie calls when a payment through the link changes status.
Expiresexpires_atdate and time
When the link stops working. Leave empty for a link that never expires.
Reusablereusabletrue/false
Let more than one payment be made through the link.
Payment methodsallowed_methodslist
Only offer these payment methods. Leave empty to offer every method you have.One or more of: applepay (Apple Pay), bacs (BACS Direct Debit), bancomatpay (BANCOMAT Pay), bancontact, banktransfer (Bank transfer), belfius, billie, blik, creditcard (Card), eps, and 21 more.

Outputs

dataobject
The response from Mollie.
Example output
{
  "data": {
    "_links": {
      "paymentLink": {
        "href": "example",
        "type": "example"
      },
      "self": {
        "href": "example",
        "type": "example"
      }
    },
    "amount": {
      "currency": "example",
      "value": "example"
    },
    "archived": true,
    "createdAt": "example",
    "description": "example",
    "expiresAt": "example",
    "id": "example",
    "mode": "example",
    "paidAt": "example",
    "redirectUrl": "example",
    "resource": "example",
    "reusable": true,
    "webhookUrl": "example"
  }
}

Create SEPA mandate

Record a customer's signed SEPA Direct Debit mandate, so you can charge their bank account with recurring payments and subscriptions.

Inputs

Customercustomer_idtextRequired
The Mollie customer.
Account holderconsumer_nametextRequired
The account holder's name.
IBANconsumer_accounttextRequired
The account holder's IBAN.
BICconsumer_bictext
The BIC of the account holder's bank.
Signed onsignature_datedate
The date the customer signed the mandate.
Mandate referencemandate_referencetext
Your own unique reference for the mandate. Some banks decline direct debits when it is not unique.

Outputs

dataobject
The response from Mollie.
Example output
{
  "data": {
    "createdAt": "example",
    "customerId": "example",
    "id": "example",
    "mandateReference": "example",
    "method": "example",
    "mode": "example",
    "resource": "example",
    "signatureDate": "example",
    "status": "example"
  }
}

Create subscription

Charge a customer with a valid mandate the same amount at a regular interval.

Inputs

Customercustomer_idtextRequired
The Mollie customer.
AmountamountnumberRequired
The amount of each payment, for example 10.00.At least 0.
Currencycurrencytext
The currency of the amount. Test payments support only euros.One of: EUR, USD, GBP, AED, AUD, BRL, CAD, CHF, CZK, DKK, and 19 more. Default: EUR.
EveryintervaltextRequired
How often to charge, such as 1 month, 14 days or 2 weeks. At most 12 months.
DescriptiondescriptiontextRequired
What the subscription is for. Each payment carries it, and it must be unique for this customer.
Number of paymentstimesnumber
How many payments in total. Leave empty to keep charging until it is canceled.At least 1.
Start datestart_datedate
The date of the first payment. Leave empty to start today.
Status updates URLwebhook_urltext
A web address Mollie calls whenever one of the subscription's payments changes status.

Outputs

dataobject
The response from Mollie.
Example output
{
  "data": {
    "amount": {
      "currency": "example",
      "value": "example"
    },
    "canceledAt": "example",
    "createdAt": "example",
    "customerId": "example",
    "description": "example",
    "id": "example",
    "interval": "example",
    "mandateId": "example",
    "method": "example",
    "mode": "example",
    "nextPaymentDate": "example",
    "resource": "example",
    "startDate": "example",
    "status": "example",
    "times": 1,
    "timesRemaining": 1
  }
}

Delete customer

Delete a customer. Their mandates and subscriptions are canceled too.

Inputs

Customercustomer_idtextRequired
The Mollie customer.

Outputs

dataobject
The response from Mollie.
Example output
{
  "data": {}
}

Delete a payment link that has not been opened or paid yet.

Inputs

Payment linkpayment_link_idtextRequired
The payment link, whose ID starts with pl_.

Outputs

dataobject
The response from Mollie.
Example output
{
  "data": {}
}

Get customer

Get a customer's details.

Inputs

Customercustomer_idtextRequired
The Mollie customer.

Outputs

dataobject
The response from Mollie.
Example output
{
  "data": {
    "createdAt": "example",
    "email": "example",
    "id": "example",
    "locale": "example",
    "mode": "example",
    "name": "example",
    "resource": "example"
  }
}

Get payment

Get a payment with its status, amounts and checkout link.

Inputs

Paymentpayment_idtextRequired
The payment, whose ID starts with tr_.

Outputs

dataobject
The response from Mollie.
Example output
{
  "data": {
    "_links": {
      "checkout": {
        "href": "example",
        "type": "example"
      },
      "dashboard": {
        "href": "example",
        "type": "example"
      }
    },
    "amount": {
      "currency": "example",
      "value": "example"
    },
    "amountRefunded": {
      "currency": "example",
      "value": "example"
    },
    "amountRemaining": {
      "currency": "example",
      "value": "example"
    },
    "createdAt": "example",
    "customerId": "example",
    "description": "example",
    "expiresAt": "example",
    "id": "example",
    "isCancelable": true,
    "mandateId": "example",
    "method": "example",
    "mode": "example",
    "paidAt": "example",
    "redirectUrl": "example",
    "resource": "example",
    "sequenceType": "example",
    "status": "example",
    "subscriptionId": "example",
    "webhookUrl": "example"
  }
}

Get a payment link with its address and whether it has been paid.

Inputs

Payment linkpayment_link_idtextRequired
The payment link, whose ID starts with pl_.

Outputs

dataobject
The response from Mollie.
Example output
{
  "data": {
    "_links": {
      "paymentLink": {
        "href": "example",
        "type": "example"
      },
      "self": {
        "href": "example",
        "type": "example"
      }
    },
    "amount": {
      "currency": "example",
      "value": "example"
    },
    "archived": true,
    "createdAt": "example",
    "description": "example",
    "expiresAt": "example",
    "id": "example",
    "mode": "example",
    "paidAt": "example",
    "redirectUrl": "example",
    "resource": "example",
    "reusable": true,
    "webhookUrl": "example"
  }
}

List chargebacks

List the chargebacks on your payments, newest first.

Inputs

Limitlimitnumber
How many chargebacks to return, up to 250. Mollie's default is 50.From 1 to 250.
Start fromstart_fromtext
To read the next page, the next_from value a previous list step returned.
Ordersorttext
Newest first (the default) or oldest first.One of: desc, asc.

Outputs

dataobject
The response from Mollie.
Example output
{
  "data": {
    "count": 1,
    "items": [
      {
        "amount": {
          "currency": "example",
          "value": "example"
        },
        "createdAt": "example",
        "id": "example",
        "paymentId": "example",
        "reason": {
          "code": "example",
          "description": "example"
        },
        "resource": "example",
        "reversedAt": "example"
      }
    ],
    "next_from": "example"
  }
}

List customers

List your customers, newest first.

Inputs

Limitlimitnumber
How many customers to return, up to 250. Mollie's default is 50.From 1 to 250.
Start fromstart_fromtext
To read the next page, the next_from value a previous list step returned.
Ordersorttext
Newest first (the default) or oldest first.One of: desc, asc.

Outputs

dataobject
The response from Mollie.
Example output
{
  "data": {
    "count": 1,
    "items": [
      {
        "createdAt": "example",
        "email": "example",
        "id": "example",
        "locale": "example",
        "mode": "example",
        "name": "example",
        "resource": "example"
      }
    ],
    "next_from": "example"
  }
}

List your payment links, newest first.

Inputs

Limitlimitnumber
How many payment links to return, up to 250. Mollie's default is 50.From 1 to 250.
Start fromstart_fromtext
To read the next page, the next_from value a previous list step returned.

Outputs

dataobject
The response from Mollie.
Example output
{
  "data": {
    "count": 1,
    "items": [
      {
        "_links": {
          "paymentLink": {
            "href": "example",
            "type": "example"
          },
          "self": {
            "href": "example",
            "type": "example"
          }
        },
        "amount": {
          "currency": "example",
          "value": "example"
        },
        "archived": true,
        "createdAt": "example",
        "description": "example",
        "expiresAt": "example",
        "id": "example",
        "mode": "example",
        "paidAt": "example",
        "redirectUrl": "example",
        "resource": "example",
        "reusable": true,
        "webhookUrl": "example"
      }
    ],
    "next_from": "example"
  }
}

List payment methods

List the payment methods enabled on your account, with their minimum and maximum amounts.

Inputs

Payment typesequence_typetext
Only methods that can be used for this kind of payment.One of: oneoff (One-off), first (First of a recurring series), recurring.
Languagelocaletext
Name the methods in this language.One of: en_US (English (US)), en_GB (English (UK)), en_BE (English (Belgium)), en_NL (English (Netherlands)), nl_NL (Dutch), nl_BE (Dutch (Belgium)), de_DE (German), de_AT (German (Austria)), de_CH (German (Switzerland)), de_LU (German (Luxembourg)), and 21 more.

Outputs

dataobject
The response from Mollie.
Example output
{
  "data": {
    "count": 1,
    "items": [
      {
        "description": "example",
        "id": "example",
        "maximumAmount": {
          "currency": "example",
          "value": "example"
        },
        "minimumAmount": {
          "currency": "example",
          "value": "example"
        },
        "resource": "example",
        "status": "example"
      }
    ],
    "next_from": "example"
  }
}

List payments

List your payments, newest first.

Inputs

Limitlimitnumber
How many payments to return, up to 250. Mollie's default is 50.From 1 to 250.
Start fromstart_fromtext
To read the next page, the next_from value a previous list step returned.
Ordersorttext
Newest first (the default) or oldest first.One of: desc, asc.

Outputs

dataobject
The response from Mollie.
Example output
{
  "data": {
    "count": 1,
    "items": [
      {
        "_links": {
          "checkout": {
            "href": "example",
            "type": "example"
          },
          "dashboard": {
            "href": "example",
            "type": "example"
          }
        },
        "amount": {
          "currency": "example",
          "value": "example"
        },
        "amountRefunded": {
          "currency": "example",
          "value": "example"
        },
        "amountRemaining": {
          "currency": "example",
          "value": "example"
        },
        "createdAt": "example",
        "customerId": "example",
        "description": "example",
        "expiresAt": "example",
        "id": "example",
        "isCancelable": true,
        "mandateId": "example",
        "method": "example",
        "mode": "example",
        "paidAt": "example",
        "redirectUrl": "example",
        "resource": "example",
        "sequenceType": "example",
        "status": "example",
        "subscriptionId": "example",
        "webhookUrl": "example"
      }
    ],
    "next_from": "example"
  }
}

List refunds

List your refunds across all payments, newest first.

Inputs

Limitlimitnumber
How many refunds to return, up to 250. Mollie's default is 50.From 1 to 250.
Start fromstart_fromtext
To read the next page, the next_from value a previous list step returned.
Ordersorttext
Newest first (the default) or oldest first.One of: desc, asc.

Outputs

dataobject
The response from Mollie.
Example output
{
  "data": {
    "count": 1,
    "items": [
      {
        "amount": {
          "currency": "example",
          "value": "example"
        },
        "createdAt": "example",
        "description": "example",
        "id": "example",
        "mode": "example",
        "paymentId": "example",
        "resource": "example",
        "status": "example"
      }
    ],
    "next_from": "example"
  }
}

List subscriptions

List the subscriptions of all your customers, newest first.

Inputs

Limitlimitnumber
How many subscriptions to return, up to 250. Mollie's default is 50.From 1 to 250.
Start fromstart_fromtext
To read the next page, the next_from value a previous list step returned.

Outputs

dataobject
The response from Mollie.
Example output
{
  "data": {
    "count": 1,
    "items": [
      {
        "amount": {
          "currency": "example",
          "value": "example"
        },
        "canceledAt": "example",
        "createdAt": "example",
        "customerId": "example",
        "description": "example",
        "id": "example",
        "interval": "example",
        "mandateId": "example",
        "method": "example",
        "mode": "example",
        "nextPaymentDate": "example",
        "resource": "example",
        "startDate": "example",
        "status": "example",
        "times": 1,
        "timesRemaining": 1
      }
    ],
    "next_from": "example"
  }
}

Refund payment

Refund all or part of a paid payment, in the payment's own currency.

Inputs

Paymentpayment_idtextRequired
The payment, whose ID starts with tr_.
Amountamountnumber
How much to refund. Leave empty to refund everything not yet refunded.At least 0.
Descriptiondescriptiontext
A note about the refund. The customer may see it.

Outputs

dataobject
The response from Mollie.
Example output
{
  "data": {
    "amount": {
      "currency": "example",
      "value": "example"
    },
    "createdAt": "example",
    "description": "example",
    "id": "example",
    "mode": "example",
    "paymentId": "example",
    "resource": "example",
    "status": "example"
  }
}

Revoke mandate

Revoke a customer's mandate. It can no longer be charged, and its subscriptions are canceled.

Inputs

Customercustomer_idtextRequired
The Mollie customer.
Mandatemandate_idtextRequired
The mandate, whose ID starts with mdt_.

Outputs

dataobject
The response from Mollie.
Example output
{
  "data": {}
}

Update customer

Change a customer's name, email or language. Anything left empty stays as it is.

Inputs

Customercustomer_idtextRequired
The Mollie customer.
Namenametext
The new name.
Emailemailtext
The new email address.
Languagelocaletext
The new language for Mollie's payment pages.One of: en_US (English (US)), en_GB (English (UK)), en_BE (English (Belgium)), en_NL (English (Netherlands)), nl_NL (Dutch), nl_BE (Dutch (Belgium)), de_DE (German), de_AT (German (Austria)), de_CH (German (Switzerland)), de_LU (German (Luxembourg)), and 21 more.

Outputs

dataobject
The response from Mollie.
Example output
{
  "data": {
    "createdAt": "example",
    "email": "example",
    "id": "example",
    "locale": "example",
    "mode": "example",
    "name": "example",
    "resource": "example"
  }
}

Change a payment link's description, or archive it so no one can pay through it.

Inputs

Payment linkpayment_link_idtextRequired
The payment link, whose ID starts with pl_.
Descriptiondescriptiontext
A new description.
Archivedarchivedtrue/false
Archive the link so no more payments can be made through it, or unarchive it.

Outputs

dataobject
The response from Mollie.
Example output
{
  "data": {
    "_links": {
      "paymentLink": {
        "href": "example",
        "type": "example"
      },
      "self": {
        "href": "example",
        "type": "example"
      }
    },
    "amount": {
      "currency": "example",
      "value": "example"
    },
    "archived": true,
    "createdAt": "example",
    "description": "example",
    "expiresAt": "example",
    "id": "example",
    "mode": "example",
    "paidAt": "example",
    "redirectUrl": "example",
    "resource": "example",
    "reusable": true,
    "webhookUrl": "example"
  }
}

On this page