# Mollie

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

App · 24 actions. Web page: https://docs.lodol.com/docs/integrations/mollie

## Actions

### Cancel payment

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

**Inputs**

- Payment (`payment_id`, text, required): The payment, whose ID starts with tr_.

**Outputs**

- `data` (object): The response from Mollie.

**Example output**

```json
{
  "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_id`, text, required): The payment, whose ID starts with tr_.
- Refund ID (`refund_id`, text, required): The refund, whose ID starts with re_.

**Outputs**

- `data` (object): The response from Mollie.

**Example output**

```json
{
  "data": {}
}
```

### Cancel subscription

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

**Inputs**

- Customer (`customer_id`, text, required): The Mollie customer.
- Subscription (`subscription_id`, text, required): The subscription, whose ID starts with sub_.

**Outputs**

- `data` (object): The response from Mollie.

**Example output**

```json
{
  "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 (`name`, text): The customer's full name.
- Email (`email`, text): The customer's email address.
- Language (`locale`, text): 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**

- `data` (object): The response from Mollie.

**Example output**

```json
{
  "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 (`amount`, number, required): The amount to charge, for example 10.00. At least 0.
- Currency (`currency`, text): 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 (`description`, text, required): What the payment is for. Customers may see it on their statement.
- Return page (`redirect_url`, text): Where to send the customer after they pay. Needed for every payment except recurring ones.
- Cancel page (`cancel_url`, text): Where to send the customer if they cancel. Leave empty to use the return page.
- Status updates URL (`webhook_url`, text): A web address Mollie calls whenever this payment's status changes.
- Payment method (`method`, text): 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 (`locale`, text): 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_id`, text): The Mollie customer.
- Payment type (`sequence_type`, text): 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_id`, text): For a recurring payment: the mandate to charge. Leave empty to use any valid one.

**Outputs**

- `data` (object): The response from Mollie.

**Example output**

```json
{
  "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 (`description`, text, required): What the payment is for. Customers may see it on their statement.
- Amount (`amount`, number): The amount to pay. Leave empty to let the customer enter one. At least 0.
- Currency (`currency`, text): 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_url`, text): Where to send the customer after they pay.
- Status updates URL (`webhook_url`, text): A web address Mollie calls when a payment through the link changes status.
- Expires (`expires_at`, date and time): When the link stops working. Leave empty for a link that never expires.
- Reusable (`reusable`, true/false): Let more than one payment be made through the link.
- Payment methods (`allowed_methods`, list): 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**

- `data` (object): The response from Mollie.

**Example output**

```json
{
  "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_id`, text, required): The Mollie customer.
- Account holder (`consumer_name`, text, required): The account holder's name.
- IBAN (`consumer_account`, text, required): The account holder's IBAN.
- BIC (`consumer_bic`, text): The BIC of the account holder's bank.
- Signed on (`signature_date`, date): The date the customer signed the mandate.
- Mandate reference (`mandate_reference`, text): Your own unique reference for the mandate. Some banks decline direct debits when it is not unique.

**Outputs**

- `data` (object): The response from Mollie.

**Example output**

```json
{
  "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_id`, text, required): The Mollie customer.
- Amount (`amount`, number, required): The amount of each payment, for example 10.00. At least 0.
- Currency (`currency`, text): 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 (`interval`, text, required): How often to charge, such as 1 month, 14 days or 2 weeks. At most 12 months.
- Description (`description`, text, required): What the subscription is for. Each payment carries it, and it must be unique for this customer.
- Number of payments (`times`, number): How many payments in total. Leave empty to keep charging until it is canceled. At least 1.
- Start date (`start_date`, date): The date of the first payment. Leave empty to start today.
- Status updates URL (`webhook_url`, text): A web address Mollie calls whenever one of the subscription's payments changes status.

**Outputs**

- `data` (object): The response from Mollie.

**Example output**

```json
{
  "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_id`, text, required): The Mollie customer.

**Outputs**

- `data` (object): The response from Mollie.

**Example output**

```json
{
  "data": {}
}
```

### Delete payment link

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

**Inputs**

- Payment link (`payment_link_id`, text, required): The payment link, whose ID starts with pl_.

**Outputs**

- `data` (object): The response from Mollie.

**Example output**

```json
{
  "data": {}
}
```

### Get customer

Get a customer's details.

**Inputs**

- Customer (`customer_id`, text, required): The Mollie customer.

**Outputs**

- `data` (object): The response from Mollie.

**Example output**

```json
{
  "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_id`, text, required): The payment, whose ID starts with tr_.

**Outputs**

- `data` (object): The response from Mollie.

**Example output**

```json
{
  "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_id`, text, required): The payment link, whose ID starts with pl_.

**Outputs**

- `data` (object): The response from Mollie.

**Example output**

```json
{
  "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 (`limit`, number): How many chargebacks to return, up to 250. Mollie's default is 50. From 1 to 250.
- Start from (`start_from`, text): To read the next page, the next_from value a previous list step returned.
- Order (`sort`, text): Newest first (the default) or oldest first. One of: `desc`, `asc`.

**Outputs**

- `data` (object): The response from Mollie.

**Example output**

```json
{
  "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 (`limit`, number): How many customers to return, up to 250. Mollie's default is 50. From 1 to 250.
- Start from (`start_from`, text): To read the next page, the next_from value a previous list step returned.
- Order (`sort`, text): Newest first (the default) or oldest first. One of: `desc`, `asc`.

**Outputs**

- `data` (object): The response from Mollie.

**Example output**

```json
{
  "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 (`limit`, number): How many payment links to return, up to 250. Mollie's default is 50. From 1 to 250.
- Start from (`start_from`, text): To read the next page, the next_from value a previous list step returned.

**Outputs**

- `data` (object): The response from Mollie.

**Example output**

```json
{
  "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_type`, text): Only methods that can be used for this kind of payment. One of: `oneoff` (One-off), `first` (First of a recurring series), `recurring`.
- Language (`locale`, text): 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**

- `data` (object): The response from Mollie.

**Example output**

```json
{
  "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 (`limit`, number): How many payments to return, up to 250. Mollie's default is 50. From 1 to 250.
- Start from (`start_from`, text): To read the next page, the next_from value a previous list step returned.
- Order (`sort`, text): Newest first (the default) or oldest first. One of: `desc`, `asc`.

**Outputs**

- `data` (object): The response from Mollie.

**Example output**

```json
{
  "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 (`limit`, number): How many refunds to return, up to 250. Mollie's default is 50. From 1 to 250.
- Start from (`start_from`, text): To read the next page, the next_from value a previous list step returned.
- Order (`sort`, text): Newest first (the default) or oldest first. One of: `desc`, `asc`.

**Outputs**

- `data` (object): The response from Mollie.

**Example output**

```json
{
  "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 (`limit`, number): How many subscriptions to return, up to 250. Mollie's default is 50. From 1 to 250.
- Start from (`start_from`, text): To read the next page, the next_from value a previous list step returned.

**Outputs**

- `data` (object): The response from Mollie.

**Example output**

```json
{
  "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_id`, text, required): The payment, whose ID starts with tr_.
- Amount (`amount`, number): How much to refund. Leave empty to refund everything not yet refunded. At least 0.
- Description (`description`, text): A note about the refund. The customer may see it.

**Outputs**

- `data` (object): The response from Mollie.

**Example output**

```json
{
  "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_id`, text, required): The Mollie customer.
- Mandate (`mandate_id`, text, required): The mandate, whose ID starts with mdt_.

**Outputs**

- `data` (object): The response from Mollie.

**Example output**

```json
{
  "data": {}
}
```

### Update customer

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

**Inputs**

- Customer (`customer_id`, text, required): The Mollie customer.
- Name (`name`, text): The new name.
- Email (`email`, text): The new email address.
- Language (`locale`, text): 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**

- `data` (object): The response from Mollie.

**Example output**

```json
{
  "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_id`, text, required): The payment link, whose ID starts with pl_.
- Description (`description`, text): A new description.
- Archived (`archived`, true/false): Archive the link so no more payments can be made through it, or unarchive it.

**Outputs**

- `data` (object): The response from Mollie.

**Example output**

```json
{
  "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"
  }
}
```
