2017 © Pedro Peláez
 

library conekta-php

Conekta PHP Library

image

conekta/conekta-php

Conekta PHP Library

  • Wednesday, July 11, 2018
  • by Conekta
  • Repository
  • 22 Watchers
  • 47 Stars
  • 58,118 Installations
  • PHP
  • 7 Dependents
  • 0 Suggesters
  • 25 Forks
  • 1 Open issues
  • 42 Versions
  • 10 % Grown

The README.md

conekta

Conekta sdk, (*1)

For more information, please visit https://github.com/conekta/openapi/issues., (*2)

Installation & Usage

Requirements

PHP 7.4 and later. Should also work with PHP 8.0., (*3)

Composer

To install the bindings via Composer, add the following to composer.json:, (*4)

{
  "repositories": [
    {
      "type": "vcs",
      "url": "https://github.com/conekta/conekta-php.git"
    }
  ],
  "require": {
    "conekta/conekta-php": "*@dev"
  }
}

Then run composer install, (*5)

Manual Installation

Download the files and include autoload.php:, (*6)

<?php
require_once('/path/to/conekta/vendor/autoload.php');

Getting Started

Please follow the installation procedure and then run the following:, (*7)

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

use Conekta\Api\CustomersApi;
use Conekta\ApiException;
use Conekta\Configuration;
use Conekta\Model\Customer;

// Configure authorization
/**
 * @var string $apiKey use private key for authentication
 * @link https://developers.conekta.com/reference/autenticaci%C3%B3n for more information
 */
$apiKey =  getenv("CONEKTA_API_KEY");
$config = Conekta\Configuration::getDefaultConfiguration()->setAccessToken($apiKey);

$apiInstance = new CustomersApi(null, $config);
$rq = new Customer([
    'name' => 'Franklin carrero',
    'email'=> 'mm@gmail.com',
    'phone' => '+5218181818181'
]);
try {
    $result = $apiInstance->createCustomer($rq);
    $json_string = json_encode($result, JSON_PRETTY_PRINT);
    print_r($json_string);
} catch (ApiException $e) {
    echo 'Exception when calling CustomersApi->createCustomer: ', $e->getMessage(), PHP_EOL;
}

API Endpoints

All URIs are relative to https://api.conekta.io, (*8)

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 ordersCreateCharges POST /orders/{id}/add_charges Create charges
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 cancelPayoutOrderById PUT /payout_orders/{id}/cancel Cancel Payout Order
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

Models

Authorization

Authentication schemes defined for the API:, (*9)

bearerAuth

  • Type: Bearer authentication

Tests

To run the tests, use:, (*10)

composer install
vendor/bin/phpunit

Author

engineering@conekta.com, (*11)

About this package

This PHP package is automatically generated by the OpenAPI Generator project:, (*12)

  • API version: 2.1.0
    • Package version: 6.0.11
    • Generator version: 7.9.0
  • Build package: org.openapitools.codegen.languages.PhpClientCodegen

The Versions

11/07 2018

dev-master

9999999-dev https://www.conekta.io/

Conekta PHP Library

  Sources   Download

MIT

The Requires

  • ext-curl *
  • ext-json *
  • ext-mbstring *
  • php ~7.0

 

The Development Requires

by Conekta and contributors

api payment processing conekta

11/07 2018

dev-dev

dev-dev https://www.conekta.io/

Conekta PHP Library

  Sources   Download

MIT

The Requires

  • ext-curl *
  • ext-json *
  • ext-mbstring *
  • php ~7.0

 

The Development Requires

by Conekta and contributors

api payment processing conekta

11/07 2018

v4.0.4

4.0.4.0 https://www.conekta.io/

Conekta PHP Library

  Sources   Download

MIT

The Requires

  • ext-curl *
  • ext-json *
  • ext-mbstring *
  • php ~7.0

 

The Development Requires

by Conekta and contributors

api payment processing conekta

11/07 2018

dev-feature/version-bump-4-0-4

dev-feature/version-bump-4-0-4 https://www.conekta.io/

Conekta PHP Library

  Sources   Download

MIT

The Requires

  • ext-curl *
  • ext-json *
  • ext-mbstring *
  • php ~7.0

 

The Development Requires

by Conekta and contributors

api payment processing conekta

10/07 2018

dev-feature/create-offline-recurrent-reference-method

dev-feature/create-offline-recurrent-reference-method https://www.conekta.io/

Conekta PHP Library

  Sources   Download

MIT

The Requires

  • ext-curl *
  • ext-json *
  • ext-mbstring *
  • php ~7.0

 

The Development Requires

by Conekta and contributors

api payment processing conekta

19/06 2018

dev-feature/void-test

dev-feature/void-test https://www.conekta.io/

Conekta PHP Library

  Sources   Download

MIT

The Requires

  • ext-curl *
  • ext-json *
  • ext-mbstring *
  • php ~7.0

 

The Development Requires

by Conekta and contributors

api payment processing conekta

25/04 2018

dev-develop

dev-develop https://www.conekta.io/

Conekta PHP Library

  Sources   Download

MIT

The Requires

  • ext-curl *
  • ext-json *
  • ext-mbstring *
  • php ~7.0

 

The Development Requires

by Conekta and contributors

api payment processing conekta

25/04 2018

dev-php7.2-support

dev-php7.2-support https://www.conekta.io/

Conekta PHP Library

  Sources   Download

MIT

The Requires

  • ext-curl *
  • ext-json *
  • ext-mbstring *
  • php ~7.0

 

The Development Requires

by Conekta and contributors

api payment processing conekta

24/04 2018

v4.0.3

4.0.3.0 https://www.conekta.io/

Conekta PHP Library

  Sources   Download

MIT

The Requires

  • ext-curl *
  • ext-json *
  • ext-mbstring *
  • php ~7.0

 

The Development Requires

by Conekta and contributors

api payment processing conekta

26/03 2018

v4.0.2

4.0.2.0 https://www.conekta.io/

Conekta PHP Library

  Sources   Download

MIT

The Requires

  • ext-curl *
  • ext-json *
  • ext-mbstring *
  • php ~7.0

 

The Development Requires

by Conekta and contributors

api payment processing conekta

22/03 2018

dev-feature/oxxo-recurrent

dev-feature/oxxo-recurrent https://www.conekta.io/

Conekta PHP Library

  Sources   Download

MIT

The Requires

  • ext-curl *
  • ext-json *
  • ext-mbstring *
  • php ~7.0

 

The Development Requires

by Conekta and contributors

api payment processing conekta

30/12 2017

v4.0.1

4.0.1.0 https://www.conekta.io/

Conekta PHP Library

  Sources   Download

MIT

The Requires

  • ext-curl *
  • ext-json *
  • ext-mbstring *
  • php >=5.3

 

The Development Requires

by Conekta and contributors

api payment processing conekta

13/09 2017

v4.0.0

4.0.0.0 https://www.conekta.io/

Conekta PHP Library

  Sources   Download

MIT

The Requires

  • ext-curl *
  • ext-json *
  • ext-mbstring *
  • php >=5.3

 

The Development Requires

by Conekta and contributors

api payment processing conekta

13/09 2017

dev-php-v3

dev-php-v3 https://www.conekta.io/

Conekta PHP Library

  Sources   Download

MIT

The Requires

  • ext-curl *
  • ext-json *
  • ext-mbstring *
  • php >=5.3

 

The Development Requires

by Conekta and contributors

api payment processing conekta

08/09 2017

v3.5.1

3.5.1.0 https://www.conekta.io/

Conekta PHP Library

  Sources   Download

MIT

The Requires

  • ext-curl *
  • ext-json *
  • ext-mbstring *
  • php >=5.3

 

The Development Requires

by Conekta and contributors

api payment processing conekta

28/08 2017

dev-changelog

dev-changelog https://www.conekta.io/

Conekta PHP Library

  Sources   Download

MIT

The Requires

  • ext-curl *
  • ext-json *
  • ext-mbstring *
  • php >=5.3

 

The Development Requires

by Conekta and contributors

api payment processing conekta

28/08 2017

v2.0.5-a

2.0.5.0-alpha https://www.conekta.io/

Conekta PHP Library

  Sources   Download

MIT

The Requires

  • ext-curl *
  • ext-json *
  • ext-mbstring *
  • php >=5.3

 

The Development Requires

by Conekta and contributors

api payment processing conekta

28/08 2017

v3.5.0

3.5.0.0 https://www.conekta.io/

Conekta PHP Library

  Sources   Download

MIT

The Requires

  • ext-curl *
  • ext-json *
  • ext-mbstring *
  • php >=5.3

 

The Development Requires

by Conekta and contributors

api payment processing conekta

28/08 2017

dev-ca-bundle

dev-ca-bundle https://www.conekta.io/

Conekta PHP Library

  Sources   Download

MIT

The Requires

  • ext-curl *
  • ext-json *
  • ext-mbstring *
  • php >=5.3

 

The Development Requires

by Conekta and contributors

api payment processing conekta

16/08 2017

v3.4.0

3.4.0.0 https://www.conekta.io/

Conekta PHP Library

  Sources   Download

MIT

The Requires

  • ext-curl *
  • ext-json *
  • ext-mbstring *
  • php >=5.3

 

The Development Requires

by Conekta and contributors

api payment processing conekta

11/07 2017

dev-repo-cover-update

dev-repo-cover-update https://www.conekta.io/

Conekta PHP Library

  Sources   Download

MIT

The Requires

  • ext-curl *
  • ext-json *
  • ext-mbstring *
  • php >=5.3

 

The Development Requires

by Conekta and contributors

api payment processing conekta

30/05 2017

V3.3.0

3.3.0.0 https://www.conekta.io/

Conekta PHP Library

  Sources   Download

MIT

The Requires

  • ext-curl *
  • ext-json *
  • ext-mbstring *
  • php >=5.3

 

The Development Requires

by Conekta and contributors

api payment processing conekta

30/05 2017

dev-feature/refactoring

dev-feature/refactoring https://www.conekta.io/

Conekta PHP Library

  Sources   Download

MIT

The Requires

  • ext-curl *
  • ext-json *
  • ext-mbstring *
  • php >=5.3

 

The Development Requires

by Conekta and contributors

api payment processing conekta

16/02 2017

v3.2.0

3.2.0.0 https://www.conekta.io/

Conekta PHP Library

  Sources   Download

MIT

The Requires

  • ext-curl *
  • ext-json *
  • ext-mbstring *
  • php >=5.3

 

The Development Requires

by Conekta and contributors

api payment processing conekta

02/02 2017

3.1.0

3.1.0.0 https://www.conekta.io/

Conekta PHP Library

  Sources   Download

MIT

The Requires

  • ext-curl *
  • ext-json *
  • ext-mbstring *
  • php >=5.3

 

The Development Requires

by Conekta and contributors

api payment processing conekta

16/11 2016

v3.0.0

3.0.0.0 https://www.conekta.io/

Conekta PHP Library

  Sources   Download

MIT

The Requires

  • ext-curl *
  • ext-json *
  • ext-mbstring *
  • php >=5.2

 

The Development Requires

by Conekta and contributors

api payment processing conekta

05/07 2016

v2.0.5

2.0.5.0 https://www.conekta.io/

PHP Library

  Sources   Download

MIT

The Requires

  • ext-curl *
  • ext-json *
  • ext-mbstring *
  • php >=5.2

 

The Development Requires

by Conekta and contributors

api payment processing conekta

24/02 2016

v2.0.4

2.0.4.0 https://www.conekta.io/

PHP Library

  Sources   Download

MIT

The Requires

  • ext-curl *
  • ext-json *
  • ext-mbstring *
  • php >=5.2

 

The Development Requires

by Conekta and contributors

api payment processing conekta

24/02 2016

v2.0.3

2.0.3.0 https://www.conekta.io/

PHP Library

  Sources   Download

MIT

The Requires

  • ext-curl *
  • ext-json *
  • ext-mbstring *
  • php >=5.2

 

The Development Requires

by Conekta and contributors

api payment processing conekta

26/01 2016

v2.0.2

2.0.2.0 https://www.conekta.io/

PHP Library

  Sources   Download

MIT

The Requires

  • ext-curl *
  • ext-json *
  • ext-mbstring *
  • php >=5.2

 

The Development Requires

by Conekta and contributors

api payment processing conekta

25/01 2016

v2.0.1

2.0.1.0 https://www.conekta.io/

PHP Library

  Sources   Download

MIT

The Requires

  • ext-curl *
  • ext-json *
  • ext-mbstring *
  • php >=5.2

 

The Development Requires

by Conekta and contributors

api payment processing conekta

07/11 2014

v2.0.0

2.0.0.0 https://www.conekta.io/

PHP Library

  Sources   Download

MIT

The Requires

  • ext-curl *
  • ext-json *
  • ext-mbstring *
  • php >=5.2

 

The Development Requires

by Conekta and contributors

api payment processing conekta

06/08 2014

v1.9.9

1.9.9.0 https://www.conekta.io/

PHP Library

  Sources   Download

MIT

The Requires

  • ext-curl *
  • ext-json *
  • ext-mbstring *
  • php >=5.2

 

The Development Requires

by Conekta and contributors

api payment processing conekta

21/07 2014

v1.9.8

1.9.8.0 https://www.conekta.io/

PHP Library

  Sources   Download

MIT

The Requires

  • ext-curl *
  • ext-json *
  • ext-mbstring *
  • php >=5.2

 

The Development Requires

by Conekta and contributors

api payment processing conekta

22/05 2014

1.9.7

1.9.7.0 https://www.conekta.io/

PHP Library

  Sources   Download

MIT

The Requires

  • ext-curl *
  • ext-json *
  • ext-mbstring *
  • php >=5.2

 

The Development Requires

by Conekta and contributors

api payment processing conekta

12/05 2014

v1.9.6

1.9.6.0 https://www.conekta.io/

PHP Library

  Sources   Download

MIT

The Requires

  • ext-curl *
  • ext-json *
  • ext-mbstring *
  • php >=5.2

 

The Development Requires

by Conekta and contributors

api payment processing conekta

29/04 2014

v1.9.5

1.9.5.0 https://www.conekta.io/

PHP Library

  Sources   Download

MIT

The Requires

  • ext-curl *
  • ext-json *
  • ext-mbstring *
  • php >=5.2

 

The Development Requires

by Conekta and contributors

api payment processing conekta

29/04 2014

v1.9.4

1.9.4.0 https://www.conekta.io/

PHP Library

  Sources   Download

MIT

The Requires

  • ext-curl *
  • ext-json *
  • ext-mbstring *
  • php >=5.2

 

The Development Requires

by Conekta and contributors

api payment processing conekta

08/04 2014

v1.9.3

1.9.3.0 https://www.conekta.io/

PHP Library

  Sources   Download

MIT

The Requires

  • ext-curl *
  • ext-json *
  • ext-mbstring *
  • php >=5.2

 

The Development Requires

by Conekta and contributors

api payment processing conekta

03/04 2014

v1.9.2

1.9.2.0 https://www.conekta.io/

PHP Library

  Sources   Download

MIT

The Requires

  • ext-curl *
  • ext-json *
  • ext-mbstring *
  • php >=5.2

 

The Development Requires

by Conekta and contributors

api payment processing conekta

21/01 2014

v1.9.1

1.9.1.0 https://www.conekta.io/

PHP Library

  Sources   Download

MIT

The Requires

  • ext-curl *
  • ext-json *
  • ext-mbstring *
  • php >=5.2

 

The Development Requires

by Conekta and contributors

api payment processing conekta

14/01 2014

v1.9.0

1.9.0.0 https://www.conekta.io/

PHP Library

  Sources   Download

MIT

The Requires

  • ext-curl *
  • ext-json *
  • ext-mbstring *
  • php >=5.2

 

The Development Requires

by Conekta and contributors

api payment processing conekta