Order lifecycle: create, process, capture, refund, cancel, and search.
Summary
Functions
Cancels an order.
Captures an authorized order.
Creates an order from order_data.
Creates a Checkout Pro order.
Fetches an order by id.
Processes a previously created order.
Refunds an order, fully or partially via refund_data.
Searches orders matching filters (query-string parameters).
Functions
@spec cancel(Mercadopago.Client.t(), String.t(), keyword()) :: Mercadopago.HTTP.response()
Cancels an order.
@spec capture(Mercadopago.Client.t(), String.t(), keyword()) :: Mercadopago.HTTP.response()
Captures an authorized order.
@spec create(Mercadopago.Client.t(), map(), keyword()) :: Mercadopago.HTTP.response()
Creates an order from order_data.
@spec create_checkout_pro(Mercadopago.Client.t(), map(), keyword()) :: Mercadopago.HTTP.response()
Creates a Checkout Pro order.
Convenience wrapper over create/3 that applies the Checkout Pro Orders API
defaults: type "online" and processing_mode "manual" when omitted.
If those fields are provided (atom or string key), they must already match
the Checkout Pro flow; otherwise an ArgumentError is raised.
@spec get(Mercadopago.Client.t(), String.t(), keyword()) :: Mercadopago.HTTP.response()
Fetches an order by id.
@spec process(Mercadopago.Client.t(), String.t(), keyword()) :: Mercadopago.HTTP.response()
Processes a previously created order.
@spec refund(Mercadopago.Client.t(), String.t(), map() | nil, keyword()) :: Mercadopago.HTTP.response()
Refunds an order, fully or partially via refund_data.
@spec search(Mercadopago.Client.t(), map() | nil, keyword()) :: Mercadopago.HTTP.response()
Searches orders matching filters (query-string parameters).