API Reference

Create customer

post
https://api.mollie.com/v2/customers

Creates a simple minimal representation of a customer. Payments, recurring mandates, and subscriptions can be linked to this customer object, which simplifies management of recurring payments.

Once registered, customers will also appear in your Mollie dashboard.

🔑

Access with

API keyAdvanced access token with customers.writeOAuth access with customers.write
Body Params
string | null

The full name of the customer.

string | null

The email address of the customer.

If the domain contains non-ASCII characters, encode it as Punycode per RFC 3492.

string | null

Preconfigure the language to be used in the hosted payment pages shown to the customer. Should only be provided if absolutely necessary. If not provided, the browser language will be used which is typically highly accurate.

Possible values: en_US en_GB nl_NL nl_BE de_DE de_AT de_CH de_LU fr_FR fr_BE fr_LU es_ES ca_ES pt_PT it_IT nb_NO sv_SE fi_FI da_DK is_IS hu_HU pl_PL lv_LV lt_LT null

Provide any data you like, for example a string or a JSON object. We will save the data alongside the entity. Whenever you fetch the entity with our API, we will also include the metadata. You can use up to approximately 1kB.

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

Updated about 1 month ago

Language
Credentials
LoadingLoading…
Response
Choose an example:
application/hal+json

Updated about 1 month ago