All URIs are relative to https://api.conekta.io
Method | HTTP request | Description |
---|---|---|
CancelOrder | POST /orders/{id}/cancel | Cancel Order |
CreateOrder | POST /orders | Create order |
GetOrderById | GET /orders/{id} | Get Order |
GetOrders | GET /orders | Get a list of Orders |
OrderCancelRefund | DELETE /orders/{id}/refunds/{refund_id} | Cancel Refund |
OrderRefund | POST /orders/{id}/refunds | Refund Order |
OrdersCreateCapture | POST /orders/{id}/capture | Capture Order |
UpdateOrder | PUT /orders/{id} | Update Order |
OrderResponse CancelOrder (string id, string acceptLanguage = null, string xChildCompanyId = null)
Cancel Order
Cancel an order that has been previously created.
using System.Collections.Generic;
using System.Diagnostics;
using Conekta.net.Api;
using Conekta.net.Client;
using Conekta.net.Model;
namespace Example
{
public class CancelOrderExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://api.conekta.io";
// Configure Bearer token for authorization: bearerAuth
config.AccessToken = "YOUR_BEARER_TOKEN";
var apiInstance = new OrdersApi(config);
var id = 6307a60c41de27127515a575; // string | Identifier of the resource
var acceptLanguage = es; // string | Use for knowing which language to use (optional) (default to es)
var xChildCompanyId = 6441b6376b60c3a638da80af; // string | In the case of a holding company, the company id of the child company to which will process the request. (optional)
try
{
// Cancel Order
OrderResponse result = apiInstance.CancelOrder(id, acceptLanguage, xChildCompanyId);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling OrdersApi.CancelOrder: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
This returns an ApiResponse object which contains the response data, status code and headers.
try
{
// Cancel Order
ApiResponse<OrderResponse> response = apiInstance.CancelOrderWithHttpInfo(id, acceptLanguage, xChildCompanyId);
Debug.Write("Status Code: " + response.StatusCode);
Debug.Write("Response Headers: " + response.Headers);
Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
Debug.Print("Exception when calling OrdersApi.CancelOrderWithHttpInfo: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
Name | Type | Description | Notes |
---|---|---|---|
id | string | Identifier of the resource | |
acceptLanguage | string | Use for knowing which language to use | [optional] [default to es] |
xChildCompanyId | string | In the case of a holding company, the company id of the child company to which will process the request. | [optional] |
- Content-Type: Not defined
- Accept: application/vnd.conekta-v2.1.0+json
Status code | Description | Response headers |
---|---|---|
200 | successful | - |
401 | authentication error | - |
402 | payment required error | - |
404 | not found entity | - |
428 | Precondition Required | - |
500 | internal server error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
OrderResponse CreateOrder (OrderRequest orderRequest, string acceptLanguage = null, string xChildCompanyId = null)
Create order
Create a new order.
using System.Collections.Generic;
using System.Diagnostics;
using Conekta.net.Api;
using Conekta.net.Client;
using Conekta.net.Model;
namespace Example
{
public class CreateOrderExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://api.conekta.io";
// Configure Bearer token for authorization: bearerAuth
config.AccessToken = "YOUR_BEARER_TOKEN";
var apiInstance = new OrdersApi(config);
var orderRequest = new OrderRequest(); // OrderRequest | requested field for order
var acceptLanguage = es; // string | Use for knowing which language to use (optional) (default to es)
var xChildCompanyId = 6441b6376b60c3a638da80af; // string | In the case of a holding company, the company id of the child company to which will process the request. (optional)
try
{
// Create order
OrderResponse result = apiInstance.CreateOrder(orderRequest, acceptLanguage, xChildCompanyId);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling OrdersApi.CreateOrder: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
This returns an ApiResponse object which contains the response data, status code and headers.
try
{
// Create order
ApiResponse<OrderResponse> response = apiInstance.CreateOrderWithHttpInfo(orderRequest, acceptLanguage, xChildCompanyId);
Debug.Write("Status Code: " + response.StatusCode);
Debug.Write("Response Headers: " + response.Headers);
Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
Debug.Print("Exception when calling OrdersApi.CreateOrderWithHttpInfo: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
Name | Type | Description | Notes |
---|---|---|---|
orderRequest | OrderRequest | requested field for order | |
acceptLanguage | string | Use for knowing which language to use | [optional] [default to es] |
xChildCompanyId | string | In the case of a holding company, the company id of the child company to which will process the request. | [optional] |
- Content-Type: application/json
- Accept: application/vnd.conekta-v2.1.0+json
Status code | Description | Response headers |
---|---|---|
200 | successful operation | - |
422 | parameter validation error | - |
401 | authentication error | - |
402 | payment required error | - |
500 | internal server error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
OrderResponse GetOrderById (string id, string acceptLanguage = null, string xChildCompanyId = null)
Get Order
Info for a specific order
using System.Collections.Generic;
using System.Diagnostics;
using Conekta.net.Api;
using Conekta.net.Client;
using Conekta.net.Model;
namespace Example
{
public class GetOrderByIdExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://api.conekta.io";
// Configure Bearer token for authorization: bearerAuth
config.AccessToken = "YOUR_BEARER_TOKEN";
var apiInstance = new OrdersApi(config);
var id = 6307a60c41de27127515a575; // string | Identifier of the resource
var acceptLanguage = es; // string | Use for knowing which language to use (optional) (default to es)
var xChildCompanyId = 6441b6376b60c3a638da80af; // string | In the case of a holding company, the company id of the child company to which will process the request. (optional)
try
{
// Get Order
OrderResponse result = apiInstance.GetOrderById(id, acceptLanguage, xChildCompanyId);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling OrdersApi.GetOrderById: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
This returns an ApiResponse object which contains the response data, status code and headers.
try
{
// Get Order
ApiResponse<OrderResponse> response = apiInstance.GetOrderByIdWithHttpInfo(id, acceptLanguage, xChildCompanyId);
Debug.Write("Status Code: " + response.StatusCode);
Debug.Write("Response Headers: " + response.Headers);
Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
Debug.Print("Exception when calling OrdersApi.GetOrderByIdWithHttpInfo: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
Name | Type | Description | Notes |
---|---|---|---|
id | string | Identifier of the resource | |
acceptLanguage | string | Use for knowing which language to use | [optional] [default to es] |
xChildCompanyId | string | In the case of a holding company, the company id of the child company to which will process the request. | [optional] |
- Content-Type: Not defined
- Accept: application/vnd.conekta-v2.1.0+json
Status code | Description | Response headers |
---|---|---|
200 | successful | - |
401 | authentication error | - |
404 | not found entity | - |
500 | internal server error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GetOrdersResponse GetOrders (string acceptLanguage = null, string xChildCompanyId = null, int? limit = null, string search = null, string next = null, string previous = null, string paymentStatus = null, string lastPaymentInfoStatus = null, long? createdAt = null, long? createdAtGte = null, long? createdAtLte = null, long? updatedAtGte = null, long? updatedAtLte = null)
Get a list of Orders
Get order details in the form of a list
using System.Collections.Generic;
using System.Diagnostics;
using Conekta.net.Api;
using Conekta.net.Client;
using Conekta.net.Model;
namespace Example
{
public class GetOrdersExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://api.conekta.io";
// Configure Bearer token for authorization: bearerAuth
config.AccessToken = "YOUR_BEARER_TOKEN";
var apiInstance = new OrdersApi(config);
var acceptLanguage = es; // string | Use for knowing which language to use (optional) (default to es)
var xChildCompanyId = 6441b6376b60c3a638da80af; // string | In the case of a holding company, the company id of the child company to which will process the request. (optional)
var limit = 20; // int? | The numbers of items to return, the maximum value is 250 (optional) (default to 20)
var search = "search_example"; // string | General order search, e.g. by mail, reference etc. (optional)
var next = "next_example"; // string | next page (optional)
var previous = "previous_example"; // string | previous page (optional)
var paymentStatus = paid; // string | Filters by order status (optional)
var lastPaymentInfoStatus = pending_payment; // string | Filters by last payment info status (optional)
var createdAt = 1612137600; // long? | created equal to (optional)
var createdAtGte = 1612137600; // long? | created at greater than or equal to (optional)
var createdAtLte = 1612137600; // long? | created at less than or equal to (optional)
var updatedAtGte = 1612137600; // long? | updated at greater than or equal to (optional)
var updatedAtLte = 1612137600; // long? | updated at less than or equal to (optional)
try
{
// Get a list of Orders
GetOrdersResponse result = apiInstance.GetOrders(acceptLanguage, xChildCompanyId, limit, search, next, previous, paymentStatus, lastPaymentInfoStatus, createdAt, createdAtGte, createdAtLte, updatedAtGte, updatedAtLte);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling OrdersApi.GetOrders: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
This returns an ApiResponse object which contains the response data, status code and headers.
try
{
// Get a list of Orders
ApiResponse<GetOrdersResponse> response = apiInstance.GetOrdersWithHttpInfo(acceptLanguage, xChildCompanyId, limit, search, next, previous, paymentStatus, lastPaymentInfoStatus, createdAt, createdAtGte, createdAtLte, updatedAtGte, updatedAtLte);
Debug.Write("Status Code: " + response.StatusCode);
Debug.Write("Response Headers: " + response.Headers);
Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
Debug.Print("Exception when calling OrdersApi.GetOrdersWithHttpInfo: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
Name | Type | Description | Notes |
---|---|---|---|
acceptLanguage | string | Use for knowing which language to use | [optional] [default to es] |
xChildCompanyId | string | In the case of a holding company, the company id of the child company to which will process the request. | [optional] |
limit | int? | The numbers of items to return, the maximum value is 250 | [optional] [default to 20] |
search | string | General order search, e.g. by mail, reference etc. | [optional] |
next | string | next page | [optional] |
previous | string | previous page | [optional] |
paymentStatus | string | Filters by order status | [optional] |
lastPaymentInfoStatus | string | Filters by last payment info status | [optional] |
createdAt | long? | created equal to | [optional] |
createdAtGte | long? | created at greater than or equal to | [optional] |
createdAtLte | long? | created at less than or equal to | [optional] |
updatedAtGte | long? | updated at greater than or equal to | [optional] |
updatedAtLte | long? | updated at less than or equal to | [optional] |
- Content-Type: Not defined
- Accept: application/vnd.conekta-v2.1.0+json
Status code | Description | Response headers |
---|---|---|
200 | successful operation | - |
401 | authentication error | - |
500 | internal server error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
OrderResponse OrderCancelRefund (string id, string refundId, string acceptLanguage = null, string xChildCompanyId = null)
Cancel Refund
A refunded order describes the items, amount, and reason an order is being refunded.
using System.Collections.Generic;
using System.Diagnostics;
using Conekta.net.Api;
using Conekta.net.Client;
using Conekta.net.Model;
namespace Example
{
public class OrderCancelRefundExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://api.conekta.io";
// Configure Bearer token for authorization: bearerAuth
config.AccessToken = "YOUR_BEARER_TOKEN";
var apiInstance = new OrdersApi(config);
var id = 6307a60c41de27127515a575; // string | Identifier of the resource
var refundId = 6407b5bee1329a000175ba11; // string | refund identifier
var acceptLanguage = es; // string | Use for knowing which language to use (optional) (default to es)
var xChildCompanyId = 6441b6376b60c3a638da80af; // string | In the case of a holding company, the company id of the child company to which will process the request. (optional)
try
{
// Cancel Refund
OrderResponse result = apiInstance.OrderCancelRefund(id, refundId, acceptLanguage, xChildCompanyId);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling OrdersApi.OrderCancelRefund: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
This returns an ApiResponse object which contains the response data, status code and headers.
try
{
// Cancel Refund
ApiResponse<OrderResponse> response = apiInstance.OrderCancelRefundWithHttpInfo(id, refundId, acceptLanguage, xChildCompanyId);
Debug.Write("Status Code: " + response.StatusCode);
Debug.Write("Response Headers: " + response.Headers);
Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
Debug.Print("Exception when calling OrdersApi.OrderCancelRefundWithHttpInfo: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
Name | Type | Description | Notes |
---|---|---|---|
id | string | Identifier of the resource | |
refundId | string | refund identifier | |
acceptLanguage | string | Use for knowing which language to use | [optional] [default to es] |
xChildCompanyId | string | In the case of a holding company, the company id of the child company to which will process the request. | [optional] |
- Content-Type: Not defined
- Accept: application/vnd.conekta-v2.1.0+json
Status code | Description | Response headers |
---|---|---|
200 | successful | - |
401 | authentication error | - |
402 | payment required error | - |
404 | not found entity | - |
422 | parameter validation error | - |
500 | internal server error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
OrderResponse OrderRefund (string id, OrderRefundRequest orderRefundRequest, string acceptLanguage = null, string xChildCompanyId = null)
Refund Order
A refunded order describes the items, amount, and reason an order is being refunded.
using System.Collections.Generic;
using System.Diagnostics;
using Conekta.net.Api;
using Conekta.net.Client;
using Conekta.net.Model;
namespace Example
{
public class OrderRefundExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://api.conekta.io";
// Configure Bearer token for authorization: bearerAuth
config.AccessToken = "YOUR_BEARER_TOKEN";
var apiInstance = new OrdersApi(config);
var id = 6307a60c41de27127515a575; // string | Identifier of the resource
var orderRefundRequest = new OrderRefundRequest(); // OrderRefundRequest | requested field for a refund
var acceptLanguage = es; // string | Use for knowing which language to use (optional) (default to es)
var xChildCompanyId = 6441b6376b60c3a638da80af; // string | In the case of a holding company, the company id of the child company to which will process the request. (optional)
try
{
// Refund Order
OrderResponse result = apiInstance.OrderRefund(id, orderRefundRequest, acceptLanguage, xChildCompanyId);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling OrdersApi.OrderRefund: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
This returns an ApiResponse object which contains the response data, status code and headers.
try
{
// Refund Order
ApiResponse<OrderResponse> response = apiInstance.OrderRefundWithHttpInfo(id, orderRefundRequest, acceptLanguage, xChildCompanyId);
Debug.Write("Status Code: " + response.StatusCode);
Debug.Write("Response Headers: " + response.Headers);
Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
Debug.Print("Exception when calling OrdersApi.OrderRefundWithHttpInfo: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
Name | Type | Description | Notes |
---|---|---|---|
id | string | Identifier of the resource | |
orderRefundRequest | OrderRefundRequest | requested field for a refund | |
acceptLanguage | string | Use for knowing which language to use | [optional] [default to es] |
xChildCompanyId | string | In the case of a holding company, the company id of the child company to which will process the request. | [optional] |
- Content-Type: application/json
- Accept: application/vnd.conekta-v2.1.0+json
Status code | Description | Response headers |
---|---|---|
200 | successful | - |
401 | authentication error | - |
402 | payment required error | - |
404 | not found entity | - |
422 | parameter validation error | - |
500 | internal server error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
OrderResponse OrdersCreateCapture (string id, string acceptLanguage = null, string xChildCompanyId = null, OrderCaptureRequest orderCaptureRequest = null)
Capture Order
Processes an order that has been previously authorized.
using System.Collections.Generic;
using System.Diagnostics;
using Conekta.net.Api;
using Conekta.net.Client;
using Conekta.net.Model;
namespace Example
{
public class OrdersCreateCaptureExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://api.conekta.io";
// Configure Bearer token for authorization: bearerAuth
config.AccessToken = "YOUR_BEARER_TOKEN";
var apiInstance = new OrdersApi(config);
var id = 6307a60c41de27127515a575; // string | Identifier of the resource
var acceptLanguage = es; // string | Use for knowing which language to use (optional) (default to es)
var xChildCompanyId = 6441b6376b60c3a638da80af; // string | In the case of a holding company, the company id of the child company to which will process the request. (optional)
var orderCaptureRequest = new OrderCaptureRequest(); // OrderCaptureRequest | requested fields for capture order (optional)
try
{
// Capture Order
OrderResponse result = apiInstance.OrdersCreateCapture(id, acceptLanguage, xChildCompanyId, orderCaptureRequest);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling OrdersApi.OrdersCreateCapture: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
This returns an ApiResponse object which contains the response data, status code and headers.
try
{
// Capture Order
ApiResponse<OrderResponse> response = apiInstance.OrdersCreateCaptureWithHttpInfo(id, acceptLanguage, xChildCompanyId, orderCaptureRequest);
Debug.Write("Status Code: " + response.StatusCode);
Debug.Write("Response Headers: " + response.Headers);
Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
Debug.Print("Exception when calling OrdersApi.OrdersCreateCaptureWithHttpInfo: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
Name | Type | Description | Notes |
---|---|---|---|
id | string | Identifier of the resource | |
acceptLanguage | string | Use for knowing which language to use | [optional] [default to es] |
xChildCompanyId | string | In the case of a holding company, the company id of the child company to which will process the request. | [optional] |
orderCaptureRequest | OrderCaptureRequest | requested fields for capture order | [optional] |
- Content-Type: application/json
- Accept: application/vnd.conekta-v2.1.0+json
Status code | Description | Response headers |
---|---|---|
200 | successful | - |
401 | authentication error | - |
404 | not found entity | - |
428 | Precondition Required | - |
500 | internal server error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
OrderResponse UpdateOrder (string id, OrderUpdateRequest orderUpdateRequest, string acceptLanguage = null)
Update Order
Update an existing Order.
using System.Collections.Generic;
using System.Diagnostics;
using Conekta.net.Api;
using Conekta.net.Client;
using Conekta.net.Model;
namespace Example
{
public class UpdateOrderExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://api.conekta.io";
// Configure Bearer token for authorization: bearerAuth
config.AccessToken = "YOUR_BEARER_TOKEN";
var apiInstance = new OrdersApi(config);
var id = 6307a60c41de27127515a575; // string | Identifier of the resource
var orderUpdateRequest = new OrderUpdateRequest(); // OrderUpdateRequest | requested field for an order
var acceptLanguage = es; // string | Use for knowing which language to use (optional) (default to es)
try
{
// Update Order
OrderResponse result = apiInstance.UpdateOrder(id, orderUpdateRequest, acceptLanguage);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling OrdersApi.UpdateOrder: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
This returns an ApiResponse object which contains the response data, status code and headers.
try
{
// Update Order
ApiResponse<OrderResponse> response = apiInstance.UpdateOrderWithHttpInfo(id, orderUpdateRequest, acceptLanguage);
Debug.Write("Status Code: " + response.StatusCode);
Debug.Write("Response Headers: " + response.Headers);
Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
Debug.Print("Exception when calling OrdersApi.UpdateOrderWithHttpInfo: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
Name | Type | Description | Notes |
---|---|---|---|
id | string | Identifier of the resource | |
orderUpdateRequest | OrderUpdateRequest | requested field for an order | |
acceptLanguage | string | Use for knowing which language to use | [optional] [default to es] |
- Content-Type: application/json
- Accept: application/vnd.conekta-v2.1.0+json
Status code | Description | Response headers |
---|---|---|
200 | successful | - |
401 | authentication error | - |
404 | not found entity | - |
422 | parameter validation error | - |
500 | internal server error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]