Mollie
App · 24 actions
Take payments, send payment links, issue refunds and run subscriptions with Mollie.
Actions
| Action | What it does |
|---|---|
| Cancel payment | Cancel a payment that can still be canceled, such as an open or pending one. |
| Cancel refund | Cancel a refund while it is still queued or pending, within about two hours of creating it. |
| Cancel subscription | Cancel a customer's subscription, so it makes no more payments. |
| Create customer | Create a customer, so you can link their payments and charge them again later. |
| Create payment | Create a payment and get the checkout link to send your customer to. |
| Create payment link | Create a link you can share for someone to pay you. |
| Create SEPA mandate | Record a customer's signed SEPA Direct Debit mandate, so you can charge their bank account with recurring payments and subscriptions. |
| Create subscription | Charge a customer with a valid mandate the same amount at a regular interval. |
| Delete customer | Delete a customer. |
| Delete payment link | Delete a payment link that has not been opened or paid yet. |
| Get customer | Get a customer's details. |
| Get payment | Get a payment with its status, amounts and checkout link. |
| Get payment link | Get a payment link with its address and whether it has been paid. |
| List chargebacks | List the chargebacks on your payments, newest first. |
| List customers | List your customers, newest first. |
| List payment links | List your payment links, newest first. |
| List payment methods | List the payment methods enabled on your account, with their minimum and maximum amounts. |
| List payments | List your payments, newest first. |
| List refunds | List your refunds across all payments, newest first. |
| List subscriptions | List the subscriptions of all your customers, newest first. |
| Refund payment | Refund all or part of a paid payment, in the payment's own currency. |
| Revoke mandate | Revoke a customer's mandate. |
| Update customer | Change a customer's name, email or language. |
| Update payment link | Change 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
- Payment
payment_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
- Payment
payment_idtextRequired - The payment, whose ID starts with tr_.
- Refund ID
refund_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
- Customer
customer_idtextRequired - The Mollie customer.
- Subscription
subscription_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
- Name
nametext - The customer's full name.
- Email
emailtext - The customer's email address.
- Language
localetext - 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
- Amount
amountnumberRequired - The amount to charge, for example 10.00.At least 0.
- Currency
currencytext - 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. - Description
descriptiontextRequired - What the payment is for. Customers may see it on their statement.
- Return page
redirect_urltext - Where to send the customer after they pay. Needed for every payment except recurring ones.
- Cancel page
cancel_urltext - Where to send the customer if they cancel. Leave empty to use the return page.
- Status updates URL
webhook_urltext - A web address Mollie calls whenever this payment's status changes.
- Payment method
methodtext - 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. - Language
localetext - 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. - Customer
customer_idtext - The Mollie customer.
- Payment type
sequence_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. - Mandate
mandate_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 payment link
Create a link you can share for someone to pay you.
Inputs
- Description
descriptiontextRequired - What the payment is for. Customers may see it on their statement.
- Amount
amountnumber - The amount to pay. Leave empty to let the customer enter one.At least 0.
- Currency
currencytext - 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 page
redirect_urltext - Where to send the customer after they pay.
- Status updates URL
webhook_urltext - A web address Mollie calls when a payment through the link changes status.
- Expires
expires_atdate and time - When the link stops working. Leave empty for a link that never expires.
- Reusable
reusabletrue/false - Let more than one payment be made through the link.
- Payment methods
allowed_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
- Customer
customer_idtextRequired - The Mollie customer.
- Account holder
consumer_nametextRequired - The account holder's name.
- IBAN
consumer_accounttextRequired - The account holder's IBAN.
- BIC
consumer_bictext - The BIC of the account holder's bank.
- Signed on
signature_datedate - The date the customer signed the mandate.
- Mandate reference
mandate_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
- Customer
customer_idtextRequired - The Mollie customer.
- Amount
amountnumberRequired - The amount of each payment, for example 10.00.At least 0.
- Currency
currencytext - 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. - Every
intervaltextRequired - How often to charge, such as 1 month, 14 days or 2 weeks. At most 12 months.
- Description
descriptiontextRequired - What the subscription is for. Each payment carries it, and it must be unique for this customer.
- Number of payments
timesnumber - How many payments in total. Leave empty to keep charging until it is canceled.At least 1.
- Start date
start_datedate - The date of the first payment. Leave empty to start today.
- Status updates URL
webhook_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
- Customer
customer_idtextRequired - The Mollie customer.
Outputs
dataobject- The response from Mollie.
Example output
{
"data": {}
}Delete payment link
Delete a payment link that has not been opened or paid yet.
Inputs
- Payment link
payment_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
- Customer
customer_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
- Payment
payment_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 payment link
Get a payment link with its address and whether it has been paid.
Inputs
- Payment link
payment_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
- Limit
limitnumber - How many chargebacks to return, up to 250. Mollie's default is 50.From 1 to 250.
- Start from
start_fromtext - To read the next page, the next_from value a previous list step returned.
- Order
sorttext - 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
- Limit
limitnumber - How many customers to return, up to 250. Mollie's default is 50.From 1 to 250.
- Start from
start_fromtext - To read the next page, the next_from value a previous list step returned.
- Order
sorttext - 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 payment links
List your payment links, newest first.
Inputs
- Limit
limitnumber - How many payment links to return, up to 250. Mollie's default is 50.From 1 to 250.
- Start from
start_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 type
sequence_typetext - Only methods that can be used for this kind of payment.One of:
oneoff(One-off),first(First of a recurring series),recurring. - Language
localetext - 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
- Limit
limitnumber - How many payments to return, up to 250. Mollie's default is 50.From 1 to 250.
- Start from
start_fromtext - To read the next page, the next_from value a previous list step returned.
- Order
sorttext - 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
- Limit
limitnumber - How many refunds to return, up to 250. Mollie's default is 50.From 1 to 250.
- Start from
start_fromtext - To read the next page, the next_from value a previous list step returned.
- Order
sorttext - 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
- Limit
limitnumber - How many subscriptions to return, up to 250. Mollie's default is 50.From 1 to 250.
- Start from
start_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
- Payment
payment_idtextRequired - The payment, whose ID starts with tr_.
- Amount
amountnumber - How much to refund. Leave empty to refund everything not yet refunded.At least 0.
- Description
descriptiontext - 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
- Customer
customer_idtextRequired - The Mollie customer.
- Mandate
mandate_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
- Customer
customer_idtextRequired - The Mollie customer.
- Name
nametext - The new name.
- Email
emailtext - The new email address.
- Language
localetext - 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"
}
}Update payment link
Change a payment link's description, or archive it so no one can pay through it.
Inputs
- Payment link
payment_link_idtextRequired - The payment link, whose ID starts with pl_.
- Description
descriptiontext - A new description.
- Archived
archivedtrue/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"
}
}