Create mandate

post

https://api.mollie.com/v2/customers/{customerId}/mandates

Create a mandate for a specific customer. Mandates allow you to charge a customer's card, PayPal account or bank account recurrently.

It is only possible to create mandates for IBANs and PayPal billing agreements with this endpoint. To create mandates for cards, your customers need to perform a 'first payment' with their card.

Access with

API key

Organization access token with mandates.write

OAuth access with mandates.write

Path Params

customerId

string

required

Provide the ID of the related customer.

Body Params

string

The identifier uniquely referring to this mandate. Example: mdt_pWUnw6pkBN.

method

string

required

Payment method of the mandate.

SEPA Direct Debit and PayPal mandates can be created directly.

Possible values: creditcard directdebit paypal

consumerName

string

required

The customer's name.

consumerAccount

string | null

The customer's IBAN. Required for SEPA Direct Debit mandates.

consumerBic

string | null

The BIC of the customer's bank.

consumerEmail

string | null

The customer's email address. Required for PayPal mandates.

signatureDate

string | null

The date when the mandate was signed in YYYY-MM-DD format.

mandateReference

string | null

A custom mandate reference. For SEPA Direct Debit, it is vital to provide a unique reference. Some banks will decline Direct Debit payments if the mandate reference is not unique.

paypalBillingAgreementId

string | null

The billing agreement ID given by PayPal. For example: B-12A34567B8901234CD. Required for PayPal mandates. Must provide either this field or payPalVaultId, but not both.

payPalVaultId

string | null

The Vault ID given by PayPal. For example: 8kk8451t. Required for PayPal mandates. Must provide either this field or paypalBillingAgreementId, but not both.

testmode

boolean | null

Whether to create the entity in test mode or live mode.

Most API credentials are specifically created for either live mode or test mode, in which case this parameter must not be sent. For organization-level credentials such as OAuth access tokens, you can enable test mode by setting testmode to true.

Responses

201The newly created mandate object.

404No entity with this ID exists.