Get customer

Customers API v1

Warning

The v1 API has been deprecated. The v1 API will be supported for the foreseeable future, at least until July 2023. However, new features will only be added to the v2 API.

The documentation for retrieving customers in the new v2 API can be found here. For more information on the v2 API, refer to our v2 migration guide.

GEThttps://api.mollie.com/v1/customers/*id*
Authentication:API keysApp access tokens

Retrieve a single customer by its ID.

Parameters

Replace id in the endpoint URL by the customer’s ID, for example cst_8wmqcHMN4U.

Access token parameters

If you are using organization access tokens or are creating an OAuth app, the testmode query string parameter is also available.

testmodebooleanoptional

Response

200 application/json

resourcestring
Indicates the response contains a customer object. Will always contain customer for this endpoint.
idstring
The customer’s unique identifier, for example cst_vsKJpSsabw.
modestring

The mode used to create this customer.

Possible values: live test

namestring
The full name of the customer as provided when the customer was created.
emailstring
The email address of the customer as provided when the customer was created.
localestring

Allows you to preset the language to be used in the hosted payment pages shown to the consumer. If this parameter was not provided when the customer was created, the browser language will be used instead in the payment flow (which is usually more accurate).

Possible values: en_US en_GB nl_NL nl_BE fr_FR fr_BE de_DE de_AT de_CH 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

metadatamixed
Data provided during the customer creation.
recentlyUsedMethodsarray

Payment methods that the customer recently used for payments.

Possible array values: banktransfer belfius creditcard directdebit eps giftcard giropay ideal kbc mistercash paypal paysafecard przelewy24 sofort

createdDatetimedatetime
The customer record’s date and time of creation, in ISO 8601 format.

Example

Request

1
2
curl -X GET https://api.mollie.com/v1/customers/cst_kEn1PlbGa \
    -H "Authorization: Bearer test_dHar4XY7LxsDOtmnkVtjNVWXLSlXsM"

Response

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
HTTP/1.1 200 OK
Content-Type: application/json

{
    "resource": "customer",
    "id": "cst_vsKJpSsabw",
    "mode": "test",
    "name": "Customer A",
    "email": "customer@example.org",
    "locale": "nl_NL",
    "metadata": null,
    "recentlyUsedMethods": [
        "creditcard",
        "ideal"
    ],
    "createdDatetime": "2016-04-06T13:23:21.0Z"
}