PaymentLinkApi

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

Method	HTTP request	Description
cancelCheckout	PUT /checkouts/{id}/cancel	Cancel Payment Link
createCheckout	POST /checkouts	Create Unique Payment Link
emailCheckout	POST /checkouts/{id}/email	Send an email
getCheckout	GET /checkouts/{id}	Get a payment link by ID
getCheckouts	GET /checkouts	Get a list of payment links
smsCheckout	POST /checkouts/{id}/sms	Send an sms

cancelCheckout

CheckoutResponse cancelCheckout(id, acceptLanguage, xChildCompanyId)

Cancel Payment Link

Example

// Import classes:
import com.conekta.ApiClient;
import com.conekta.ApiException;
import com.conekta.Configuration;
import com.conekta.auth.*;
import com.conekta.model.*;
import com.conekta.PaymentLinkApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("https://api.conekta.io");
        
        // Configure HTTP bearer authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        PaymentLinkApi apiInstance = new PaymentLinkApi(defaultClient);
        String id = "6307a60c41de27127515a575"; // String | Identifier of the resource
        String acceptLanguage = "es"; // String | Use for knowing which language to use
        String xChildCompanyId = "6441b6376b60c3a638da80af"; // String | In the case of a holding company, the company id of the child company to which will process the request.
        try {
            CheckoutResponse result = apiInstance.cancelCheckout(id, acceptLanguage, xChildCompanyId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PaymentLinkApi#cancelCheckout");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Parameters

Name	Type	Description	Notes
id	String	Identifier of the resource
acceptLanguage	String	Use for knowing which language to use	[optional] [default to es] [enum: es, en]
xChildCompanyId	String	In the case of a holding company, the company id of the child company to which will process the request.	[optional]

Return type

CheckoutResponse

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/vnd.conekta-v2.1.0+json

HTTP response details

Status code	Description	Response headers
200	successful operation	* Date - The date and time that the response was sent * Content-Type - The format of the response body * Content-Length - The length of the response body in bytes * Connection - The type of connection used to transfer the response * Conekta-Media-Type -
401	authentication error	-
402	payment required error	-
404	not found entity	-
422	parameter validation error	-
500	internal server error	-

createCheckout

CheckoutResponse createCheckout(checkout, acceptLanguage, xChildCompanyId)

Create Unique Payment Link

Example

// Import classes:
import com.conekta.ApiClient;
import com.conekta.ApiException;
import com.conekta.Configuration;
import com.conekta.auth.*;
import com.conekta.model.*;
import com.conekta.PaymentLinkApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("https://api.conekta.io");
        
        // Configure HTTP bearer authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        PaymentLinkApi apiInstance = new PaymentLinkApi(defaultClient);
        Checkout checkout = new Checkout(); // Checkout | requested field for checkout
        String acceptLanguage = "es"; // String | Use for knowing which language to use
        String xChildCompanyId = "6441b6376b60c3a638da80af"; // String | In the case of a holding company, the company id of the child company to which will process the request.
        try {
            CheckoutResponse result = apiInstance.createCheckout(checkout, acceptLanguage, xChildCompanyId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PaymentLinkApi#createCheckout");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Parameters

Name	Type	Description	Notes
checkout	Checkout	requested field for checkout
acceptLanguage	String	Use for knowing which language to use	[optional] [default to es] [enum: es, en]
xChildCompanyId	String	In the case of a holding company, the company id of the child company to which will process the request.	[optional]

Return type

CheckoutResponse

Authorization

bearerAuth

HTTP request headers

Content-Type: application/json
Accept: application/vnd.conekta-v2.1.0+json

HTTP response details

Status code	Description	Response headers
200	successful operation	* Date - The date and time that the response was sent * Content-Type - The format of the response body * Content-Length - The length of the response body in bytes * Connection - The type of connection used to transfer the response * Conekta-Media-Type -
401	authentication error	-
402	payment required error	-
422	parameter validation error	-
500	internal server error	-

emailCheckout

CheckoutResponse emailCheckout(id, emailCheckoutRequest, acceptLanguage, xChildCompanyId)

Send an email

Example

// Import classes:
import com.conekta.ApiClient;
import com.conekta.ApiException;
import com.conekta.Configuration;
import com.conekta.auth.*;
import com.conekta.model.*;
import com.conekta.PaymentLinkApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("https://api.conekta.io");
        
        // Configure HTTP bearer authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        PaymentLinkApi apiInstance = new PaymentLinkApi(defaultClient);
        String id = "6307a60c41de27127515a575"; // String | Identifier of the resource
        EmailCheckoutRequest emailCheckoutRequest = new EmailCheckoutRequest(); // EmailCheckoutRequest | requested field for sms checkout
        String acceptLanguage = "es"; // String | Use for knowing which language to use
        String xChildCompanyId = "6441b6376b60c3a638da80af"; // String | In the case of a holding company, the company id of the child company to which will process the request.
        try {
            CheckoutResponse result = apiInstance.emailCheckout(id, emailCheckoutRequest, acceptLanguage, xChildCompanyId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PaymentLinkApi#emailCheckout");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Parameters

Name	Type	Description	Notes
id	String	Identifier of the resource
emailCheckoutRequest	EmailCheckoutRequest	requested field for sms checkout
acceptLanguage	String	Use for knowing which language to use	[optional] [default to es] [enum: es, en]
xChildCompanyId	String	In the case of a holding company, the company id of the child company to which will process the request.	[optional]

Return type

CheckoutResponse

Authorization

bearerAuth

HTTP request headers

Content-Type: application/json
Accept: application/vnd.conekta-v2.1.0+json

HTTP response details

Status code	Description	Response headers
200	successful operation	* Date - The date and time that the response was sent * Content-Type - The format of the response body * Content-Length - The length of the response body in bytes * Connection - The type of connection used to transfer the response * Conekta-Media-Type -
401	authentication error	-
402	payment required error	-
404	not found entity	-
422	parameter validation error	-
500	internal server error	-

getCheckout

CheckoutResponse getCheckout(id, acceptLanguage, xChildCompanyId)

Get a payment link by ID

Example

// Import classes:
import com.conekta.ApiClient;
import com.conekta.ApiException;
import com.conekta.Configuration;
import com.conekta.auth.*;
import com.conekta.model.*;
import com.conekta.PaymentLinkApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("https://api.conekta.io");
        
        // Configure HTTP bearer authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        PaymentLinkApi apiInstance = new PaymentLinkApi(defaultClient);
        String id = "6307a60c41de27127515a575"; // String | Identifier of the resource
        String acceptLanguage = "es"; // String | Use for knowing which language to use
        String xChildCompanyId = "6441b6376b60c3a638da80af"; // String | In the case of a holding company, the company id of the child company to which will process the request.
        try {
            CheckoutResponse result = apiInstance.getCheckout(id, acceptLanguage, xChildCompanyId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PaymentLinkApi#getCheckout");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Parameters

Name	Type	Description	Notes
id	String	Identifier of the resource
acceptLanguage	String	Use for knowing which language to use	[optional] [default to es] [enum: es, en]
xChildCompanyId	String	In the case of a holding company, the company id of the child company to which will process the request.	[optional]

Return type

CheckoutResponse

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/vnd.conekta-v2.1.0+json

HTTP response details

Status code	Description	Response headers
200	successful operation	* Date - The date and time that the response was sent * Content-Type - The format of the response body * Content-Length - The length of the response body in bytes * Connection - The type of connection used to transfer the response * Conekta-Media-Type -
401	authentication error	-
402	payment required error	-
404	not found entity	-
422	parameter validation error	-
500	internal server error	-

getCheckouts

CheckoutsResponse getCheckouts(acceptLanguage, xChildCompanyId, limit, search, next, previous)

Get a list of payment links

Returns a list of links generated by the merchant

Example

// Import classes:
import com.conekta.ApiClient;
import com.conekta.ApiException;
import com.conekta.Configuration;
import com.conekta.auth.*;
import com.conekta.model.*;
import com.conekta.PaymentLinkApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("https://api.conekta.io");
        
        // Configure HTTP bearer authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        PaymentLinkApi apiInstance = new PaymentLinkApi(defaultClient);
        String acceptLanguage = "es"; // String | Use for knowing which language to use
        String xChildCompanyId = "6441b6376b60c3a638da80af"; // String | In the case of a holding company, the company id of the child company to which will process the request.
        Integer limit = 20; // Integer | The numbers of items to return, the maximum value is 250
        String search = "search_example"; // String | General order search, e.g. by mail, reference etc.
        String next = "next_example"; // String | next page
        String previous = "previous_example"; // String | previous page
        try {
            CheckoutsResponse result = apiInstance.getCheckouts(acceptLanguage, xChildCompanyId, limit, search, next, previous);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PaymentLinkApi#getCheckouts");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Parameters

Name	Type	Description	Notes
acceptLanguage	String	Use for knowing which language to use	[optional] [default to es] [enum: es, en]
xChildCompanyId	String	In the case of a holding company, the company id of the child company to which will process the request.	[optional]
limit	Integer	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]

Return type

CheckoutsResponse

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/vnd.conekta-v2.1.0+json

HTTP response details

Status code	Description	Response headers
200	successful operation	* Date - The date and time that the response was sent * Content-Type - The format of the response body * Content-Length - The length of the response body in bytes * Connection - The type of connection used to transfer the response * Conekta-Media-Type -
401	authentication error	-
402	payment required error	-
422	parameter validation error	-
500	internal server error	-

smsCheckout

CheckoutResponse smsCheckout(id, smsCheckoutRequest, acceptLanguage, xChildCompanyId)

Send an sms

Example

// Import classes:
import com.conekta.ApiClient;
import com.conekta.ApiException;
import com.conekta.Configuration;
import com.conekta.auth.*;
import com.conekta.model.*;
import com.conekta.PaymentLinkApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("https://api.conekta.io");
        
        // Configure HTTP bearer authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        PaymentLinkApi apiInstance = new PaymentLinkApi(defaultClient);
        String id = "6307a60c41de27127515a575"; // String | Identifier of the resource
        SmsCheckoutRequest smsCheckoutRequest = new SmsCheckoutRequest(); // SmsCheckoutRequest | requested field for sms checkout
        String acceptLanguage = "es"; // String | Use for knowing which language to use
        String xChildCompanyId = "6441b6376b60c3a638da80af"; // String | In the case of a holding company, the company id of the child company to which will process the request.
        try {
            CheckoutResponse result = apiInstance.smsCheckout(id, smsCheckoutRequest, acceptLanguage, xChildCompanyId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PaymentLinkApi#smsCheckout");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Parameters

Name	Type	Description	Notes
id	String	Identifier of the resource
smsCheckoutRequest	SmsCheckoutRequest	requested field for sms checkout
acceptLanguage	String	Use for knowing which language to use	[optional] [default to es] [enum: es, en]
xChildCompanyId	String	In the case of a holding company, the company id of the child company to which will process the request.	[optional]

Return type

CheckoutResponse

Authorization

bearerAuth

HTTP request headers

Content-Type: application/json
Accept: application/vnd.conekta-v2.1.0+json

HTTP response details

Status code	Description	Response headers
200	successful operation	* Date - The date and time that the response was sent * Content-Type - The format of the response body * Content-Length - The length of the response body in bytes * Connection - The type of connection used to transfer the response * Conekta-Media-Type -
401	authentication error	-
402	payment required error	-
404	not found entity	-
422	parameter validation error	-
500	internal server error	-

Files

PaymentLinkApi.md

Latest commit

History

PaymentLinkApi.md

File metadata and controls

PaymentLinkApi

cancelCheckout

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

createCheckout

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

emailCheckout

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

getCheckout

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

getCheckouts

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

smsCheckout

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details