Conekta\CustomersApi

All URIs are relative to https://api.conekta.io, except if the operation defines another base path.

Method	HTTP request	Description
createCustomer()	POST /customers	Create customer
createCustomerFiscalEntities()	POST /customers/{id}/fiscal_entities	Create Fiscal Entity
deleteCustomerById()	DELETE /customers/{id}	Delete Customer
getCustomerById()	GET /customers/{id}	Get Customer
getCustomers()	GET /customers	Get a list of customers
updateCustomer()	PUT /customers/{id}	Update customer
updateCustomerFiscalEntities()	PUT /customers/{id}/fiscal_entities/{fiscal_entities_id}	Update Fiscal Entity

`createCustomer()`

createCustomer($customer, $accept_language, $x_child_company_id): \Conekta\Model\CustomerResponse

Create customer

The purpose of business is to create and keep a customer, you will learn what elements you need to create a customer. Remember the credit and debit card tokenization process: https://developers.conekta.com/page/web-checkout-tokenizer

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure Bearer authorization: bearerAuth
$config = Conekta\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Conekta\Api\CustomersApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$customer = new \Conekta\Model\Customer(); // \Conekta\Model\Customer | requested field for customer
$accept_language = es; // string | Use for knowing which language to use
$x_child_company_id = 6441b6376b60c3a638da80af; // string | In the case of a holding company, the company id of the child company to which will process the request.

try {
    $result = $apiInstance->createCustomer($customer, $accept_language, $x_child_company_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CustomersApi->createCustomer: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
customer	\Conekta\Model\Customer	requested field for customer
accept_language	string	Use for knowing which language to use	[optional] [default to 'es']
x_child_company_id	string	In the case of a holding company, the company id of the child company to which will process the request.	[optional]

Return type

\Conekta\Model\CustomerResponse

Authorization

bearerAuth

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`createCustomerFiscalEntities()`

createCustomerFiscalEntities($id, $customer_fiscal_entities_request, $accept_language, $x_child_company_id): \Conekta\Model\CreateCustomerFiscalEntitiesResponse

Create Fiscal Entity

Create Fiscal entity resource that corresponds to a customer ID.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure Bearer authorization: bearerAuth
$config = Conekta\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Conekta\Api\CustomersApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$id = 6307a60c41de27127515a575; // string | Identifier of the resource
$customer_fiscal_entities_request = new \Conekta\Model\CustomerFiscalEntitiesRequest(); // \Conekta\Model\CustomerFiscalEntitiesRequest | requested field for customer fiscal entities
$accept_language = es; // string | Use for knowing which language to use
$x_child_company_id = 6441b6376b60c3a638da80af; // string | In the case of a holding company, the company id of the child company to which will process the request.

try {
    $result = $apiInstance->createCustomerFiscalEntities($id, $customer_fiscal_entities_request, $accept_language, $x_child_company_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CustomersApi->createCustomerFiscalEntities: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
id	string	Identifier of the resource
customer_fiscal_entities_request	\Conekta\Model\CustomerFiscalEntitiesRequest	requested field for customer fiscal entities
accept_language	string	Use for knowing which language to use	[optional] [default to 'es']
x_child_company_id	string	In the case of a holding company, the company id of the child company to which will process the request.	[optional]

Return type

\Conekta\Model\CreateCustomerFiscalEntitiesResponse

Authorization

bearerAuth

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`deleteCustomerById()`

deleteCustomerById($id, $accept_language, $x_child_company_id): \Conekta\Model\CustomerResponse

Delete Customer

Deleted a customer resource that corresponds to a customer ID.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure Bearer authorization: bearerAuth
$config = Conekta\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Conekta\Api\CustomersApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$id = 6307a60c41de27127515a575; // string | Identifier of the resource
$accept_language = es; // string | Use for knowing which language to use
$x_child_company_id = 6441b6376b60c3a638da80af; // string | In the case of a holding company, the company id of the child company to which will process the request.

try {
    $result = $apiInstance->deleteCustomerById($id, $accept_language, $x_child_company_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CustomersApi->deleteCustomerById: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
id	string	Identifier of the resource
accept_language	string	Use for knowing which language to use	[optional] [default to 'es']
x_child_company_id	string	In the case of a holding company, the company id of the child company to which will process the request.	[optional]

Return type

\Conekta\Model\CustomerResponse

Authorization

bearerAuth

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`getCustomerById()`

getCustomerById($id, $accept_language, $x_child_company_id): \Conekta\Model\CustomerResponse

Get Customer

Gets a customer resource that corresponds to a customer ID.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure Bearer authorization: bearerAuth
$config = Conekta\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Conekta\Api\CustomersApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$id = 6307a60c41de27127515a575; // string | Identifier of the resource
$accept_language = es; // string | Use for knowing which language to use
$x_child_company_id = 6441b6376b60c3a638da80af; // string | In the case of a holding company, the company id of the child company to which will process the request.

try {
    $result = $apiInstance->getCustomerById($id, $accept_language, $x_child_company_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CustomersApi->getCustomerById: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
id	string	Identifier of the resource
accept_language	string	Use for knowing which language to use	[optional] [default to 'es']
x_child_company_id	string	In the case of a holding company, the company id of the child company to which will process the request.	[optional]

Return type

\Conekta\Model\CustomerResponse

Authorization

bearerAuth

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`getCustomers()`

getCustomers($accept_language, $x_child_company_id, $limit, $search, $next, $previous): \Conekta\Model\CustomersResponse

Get a list of customers

The purpose of business is to create and maintain a client, you will learn what elements you need to obtain a list of clients, which can be paged.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure Bearer authorization: bearerAuth
$config = Conekta\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Conekta\Api\CustomersApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$accept_language = es; // string | Use for knowing which language to use
$x_child_company_id = 6441b6376b60c3a638da80af; // string | In the case of a holding company, the company id of the child company to which will process the request.
$limit = 20; // int | The numbers of items to return, the maximum value is 250
$search = 'search_example'; // string | General order search, e.g. by mail, reference etc.
$next = 'next_example'; // string | next page
$previous = 'previous_example'; // string | previous page

try {
    $result = $apiInstance->getCustomers($accept_language, $x_child_company_id, $limit, $search, $next, $previous);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CustomersApi->getCustomers: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
accept_language	string	Use for knowing which language to use	[optional] [default to 'es']
x_child_company_id	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]

Return type

\Conekta\Model\CustomersResponse

Authorization

bearerAuth

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`updateCustomer()`

updateCustomer($id, $update_customer, $accept_language, $x_child_company_id): \Conekta\Model\CustomerResponse

Update customer

You can update customer-related data

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure Bearer authorization: bearerAuth
$config = Conekta\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Conekta\Api\CustomersApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$id = 6307a60c41de27127515a575; // string | Identifier of the resource
$update_customer = new \Conekta\Model\UpdateCustomer(); // \Conekta\Model\UpdateCustomer | requested field for customer
$accept_language = es; // string | Use for knowing which language to use
$x_child_company_id = 6441b6376b60c3a638da80af; // string | In the case of a holding company, the company id of the child company to which will process the request.

try {
    $result = $apiInstance->updateCustomer($id, $update_customer, $accept_language, $x_child_company_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CustomersApi->updateCustomer: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
id	string	Identifier of the resource
update_customer	\Conekta\Model\UpdateCustomer	requested field for customer
accept_language	string	Use for knowing which language to use	[optional] [default to 'es']
x_child_company_id	string	In the case of a holding company, the company id of the child company to which will process the request.	[optional]

Return type

\Conekta\Model\CustomerResponse

Authorization

bearerAuth

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`updateCustomerFiscalEntities()`

updateCustomerFiscalEntities($id, $fiscal_entities_id, $customer_update_fiscal_entities_request, $accept_language, $x_child_company_id): \Conekta\Model\UpdateCustomerFiscalEntitiesResponse

Update Fiscal Entity

Update Fiscal Entity resource that corresponds to a customer ID.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure Bearer authorization: bearerAuth
$config = Conekta\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Conekta\Api\CustomersApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$id = 6307a60c41de27127515a575; // string | Identifier of the resource
$fiscal_entities_id = fis_ent_2tQ8HkkfbauaKP9Ho; // string | identifier
$customer_update_fiscal_entities_request = new \Conekta\Model\CustomerUpdateFiscalEntitiesRequest(); // \Conekta\Model\CustomerUpdateFiscalEntitiesRequest | requested field for customer update fiscal entities
$accept_language = es; // string | Use for knowing which language to use
$x_child_company_id = 6441b6376b60c3a638da80af; // string | In the case of a holding company, the company id of the child company to which will process the request.

try {
    $result = $apiInstance->updateCustomerFiscalEntities($id, $fiscal_entities_id, $customer_update_fiscal_entities_request, $accept_language, $x_child_company_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CustomersApi->updateCustomerFiscalEntities: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
id	string	Identifier of the resource
fiscal_entities_id	string	identifier
customer_update_fiscal_entities_request	\Conekta\Model\CustomerUpdateFiscalEntitiesRequest	requested field for customer update fiscal entities
accept_language	string	Use for knowing which language to use	[optional] [default to 'es']
x_child_company_id	string	In the case of a holding company, the company id of the child company to which will process the request.	[optional]

Return type

\Conekta\Model\UpdateCustomerFiscalEntitiesResponse

Authorization

bearerAuth

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

CustomersApi.md

Latest commit

History

CustomersApi.md

File metadata and controls

Conekta\CustomersApi

createCustomer()

Example

Parameters

Return type

Authorization

HTTP request headers

createCustomerFiscalEntities()

Example

Parameters

Return type

Authorization

HTTP request headers

deleteCustomerById()

Example

Parameters

Return type

Authorization

HTTP request headers

getCustomerById()

Example

Parameters

Return type

Authorization

HTTP request headers

getCustomers()

Example

Parameters

Return type

Authorization

HTTP request headers

updateCustomer()

Example

Parameters

Return type

Authorization

HTTP request headers

updateCustomerFiscalEntities()

Example

Parameters

Return type

Authorization

HTTP request headers

`createCustomer()`

`createCustomerFiscalEntities()`

`deleteCustomerById()`

`getCustomerById()`

`getCustomers()`

`updateCustomer()`

`updateCustomerFiscalEntities()`