mollie v0.7.2

Mollie.Profiles (mollie v0.7.2)

In order to process payments, you need to create a website profile. A website profile can easily be created via the Dashboard manually. However, the Mollie API also allows automatic profile creation via the Profiles API.

Link to this section Summary

Functions

create(client, body)

Create a website profile.

find(client, id)

Retrieve details of a profile, using the profile’s identifier.

list(client)

Retrieve all profiles available on the account. Results are paginated.

me(client)

Use this API if you are creating a plugin or SaaS application that allows users to enter a Mollie API key, and you want to give a confirmation of the website profile that will be used in your plugin or application.

remove(client, id)

Deletes a profile, rendering it unavailable for further API calls and transactions.

update(client, id, body)

Update a website profile.

Link to this section Functions

Link to this function

create(client, body)

Specs

create(Mollie.Client.t(), map() | list()) :: Mollie.response()

Create a website profile.

Profile body example

%{
  "name" => "Example Website",
  "website" => "https://www.example.com",
  "email" => "info@example.com",
  "phone" => "+31208202070"
}

example

 Example 

Mollie.Profiles.create client, profile_body

More info at: https://docs.mollie.com/reference/v2/profiles-api/create-profile

Link to this function

find(client, id)

Specs

find(Mollie.Client.t(), binary()) :: Mollie.response()

Retrieve details of a profile, using the profile’s identifier.

example

 Example 

Mollie.Profiles.find client, "pfl_v9hTwCvYqw"

More info at: https://docs.mollie.com/reference/v2/profiles-api/get-profile

Link to this function

list(client)

Specs

list(Mollie.Client.t()) :: Mollie.response()

Retrieve all profiles available on the account. Results are paginated.

example

 Example 

Mollie.Profiles.list client

More info at: https://docs.mollie.com/reference/v2/profiles-api/list-profiles

Link to this function

me(client)

Specs

me(Mollie.Client.t()) :: Mollie.response()

Use this API if you are creating a plugin or SaaS application that allows users to enter a Mollie API key, and you want to give a confirmation of the website profile that will be used in your plugin or application.

example

 Example 

Mollie.Profiles.me client

More info at: https://docs.mollie.com/reference/v2/profiles-api/get-profile-me

Link to this function

remove(client, id)

Specs

remove(Mollie.Client.t(), binary()) :: Mollie.response()

Deletes a profile, rendering it unavailable for further API calls and transactions.

example

 Example 

Mollie.Profiles.remove client, "pfl_v9hTwCvYqw"

More info at: https://docs.mollie.com/reference/v2/profiles-api/delete-profile

Link to this function

update(client, id, body)

Specs

update(Mollie.Client.t(), binary(), map() | list()) :: Mollie.response()

Update a website profile.

For a body example see create2.

example

 Example 

Mollie.Profiles.update client, "pfl_v9hTwCvYqw", profile_body

More info at: https://docs.mollie.com/reference/v2/profiles-api/update-profile