Class OrderTransactionClient

Client that use the Order APIs.

Inheritance

object

MercadoPagoClient<OrderTransaction>

OrderTransactionClient

Inherited Members

MercadoPagoClient<OrderTransaction>.HttpClient

MercadoPagoClient<OrderTransaction>.Serializer

MercadoPagoClient<OrderTransaction>.DefaultHeaders

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

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

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

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

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

MercadoPagoClient<OrderTransaction>.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 OrderTransactionClient : MercadoPagoClient<OrderTransaction>

Constructors

| Edit this page View Source

OrderTransactionClient()

Initializes a new instance of the OrderTransactionClient class.

Declaration

public OrderTransactionClient()

| Edit this page View Source

OrderTransactionClient(IHttpClient)

Initializes a new instance of the OrderTransactionClient class.

Declaration

public OrderTransactionClient(IHttpClient httpClient)

Parameters

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

| Edit this page View Source

OrderTransactionClient(IHttpClient, ISerializer)

Initializes a new instance of the OrderTransactionClient class.

Declaration

public OrderTransactionClient(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

OrderTransactionClient(ISerializer)

Initializes a new instance of the OrderTransactionClient class.

Declaration

public OrderTransactionClient(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

Create(string, OrderTransactionRequest, RequestOptions)

Create a transaction.

Declaration

public OrderTransaction Create(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

CreateAsync(string, OrderTransactionRequest, RequestOptions, CancellationToken)

Create a transaction as an asynchronous operation.

Declaration

public Task<OrderTransaction> CreateAsync(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

Delete(string, string, RequestOptions)

Delete a transaction.

Declaration

public OrderTransaction Delete(string oderId, string transactionId, RequestOptions requestOptions = null)

Parameters

Type	Name	Description
string	oderId	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

DeleteAsync(string, string, RequestOptions, CancellationToken)

Delete a transaction as an asynchronous operation.

Declaration

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

Parameters

Type	Name	Description
string	oderId	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

Update(string, string, OrderPaymentRequest, RequestOptions)

Update a transaction.

Declaration

public OrderUpdateTransaction Update(string orderId, string transactionId, OrderPaymentRequest request, RequestOptions requestOptions = null)

Parameters

Type	Name	Description
string	orderId	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

UpdateAsync(string, string, OrderPaymentRequest, RequestOptions, CancellationToken)

Update a transaction as an asynchronous operation.

Declaration

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

Parameters

Type	Name	Description
string	orderId	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.