Skip to content

conekta/ct-conekta-java

BranchesTags

Repository files navigation

ct-conekta-java

Conekta API

  • API version: 2.1.0

Conekta sdk

For more information, please visit https://github.com/conekta/openapi/issues

Automatically generated by the OpenAPI Generator

Requirements

Building the API client library requires:

  1. Java 11+
  2. Maven (3.8.3+)/Gradle (7.2+)

Installation

To install the API client library to your local Maven repository, simply execute:

mvn clean install

To deploy it to a remote Maven repository instead, configure the settings of the repository and execute:

mvn clean deploy

Refer to the OSSRH Guide for more information.

Maven users

Add this dependency to your project's POM:

<dependency>
  <groupId>io.conekta</groupId>
  <artifactId>ct-conekta-java</artifactId>
  <version>6.1.3</version>
  <scope>compile</scope>
</dependency>

Gradle users

Add this dependency to your project's build file:

  repositories {
    mavenCentral()     // Needed if the 'ct-conekta-java' jar has been published to maven central.
    mavenLocal()       // Needed if the 'ct-conekta-java' jar has been published to the local maven repo.
  }

  dependencies {
     implementation "io.conekta:ct-conekta-java:6.1.3"
  }

Others

At first generate the JAR by executing:

mvn clean package

Then manually install the following JARs:

  • target/ct-conekta-java-6.1.3.jar
  • target/lib/*.jar

Usage

To add a HTTP proxy for the API client, use ClientConfig:

import org.glassfish.jersey.apache.connector.ApacheConnectorProvider;
import org.glassfish.jersey.client.ClientConfig;
import org.glassfish.jersey.client.ClientProperties;
import com.conekta.*;
import com.conekta.AntifraudApi;

...

ApiClient defaultClient = Configuration.getDefaultApiClient();
ClientConfig clientConfig = defaultClient.getClientConfig();
clientConfig.connectorProvider(new ApacheConnectorProvider());
clientConfig.property(ClientProperties.PROXY_URI, "http://proxy_url_here");
clientConfig.property(ClientProperties.PROXY_USERNAME, "proxy_username");
clientConfig.property(ClientProperties.PROXY_PASSWORD, "proxy_password");
defaultClient.setClientConfig(clientConfig);

AntifraudApi apiInstance = new AntifraudApi(defaultClient);

Getting Started

Please follow the installation instruction and execute the following Java code:

import com.conekta.*;
import com.conekta.auth.*;
import com.conekta.model.*;
import com.conekta.CustomersApi;

public class CustomersApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure HTTP bearer authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("API_KEY");

        CustomersApi apiInstance = new CustomersApi(defaultClient);
        Customer customer = new Customer(); // Customer | requested field for customer
        customer.setName("Customer Name");
        customer.setEmail("[email protected]");
        customer.setPhone("55454545454");
        String acceptLanguage = "es"; // String | Use for knowing which language to use
        try {
            CustomerResponse result = apiInstance.createCustomer(customer, acceptLanguage,null);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CustomersApi#createCustomer");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Documentation for API Endpoints

All URIs are relative to https://api.conekta.io

Class Method HTTP request Description
AntifraudApi createRuleBlacklist POST /antifraud/blacklists Create blacklisted rule
AntifraudApi createRuleWhitelist POST /antifraud/whitelists Create whitelisted rule
AntifraudApi deleteRuleBlacklist DELETE /antifraud/blacklists/{id} Delete blacklisted rule
AntifraudApi deleteRuleWhitelist DELETE /antifraud/whitelists/{id} Delete whitelisted rule
AntifraudApi getRuleBlacklist GET /antifraud/blacklists Get list of blacklisted rules
AntifraudApi getRuleWhitelist GET /antifraud/whitelists Get a list of whitelisted rules
ApiKeysApi createApiKey POST /api_keys Create Api Key
ApiKeysApi deleteApiKey DELETE /api_keys/{id} Delete Api Key
ApiKeysApi getApiKey GET /api_keys/{id} Get Api Key
ApiKeysApi getApiKeys GET /api_keys Get list of Api Keys
ApiKeysApi updateApiKey PUT /api_keys/{id} Update Api Key
BalancesApi getBalance GET /balance Get a company's balance
ChargesApi getCharges GET /charges Get A List of Charges
ChargesApi ordersCreateCharge POST /orders/{id}/charges Create charge
ChargesApi updateCharge PUT /charges/{id} Update a charge
CompaniesApi getCompanies GET /companies Get List of Companies
CompaniesApi getCompany GET /companies/{id} Get Company
CustomersApi createCustomer POST /customers Create customer
CustomersApi createCustomerFiscalEntities POST /customers/{id}/fiscal_entities Create Fiscal Entity
CustomersApi deleteCustomerById DELETE /customers/{id} Delete Customer
CustomersApi getCustomerById GET /customers/{id} Get Customer
CustomersApi getCustomers GET /customers Get a list of customers
CustomersApi updateCustomer PUT /customers/{id} Update customer
CustomersApi updateCustomerFiscalEntities PUT /customers/{id}/fiscal_entities/{fiscal_entities_id} Update Fiscal Entity
DiscountsApi ordersCreateDiscountLine POST /orders/{id}/discount_lines Create Discount
DiscountsApi ordersDeleteDiscountLines DELETE /orders/{id}/discount_lines/{discount_lines_id} Delete Discount
DiscountsApi ordersGetDiscountLine GET /orders/{id}/discount_lines/{discount_lines_id} Get Discount
DiscountsApi ordersGetDiscountLines GET /orders/{id}/discount_lines Get a List of Discount
DiscountsApi ordersUpdateDiscountLines PUT /orders/{id}/discount_lines/{discount_lines_id} Update Discount
EventsApi getEvent GET /events/{id} Get Event
EventsApi getEvents GET /events Get list of Events
EventsApi resendEvent POST /events/{event_id}/webhook_logs/{webhook_log_id}/resend Resend Event
LogsApi getLogById GET /logs/{id} Get Log
LogsApi getLogs GET /logs Get List Of Logs
OrdersApi cancelOrder POST /orders/{id}/cancel Cancel Order
OrdersApi createOrder POST /orders Create order
OrdersApi getOrderById GET /orders/{id} Get Order
OrdersApi getOrders GET /orders Get a list of Orders
OrdersApi orderCancelRefund DELETE /orders/{id}/refunds/{refund_id} Cancel Refund
OrdersApi orderRefund POST /orders/{id}/refunds Refund Order
OrdersApi ordersCreateCapture POST /orders/{id}/capture Capture Order
OrdersApi updateOrder PUT /orders/{id} Update Order
PaymentLinkApi cancelCheckout PUT /checkouts/{id}/cancel Cancel Payment Link
PaymentLinkApi createCheckout POST /checkouts Create Unique Payment Link
PaymentLinkApi emailCheckout POST /checkouts/{id}/email Send an email
PaymentLinkApi getCheckout GET /checkouts/{id} Get a payment link by ID
PaymentLinkApi getCheckouts GET /checkouts Get a list of payment links
PaymentLinkApi smsCheckout POST /checkouts/{id}/sms Send an sms
PaymentMethodsApi createCustomerPaymentMethods POST /customers/{id}/payment_sources Create Payment Method
PaymentMethodsApi deleteCustomerPaymentMethods DELETE /customers/{id}/payment_sources/{payment_method_id} Delete Payment Method
PaymentMethodsApi getCustomerPaymentMethods GET /customers/{id}/payment_sources Get Payment Methods
PaymentMethodsApi updateCustomerPaymentMethods PUT /customers/{id}/payment_sources/{payment_method_id} Update Payment Method
PayoutOrdersApi createPayoutOrder POST /payout_orders Create payout order
PayoutOrdersApi getPayoutOrderById GET /payout_orders/{id} Get Payout Order
PayoutOrdersApi getPayoutOrders GET /payout_orders Get a list of Payout Orders
PlansApi createPlan POST /plans Create Plan
PlansApi deletePlan DELETE /plans/{id} Delete Plan
PlansApi getPlan GET /plans/{id} Get Plan
PlansApi getPlans GET /plans Get A List of Plans
PlansApi updatePlan PUT /plans/{id} Update Plan
ProductsApi ordersCreateProduct POST /orders/{id}/line_items Create Product
ProductsApi ordersDeleteProduct DELETE /orders/{id}/line_items/{line_item_id} Delete Product
ProductsApi ordersUpdateProduct PUT /orders/{id}/line_items/{line_item_id} Update Product
ShippingContactsApi createCustomerShippingContacts POST /customers/{id}/shipping_contacts Create a shipping contacts
ShippingContactsApi deleteCustomerShippingContacts DELETE /customers/{id}/shipping_contacts/{shipping_contacts_id} Delete shipping contacts
ShippingContactsApi updateCustomerShippingContacts PUT /customers/{id}/shipping_contacts/{shipping_contacts_id} Update shipping contacts
ShippingsApi ordersCreateShipping POST /orders/{id}/shipping_lines Create Shipping
ShippingsApi ordersDeleteShipping DELETE /orders/{id}/shipping_lines/{shipping_id} Delete Shipping
ShippingsApi ordersUpdateShipping PUT /orders/{id}/shipping_lines/{shipping_id} Update Shipping
SubscriptionsApi cancelSubscription POST /customers/{id}/subscription/cancel Cancel Subscription
SubscriptionsApi createSubscription POST /customers/{id}/subscription Create Subscription
SubscriptionsApi getAllEventsFromSubscription GET /customers/{id}/subscription/events Get Events By Subscription
SubscriptionsApi getSubscription GET /customers/{id}/subscription Get Subscription
SubscriptionsApi pauseSubscription POST /customers/{id}/subscription/pause Pause Subscription
SubscriptionsApi resumeSubscription POST /customers/{id}/subscription/resume Resume Subscription
SubscriptionsApi updateSubscription PUT /customers/{id}/subscription Update Subscription
TaxesApi ordersCreateTaxes POST /orders/{id}/tax_lines Create Tax
TaxesApi ordersDeleteTaxes DELETE /orders/{id}/tax_lines/{tax_id} Delete Tax
TaxesApi ordersUpdateTaxes PUT /orders/{id}/tax_lines/{tax_id} Update Tax
TokensApi createToken POST /tokens Create Token
TransactionsApi getTransaction GET /transactions/{id} Get transaction
TransactionsApi getTransactions GET /transactions Get List transactions
TransfersApi getTransfer GET /transfers/{id} Get Transfer
TransfersApi getTransfers GET /transfers Get a list of transfers
WebhookKeysApi createWebhookKey POST /webhook_keys Create Webhook Key
WebhookKeysApi deleteWebhookKey DELETE /webhook_keys/{id} Delete Webhook key
WebhookKeysApi getWebhookKey GET /webhook_keys/{id} Get Webhook Key
WebhookKeysApi getWebhookKeys GET /webhook_keys Get List of Webhook Keys
WebhookKeysApi updateWebhookKey PUT /webhook_keys/{id} Update Webhook Key
WebhooksApi createWebhook POST /webhooks Create Webhook
WebhooksApi deleteWebhook DELETE /webhooks/{id} Delete Webhook
WebhooksApi getWebhook GET /webhooks/{id} Get Webhook
WebhooksApi getWebhooks GET /webhooks Get List of Webhooks
WebhooksApi testWebhook POST /webhooks/{id}/test Test Webhook
WebhooksApi updateWebhook PUT /webhooks/{id} Update Webhook

Documentation for Models

Documentation for Authorization

Authentication schemes defined for the API:

bearerAuth

  • Type: HTTP basic authentication

Recommendation

It's recommended to create an instance of ApiClient per thread in a multithreaded environment to avoid any potential issues.

Author

[email protected]

About

Java library for the Conekta API.

conekta.com

Topics

java conekta

Resources

Readme

License

MIT license

Code of conduct

Code of conduct
Activity
Custom properties

Stars

3 stars

Watchers

5 watching

Forks

0 forks
Report repository

Releases 9

6.1.3 Latest
Oct 11, 2024
+ 8 releases

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •  

Languages