Mercadopago.Preference (mercadopago_sdk_elixir v0.3.1)

Checkout Pro payment preferences.

This is the hosted flow: create a preference, then redirect the buyer to the init_point MercadoPago returns. For the Checkout API — where you own the payment form — see Mercadopago.Order and Mercadopago.Payment.

Summary

Functions

create(client, preference_data, opts \\ [])

Creates a preference from preference_data.

get(client, preference_id, opts \\ [])

Fetches a preference by id.

search(client, filters \\ nil, opts \\ [])

Searches preferences matching filters (query-string parameters).

search_stream(client, filters \\ nil, opts \\ [])

Streams every result of search/3, fetching each page as it is consumed.

update(client, preference_id, preference_data, opts \\ [])

Updates a preference.

Functions

create(client, preference_data, opts \\ [])

@spec create(Mercadopago.Client.t(), map(), keyword()) :: Mercadopago.HTTP.response()

Creates a preference from preference_data.

get(client, preference_id, opts \\ [])

@spec get(Mercadopago.Client.t(), Mercadopago.HTTP.id(), keyword()) ::
  Mercadopago.HTTP.response()

Fetches a preference by id.

search(client, filters \\ nil, opts \\ [])

@spec search(Mercadopago.Client.t(), map() | nil, keyword()) ::
  Mercadopago.HTTP.response()

Searches preferences matching filters (query-string parameters).

search_stream(client, filters \\ nil, opts \\ [])

@spec search_stream(Mercadopago.Client.t(), map() | nil, keyword()) :: Enumerable.t()

Streams every result of search/3, fetching each page as it is consumed.

See Mercadopago.Pagination.stream/3 for the options and for how failures are reported.

update(client, preference_id, preference_data, opts \\ [])

@spec update(Mercadopago.Client.t(), Mercadopago.HTTP.id(), map(), keyword()) ::
  Mercadopago.HTTP.response()

Updates a preference.