Class OrderClient

Client that use the Order APIs.

Inheritance

object

MercadoPagoClient<Order>

OrderClient

Inherited Members

MercadoPagoClient<Order>.HttpClient

MercadoPagoClient<Order>.Serializer

MercadoPagoClient<Order>.DefaultHeaders

MercadoPagoClient<Order>.SendAsync(string, HttpMethod, object, RequestOptions, CancellationToken)

MercadoPagoClient<Order>.Send(string, HttpMethod, object, RequestOptions)

MercadoPagoClient<Order>.ListAsync(string, HttpMethod, object, RequestOptions, CancellationToken)

MercadoPagoClient<Order>.List(string, HttpMethod, object, RequestOptions)

MercadoPagoClient<Order>.SearchAsync<TPageResult>(string, SearchRequest, RequestOptions, CancellationToken)

MercadoPagoClient<Order>.Search<TPageResult>(string, SearchRequest, RequestOptions)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: MercadoPago.Client.Order

Assembly: MercadoPago.dll

Syntax

public class OrderClient : MercadoPagoClient<Order>

Constructors

| Edit this page View Source

OrderClient()

Initializes a new instance of the OrderClient class.

Declaration

public OrderClient()

| Edit this page View Source

OrderClient(IHttpClient)

Initializes a new instance of the OrderClient class.

Declaration

public OrderClient(IHttpClient httpClient)

Parameters

Type	Name	Description
IHttpClient	httpClient	The http client that will be used in HTTP requests.

| Edit this page View Source

OrderClient(IHttpClient, ISerializer)

Initializes a new instance of the OrderClient class.

Declaration

public OrderClient(IHttpClient httpClient, ISerializer serializer)

Parameters

Type	Name	Description
IHttpClient	httpClient	The http client that will be used in HTTP requests.
ISerializer	serializer	The serializer that will be used to serialize the HTTP requests content and to deserialize the HTTP response content.

| Edit this page View Source

OrderClient(ISerializer)

Initializes a new instance of the OrderClient class.

Declaration

public OrderClient(ISerializer serializer)

Parameters

Type	Name	Description
ISerializer	serializer	The serializer that will be used to serialize the HTTP requests content and to deserialize the HTTP response content.

Methods

| Edit this page View Source

Cancel(string, RequestOptions)

Cancel a order.

Declaration

public Order Cancel(string id, RequestOptions requestOptions = null)

Parameters

Type	Name	Description
string	id	The order id.
RequestOptions	requestOptions	RequestOptions.

Returns

Type	Description
Order	The canceled order.

Remarks

Check the API documentation here.

Exceptions

Type	Condition
MercadoPagoException	If a unexpected exception occurs.
MercadoPagoApiException	If the API returns a error.

| Edit this page View Source

CancelAsync(string, RequestOptions, CancellationToken)

Cancel a order as an asynchronous operation.

Declaration

public Task<Order> CancelAsync(string id, RequestOptions requestOptions = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	id	The order id.
RequestOptions	requestOptions	RequestOptions.
CancellationToken	cancellationToken	Cancellation token.

Returns

Type	Description
Task<Order>	A task whose the result is the canceled order.

Remarks

Check the API documentation here.

Exceptions

Type	Condition
MercadoPagoException	If a unexpected exception occurs.
MercadoPagoApiException	If the API returns a error.

| Edit this page View Source

Capture(string, RequestOptions)

Capture a order.

Declaration

public Order Capture(string id, RequestOptions requestOptions = null)

Parameters

Type	Name	Description
string	id	The order id.
RequestOptions	requestOptions	RequestOptions.

Returns

Type	Description
Order	The captured order.

Remarks

Check the API documentation here.

Exceptions

Type	Condition
MercadoPagoException	If a unexpected exception occurs.
MercadoPagoApiException	If the API returns a error.

| Edit this page View Source

CaptureAsync(string, RequestOptions, CancellationToken)

Capture a order as an asynchronous operation.

Declaration

public Task<Order> CaptureAsync(string id, RequestOptions requestOptions = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	id	The order id.
RequestOptions	requestOptions	RequestOptions.
CancellationToken	cancellationToken	Cancellation token.

Returns

Type	Description
Task<Order>	A task whose the result is the captured order.

Remarks

Check the API documentation here.

Exceptions

Type	Condition
MercadoPagoException	If a unexpected exception occurs.
MercadoPagoApiException	If the API returns a error.

| Edit this page View Source

Create(OrderCreateRequest, RequestOptions)

Creates a order.

Declaration

public Order Create(OrderCreateRequest request, RequestOptions requestOptions = null)

Parameters

Type	Name	Description
OrderCreateRequest	request	The data to create a order.
RequestOptions	requestOptions	RequestOptions.

Returns

Type	Description
Order	The created order.

Remarks

Check the API documentation here.

Exceptions

Type	Condition
MercadoPagoException	If a unexpected exception occurs.
MercadoPagoApiException	If the API returns a error.

| Edit this page View Source

CreateAsync(OrderCreateRequest, RequestOptions, CancellationToken)

Creates a order as an asynchronous operation.

Declaration

public Task<Order> CreateAsync(OrderCreateRequest request, RequestOptions requestOptions = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
OrderCreateRequest	request	The data to create a order.
RequestOptions	requestOptions	RequestOptions.
CancellationToken	cancellationToken	Cancellation token.

Returns

Type	Description
Task<Order>	A task whose the result is the created order.

Remarks

Check the API documentation here.

Exceptions

Type	Condition
MercadoPagoException	If a unexpected exception occurs.
MercadoPagoApiException	If the API returns a error.

| Edit this page View Source

CreateTransaction(string, OrderTransactionRequest, RequestOptions)

Create a transaction.

Declaration

public OrderTransaction CreateTransaction(string id, OrderTransactionRequest request, RequestOptions requestOptions = null)

Parameters

Type	Name	Description
string	id	The order id.
OrderTransactionRequest	request	The order transaction.
RequestOptions	requestOptions	RequestOptions.

Returns

Type	Description
OrderTransaction	The created transaction.

Remarks

Check the API documentation here.

Exceptions

Type	Condition
MercadoPagoException	If a unexpected exception occurs.
MercadoPagoApiException	If the API returns a error.

| Edit this page View Source

CreateTransactionAsync(string, OrderTransactionRequest, RequestOptions, CancellationToken)

Create a transaction as an asynchronous operation.

Declaration

public Task<OrderTransaction> CreateTransactionAsync(string id, OrderTransactionRequest request, RequestOptions requestOptions = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	id	The order id.
OrderTransactionRequest	request	The order transaction.
RequestOptions	requestOptions	RequestOptions.
CancellationToken	cancellationToken	Cancellation token.

Returns

Type	Description
Task<OrderTransaction>	A task whose the result is the created transaction.

Remarks

Check the API documentation here.

Exceptions

Type	Condition
MercadoPagoException	If a unexpected exception occurs.
MercadoPagoApiException	If the API returns a error.

| Edit this page View Source

DeleteTransaction(string, string, RequestOptions)

Delete a transaction.

Declaration

public OrderTransaction DeleteTransaction(string id, string transactionId, RequestOptions requestOptions = null)

Parameters

Type	Name	Description
string	id	The order id.
string	transactionId	The transaction id.
RequestOptions	requestOptions	RequestOptions.

Returns

Type	Description
OrderTransaction

Remarks

Check the API documentation here.

Exceptions

Type	Condition
MercadoPagoException	If a unexpected exception occurs.
MercadoPagoApiException	If the API returns a error.

| Edit this page View Source

DeleteTransactionAsync(string, string, RequestOptions, CancellationToken)

Delete a transaction as an asynchronous operation.

Declaration

public Task<OrderTransaction> DeleteTransactionAsync(string id, string transactionId, RequestOptions requestOptions = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	id	The order id.
string	transactionId	The transaction id.
RequestOptions	requestOptions	RequestOptions.
CancellationToken	cancellationToken	Cancellation token.

Returns

Type	Description
Task<OrderTransaction>

Remarks

Check the API documentation here.

Exceptions

Type	Condition
MercadoPagoException	If a unexpected exception occurs.
MercadoPagoApiException	If the API returns a error.

| Edit this page View Source

Get(string, RequestOptions)

Get a order.

Declaration

public Order Get(string id, RequestOptions requestOptions = null)

Parameters

Type	Name	Description
string	id	The order id.
RequestOptions	requestOptions	RequestOptions.

Returns

Type	Description
Order	An order.

Remarks

Check the API documentation here.

Exceptions

Type	Condition
MercadoPagoException	If a unexpected exception occurs.
MercadoPagoApiException	If the API returns a error.

| Edit this page View Source

GetAsync(string, RequestOptions, CancellationToken)

Get a order as an asynchronous operation.

Declaration

public Task<Order> GetAsync(string id, RequestOptions requestOptions = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	id	The order id.
RequestOptions	requestOptions	RequestOptions.
CancellationToken	cancellationToken	Cancellation token.

Returns

Type	Description
Task<Order>	A task whose the result is an order.

Remarks

Check the API documentation here.

Exceptions

Type	Condition
MercadoPagoException	If a unexpected exception occurs.
MercadoPagoApiException	If the API returns a error.

| Edit this page View Source

Process(string, RequestOptions)

Process a order.

Declaration

public Order Process(string id, RequestOptions requestOptions = null)

Parameters

Type	Name	Description
string	id	The order id.
RequestOptions	requestOptions	RequestOptions.

Returns

Type	Description
Order	The processed order.

Remarks

Check the API documentation here.

Exceptions

Type	Condition
MercadoPagoException	If a unexpected exception occurs.
MercadoPagoApiException	If the API returns a error.

| Edit this page View Source

ProcessAsync(string, RequestOptions, CancellationToken)

Process a order as an asynchronous operation.

Declaration

public Task<Order> ProcessAsync(string id, RequestOptions requestOptions = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	id	The order id.
RequestOptions	requestOptions	RequestOptions.
CancellationToken	cancellationToken	Cancellation token.

Returns

Type	Description
Task<Order>	A task whose the result is the processed order.

Remarks

Check the API documentation here.

Exceptions

Type	Condition
MercadoPagoException	If a unexpected exception occurs.
MercadoPagoApiException	If the API returns a error.

| Edit this page View Source

Refund(string, OrderRefundPaymentRequest, RequestOptions)

Refund a order or transaction.

Declaration

public Order Refund(string id, OrderRefundPaymentRequest request = null, RequestOptions requestOptions = null)

Parameters

Type	Name	Description
string	id	The order id.
OrderRefundPaymentRequest	request	The order refund.
RequestOptions	requestOptions	RequestOptions.

Returns

Type	Description
Order	The refunded order.

Remarks

Check the API documentation here.

Exceptions

Type	Condition
MercadoPagoException	If a unexpected exception occurs.
MercadoPagoApiException	If the API returns a error.

| Edit this page View Source

RefundAsync(string, OrderRefundPaymentRequest, RequestOptions, CancellationToken)

Refund a order or transaction as an asynchronous operation.

Declaration

public Task<Order> RefundAsync(string id, OrderRefundPaymentRequest request = null, RequestOptions requestOptions = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	id	The order id.
OrderRefundPaymentRequest	request	The order refund.
RequestOptions	requestOptions	RequestOptions.
CancellationToken	cancellationToken	Cancellation token.

Returns

Type	Description
Task<Order>	A task whose the result is the refunded order.

Remarks

Check the API documentation here.

Exceptions

Type	Condition
MercadoPagoException	If a unexpected exception occurs.
MercadoPagoApiException	If the API returns a error.

| Edit this page View Source

UpdateTransaction(string, string, OrderPaymentRequest, RequestOptions)

Update a transaction.

Declaration

public OrderUpdateTransaction UpdateTransaction(string id, string transactionId, OrderPaymentRequest request, RequestOptions requestOptions = null)

Parameters

Type	Name	Description
string	id	The order id.
string	transactionId	The transaction id.
OrderPaymentRequest	request	The order transaction.
RequestOptions	requestOptions	RequestOptions.

Returns

Type	Description
OrderUpdateTransaction	The updated transaction.

Remarks

Check the API documentation here.

Exceptions

Type	Condition
MercadoPagoException	If a unexpected exception occurs.
MercadoPagoApiException	If the API returns a error.

| Edit this page View Source

UpdateTransactionAsync(string, string, OrderPaymentRequest, RequestOptions, CancellationToken)

Update a transaction as an asynchronous operation.

Declaration

public Task<OrderUpdateTransaction> UpdateTransactionAsync(string id, string transactionId, OrderPaymentRequest request, RequestOptions requestOptions = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	id	The order id.
string	transactionId	The transaction id.
OrderPaymentRequest	request	The order transaction.
RequestOptions	requestOptions	RequestOptions.
CancellationToken	cancellationToken	Cancellation token.

Returns

Type	Description
Task<OrderUpdateTransaction>	A task whose the result is the updated transaction.

Remarks

Check the API documentation here.

Exceptions

Type	Condition
MercadoPagoException	If a unexpected exception occurs.
MercadoPagoApiException	If the API returns a error.