Mercadopago.Order (mercadopago_sdk_elixir v0.1.0)

Order lifecycle: create, process, capture, refund, cancel, and search.

Summary

Functions

cancel(client, order_id, opts \\ [])

Cancels an order.

capture(client, order_id, opts \\ [])

Captures an authorized order.

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

Creates an order from order_data.

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

Fetches an order by id.

process(client, order_id, opts \\ [])

Processes a previously created order.

refund(client, order_id, refund_data \\ nil, opts \\ [])

Refunds an order, fully or partially via refund_data.

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

Searches orders matching filters (query-string parameters).

Functions

cancel(client, order_id, opts \\ [])

@spec cancel(Mercadopago.Client.t(), String.t(), keyword()) ::
  Mercadopago.HTTP.response()

Cancels an order.

capture(client, order_id, opts \\ [])

@spec capture(Mercadopago.Client.t(), String.t(), keyword()) ::
  Mercadopago.HTTP.response()

Captures an authorized order.

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

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

Creates an order from order_data.

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

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

Fetches an order by id.

process(client, order_id, opts \\ [])

@spec process(Mercadopago.Client.t(), String.t(), keyword()) ::
  Mercadopago.HTTP.response()

Processes a previously created order.

refund(client, order_id, refund_data \\ nil, opts \\ [])

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

Refunds an order, fully or partially via refund_data.

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

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

Searches orders matching filters (query-string parameters).