├── .devcontainer ├── devcontainer.json └── docker-compose.yml ├── .docker └── php │ └── Dockerfile ├── .editorconfig ├── .github ├── dependabot.yml └── workflows │ └── build_test.yml ├── .gitignore ├── .openapi-generator-ignore ├── .openapi-generator ├── FILES └── VERSION ├── .php-cs-fixer.dist.php ├── AUTHORS.md ├── CHANGELOG.md ├── CODE_OF_CONDUCT.md ├── CONTRIBUTING.md ├── Dockerfile ├── LICENSE ├── Makefile ├── README.md ├── VERSION ├── composer.json ├── conekta.png ├── config-php.json ├── docs ├── Api │ ├── AntifraudApi.md │ ├── ApiKeysApi.md │ ├── BalancesApi.md │ ├── ChargesApi.md │ ├── CompaniesApi.md │ ├── CustomersApi.md │ ├── DiscountsApi.md │ ├── EventsApi.md │ ├── LogsApi.md │ ├── OrdersApi.md │ ├── PaymentLinkApi.md │ ├── PaymentMethodsApi.md │ ├── PayoutOrdersApi.md │ ├── PlansApi.md │ ├── ProductsApi.md │ ├── ShippingContactsApi.md │ ├── ShippingsApi.md │ ├── SubscriptionsApi.md │ ├── TaxesApi.md │ ├── TokensApi.md │ ├── TransactionsApi.md │ ├── TransfersApi.md │ ├── WebhookKeysApi.md │ └── WebhooksApi.md └── Model │ ├── ApiKeyCreateResponse.md │ ├── ApiKeyRequest.md │ ├── ApiKeyResponse.md │ ├── ApiKeyResponseOnDelete.md │ ├── ApiKeyUpdateRequest.md │ ├── BalanceCommonField.md │ ├── BalanceResponse.md │ ├── BlacklistRuleResponse.md │ ├── ChargeOrderResponse.md │ ├── ChargeOrderResponsePaymentMethod.md │ ├── ChargeRequest.md │ ├── ChargeRequestPaymentMethod.md │ ├── ChargeResponse.md │ ├── ChargeResponseChannel.md │ ├── ChargeResponsePaymentMethod.md │ ├── ChargeResponseRefunds.md │ ├── ChargeResponseRefundsData.md │ ├── ChargeUpdateRequest.md │ ├── ChargesDataResponse.md │ ├── ChargesOrderResponse.md │ ├── ChargesOrderResponseAllOfData.md │ ├── Checkout.md │ ├── CheckoutOrderTemplate.md │ ├── CheckoutOrderTemplateCustomerInfo.md │ ├── CheckoutRequest.md │ ├── CheckoutResponse.md │ ├── CheckoutsResponse.md │ ├── CompanyFiscalInfoAddressResponse.md │ ├── CompanyFiscalInfoResponse.md │ ├── CompanyPayoutDestinationResponse.md │ ├── CompanyResponse.md │ ├── CreateCustomerFiscalEntitiesResponse.md │ ├── CreateCustomerPaymentMethodsRequest.md │ ├── CreateCustomerPaymentMethodsResponse.md │ ├── CreateRiskRulesData.md │ ├── Customer.md │ ├── CustomerAddress.md │ ├── CustomerAntifraudInfo.md │ ├── CustomerAntifraudInfoResponse.md │ ├── CustomerFiscalEntitiesDataResponse.md │ ├── CustomerFiscalEntitiesRequest.md │ ├── CustomerFiscalEntitiesResponse.md │ ├── CustomerInfo.md │ ├── CustomerInfoJustCustomerId.md │ ├── CustomerInfoJustCustomerIdResponse.md │ ├── CustomerPaymentMethodRequest.md │ ├── CustomerPaymentMethodsData.md │ ├── CustomerPaymentMethodsRequest.md │ ├── CustomerPaymentMethodsResponse.md │ ├── CustomerResponse.md │ ├── CustomerResponseShippingContacts.md │ ├── CustomerShippingContacts.md │ ├── CustomerShippingContactsAddress.md │ ├── CustomerShippingContactsDataResponse.md │ ├── CustomerShippingContactsResponse.md │ ├── CustomerShippingContactsResponseAddress.md │ ├── CustomerUpdateFiscalEntitiesRequest.md │ ├── CustomerUpdateShippingContacts.md │ ├── CustomersResponse.md │ ├── DeleteApiKeysResponse.md │ ├── DeletedBlacklistRuleResponse.md │ ├── DeletedWhitelistRuleResponse.md │ ├── Details.md │ ├── DetailsError.md │ ├── DiscountLinesDataResponse.md │ ├── DiscountLinesResponse.md │ ├── EmailCheckoutRequest.md │ ├── Error.md │ ├── EventResponse.md │ ├── EventTypes.md │ ├── EventsResendResponse.md │ ├── FiscalEntityAddress.md │ ├── GetApiKeysResponse.md │ ├── GetChargesResponse.md │ ├── GetCompaniesResponse.md │ ├── GetCustomerPaymentMethodDataResponse.md │ ├── GetEventsResponse.md │ ├── GetOrderDiscountLinesResponse.md │ ├── GetOrdersResponse.md │ ├── GetPaymentMethodResponse.md │ ├── GetPlansResponse.md │ ├── GetTransactionsResponse.md │ ├── GetTransfersResponse.md │ ├── GetWebhookKeysResponse.md │ ├── GetWebhooksResponse.md │ ├── LogResponse.md │ ├── LogsResponse.md │ ├── LogsResponseData.md │ ├── OrderCaptureRequest.md │ ├── OrderChannelResponse.md │ ├── OrderChargesResponse.md │ ├── OrderCustomerInfoResponse.md │ ├── OrderDiscountLinesRequest.md │ ├── OrderDiscountLinesResponse.md │ ├── OrderFiscalEntityAddressResponse.md │ ├── OrderFiscalEntityRequest.md │ ├── OrderFiscalEntityResponse.md │ ├── OrderNextActionResponse.md │ ├── OrderNextActionResponseRedirectToUrl.md │ ├── OrderRefundRequest.md │ ├── OrderRequest.md │ ├── OrderRequestCustomerInfo.md │ ├── OrderResponse.md │ ├── OrderResponseCheckout.md │ ├── OrderResponseCustomerInfo.md │ ├── OrderResponseProducts.md │ ├── OrderResponseShippingContact.md │ ├── OrderTaxRequest.md │ ├── OrderUpdateFiscalEntityRequest.md │ ├── OrderUpdateRequest.md │ ├── OrderUpdateRequestCustomerInfo.md │ ├── OrdersResponse.md │ ├── Page.md │ ├── Pagination.md │ ├── PaymentMethod.md │ ├── PaymentMethodBankTransfer.md │ ├── PaymentMethodBnplPayment.md │ ├── PaymentMethodBnplRequest.md │ ├── PaymentMethodCard.md │ ├── PaymentMethodCardRequest.md │ ├── PaymentMethodCardResponse.md │ ├── PaymentMethodCash.md │ ├── PaymentMethodCashRequest.md │ ├── PaymentMethodCashResponse.md │ ├── PaymentMethodCashResponseAllOfAgreements.md │ ├── PaymentMethodGeneralRequest.md │ ├── PaymentMethodResponse.md │ ├── PaymentMethodSpeiRecurrent.md │ ├── PaymentMethodSpeiRequest.md │ ├── PaymentMethodTokenRequest.md │ ├── Payout.md │ ├── PayoutMethod.md │ ├── PayoutOrder.md │ ├── PayoutOrderPayoutsItem.md │ ├── PayoutOrderResponse.md │ ├── PayoutOrderResponseCustomerInfo.md │ ├── PayoutOrdersResponse.md │ ├── PlanRequest.md │ ├── PlanResponse.md │ ├── PlanUpdateRequest.md │ ├── Product.md │ ├── ProductDataResponse.md │ ├── ProductOrderResponse.md │ ├── ResendRequest.md │ ├── RiskRulesData.md │ ├── RiskRulesList.md │ ├── ShippingOrderResponse.md │ ├── ShippingRequest.md │ ├── SmsCheckoutRequest.md │ ├── SubscriptionEventsResponse.md │ ├── SubscriptionRequest.md │ ├── SubscriptionResponse.md │ ├── SubscriptionUpdateRequest.md │ ├── Token.md │ ├── TokenCard.md │ ├── TokenCheckout.md │ ├── TokenResponse.md │ ├── TokenResponseCheckout.md │ ├── TransactionResponse.md │ ├── TransferDestinationResponse.md │ ├── TransferMethodResponse.md │ ├── TransferResponse.md │ ├── TransfersResponse.md │ ├── UpdateCustomer.md │ ├── UpdateCustomerAntifraudInfo.md │ ├── UpdateCustomerFiscalEntitiesResponse.md │ ├── UpdateCustomerPaymentMethodsResponse.md │ ├── UpdateOrderDiscountLinesRequest.md │ ├── UpdateOrderTaxRequest.md │ ├── UpdateOrderTaxResponse.md │ ├── UpdatePaymentMethods.md │ ├── UpdateProduct.md │ ├── WebhookKeyCreateResponse.md │ ├── WebhookKeyDeleteResponse.md │ ├── WebhookKeyRequest.md │ ├── WebhookKeyResponse.md │ ├── WebhookKeyUpdateRequest.md │ ├── WebhookLog.md │ ├── WebhookRequest.md │ ├── WebhookResponse.md │ ├── WebhookUpdateRequest.md │ └── WhitelistlistRuleResponse.md ├── examples └── direct_api │ ├── cargo_unico.php │ ├── create_customer.php │ ├── find_an_order_by_id.php │ └── redirect_checkout.php ├── gitleaks.toml ├── lib ├── Api │ ├── AntifraudApi.php │ ├── ApiKeysApi.php │ ├── BalancesApi.php │ ├── ChargesApi.php │ ├── CompaniesApi.php │ ├── CustomersApi.php │ ├── DiscountsApi.php │ ├── EventsApi.php │ ├── LogsApi.php │ ├── OrdersApi.php │ ├── PaymentLinkApi.php │ ├── PaymentMethodsApi.php │ ├── PayoutOrdersApi.php │ ├── PlansApi.php │ ├── ProductsApi.php │ ├── ShippingContactsApi.php │ ├── ShippingsApi.php │ ├── SubscriptionsApi.php │ ├── TaxesApi.php │ ├── TokensApi.php │ ├── TransactionsApi.php │ ├── TransfersApi.php │ ├── WebhookKeysApi.php │ └── WebhooksApi.php ├── ApiException.php ├── Configuration.php ├── HeaderSelector.php ├── Model │ ├── ApiKeyCreateResponse.php │ ├── ApiKeyRequest.php │ ├── ApiKeyResponse.php │ ├── ApiKeyResponseOnDelete.php │ ├── ApiKeyUpdateRequest.php │ ├── BalanceCommonField.php │ ├── BalanceResponse.php │ ├── BlacklistRuleResponse.php │ ├── ChargeOrderResponse.php │ ├── ChargeOrderResponsePaymentMethod.php │ ├── ChargeRequest.php │ ├── ChargeRequestPaymentMethod.php │ ├── ChargeResponse.php │ ├── ChargeResponseChannel.php │ ├── ChargeResponsePaymentMethod.php │ ├── ChargeResponseRefunds.php │ ├── ChargeResponseRefundsData.php │ ├── ChargeUpdateRequest.php │ ├── ChargesDataResponse.php │ ├── ChargesOrderResponse.php │ ├── ChargesOrderResponseAllOfData.php │ ├── Checkout.php │ ├── CheckoutOrderTemplate.php │ ├── CheckoutOrderTemplateCustomerInfo.php │ ├── CheckoutRequest.php │ ├── CheckoutResponse.php │ ├── CheckoutsResponse.php │ ├── CompanyFiscalInfoAddressResponse.php │ ├── CompanyFiscalInfoResponse.php │ ├── CompanyPayoutDestinationResponse.php │ ├── CompanyResponse.php │ ├── CreateCustomerFiscalEntitiesResponse.php │ ├── CreateCustomerPaymentMethodsRequest.php │ ├── CreateCustomerPaymentMethodsResponse.php │ ├── CreateRiskRulesData.php │ ├── Customer.php │ ├── CustomerAddress.php │ ├── CustomerAntifraudInfo.php │ ├── CustomerAntifraudInfoResponse.php │ ├── CustomerFiscalEntitiesDataResponse.php │ ├── CustomerFiscalEntitiesRequest.php │ ├── CustomerFiscalEntitiesResponse.php │ ├── CustomerInfo.php │ ├── CustomerInfoJustCustomerId.php │ ├── CustomerInfoJustCustomerIdResponse.php │ ├── CustomerPaymentMethodRequest.php │ ├── CustomerPaymentMethodsData.php │ ├── CustomerPaymentMethodsRequest.php │ ├── CustomerPaymentMethodsResponse.php │ ├── CustomerResponse.php │ ├── CustomerResponseShippingContacts.php │ ├── CustomerShippingContacts.php │ ├── CustomerShippingContactsAddress.php │ ├── CustomerShippingContactsDataResponse.php │ ├── CustomerShippingContactsResponse.php │ ├── CustomerShippingContactsResponseAddress.php │ ├── CustomerUpdateFiscalEntitiesRequest.php │ ├── CustomerUpdateShippingContacts.php │ ├── CustomersResponse.php │ ├── DeleteApiKeysResponse.php │ ├── DeletedBlacklistRuleResponse.php │ ├── DeletedWhitelistRuleResponse.php │ ├── Details.php │ ├── DetailsError.php │ ├── DiscountLinesDataResponse.php │ ├── DiscountLinesResponse.php │ ├── EmailCheckoutRequest.php │ ├── Error.php │ ├── EventResponse.php │ ├── EventTypes.php │ ├── EventsResendResponse.php │ ├── FiscalEntityAddress.php │ ├── GetApiKeysResponse.php │ ├── GetChargesResponse.php │ ├── GetCompaniesResponse.php │ ├── GetCustomerPaymentMethodDataResponse.php │ ├── GetEventsResponse.php │ ├── GetOrderDiscountLinesResponse.php │ ├── GetOrdersResponse.php │ ├── GetPaymentMethodResponse.php │ ├── GetPlansResponse.php │ ├── GetTransactionsResponse.php │ ├── GetTransfersResponse.php │ ├── GetWebhookKeysResponse.php │ ├── GetWebhooksResponse.php │ ├── LogResponse.php │ ├── LogsResponse.php │ ├── LogsResponseData.php │ ├── ModelInterface.php │ ├── OrderCaptureRequest.php │ ├── OrderChannelResponse.php │ ├── OrderChargesResponse.php │ ├── OrderCustomerInfoResponse.php │ ├── OrderDiscountLinesRequest.php │ ├── OrderDiscountLinesResponse.php │ ├── OrderFiscalEntityAddressResponse.php │ ├── OrderFiscalEntityRequest.php │ ├── OrderFiscalEntityResponse.php │ ├── OrderNextActionResponse.php │ ├── OrderNextActionResponseRedirectToUrl.php │ ├── OrderRefundRequest.php │ ├── OrderRequest.php │ ├── OrderRequestCustomerInfo.php │ ├── OrderResponse.php │ ├── OrderResponseCheckout.php │ ├── OrderResponseCustomerInfo.php │ ├── OrderResponseProducts.php │ ├── OrderResponseShippingContact.php │ ├── OrderTaxRequest.php │ ├── OrderUpdateFiscalEntityRequest.php │ ├── OrderUpdateRequest.php │ ├── OrderUpdateRequestCustomerInfo.php │ ├── OrdersResponse.php │ ├── Page.php │ ├── Pagination.php │ ├── PaymentMethod.php │ ├── PaymentMethodBankTransfer.php │ ├── PaymentMethodBnplPayment.php │ ├── PaymentMethodBnplRequest.php │ ├── PaymentMethodCard.php │ ├── PaymentMethodCardRequest.php │ ├── PaymentMethodCardResponse.php │ ├── PaymentMethodCash.php │ ├── PaymentMethodCashRequest.php │ ├── PaymentMethodCashResponse.php │ ├── PaymentMethodCashResponseAllOfAgreements.php │ ├── PaymentMethodGeneralRequest.php │ ├── PaymentMethodResponse.php │ ├── PaymentMethodSpeiRecurrent.php │ ├── PaymentMethodSpeiRequest.php │ ├── PaymentMethodTokenRequest.php │ ├── Payout.php │ ├── PayoutMethod.php │ ├── PayoutOrder.php │ ├── PayoutOrderPayoutsItem.php │ ├── PayoutOrderResponse.php │ ├── PayoutOrderResponseCustomerInfo.php │ ├── PayoutOrdersResponse.php │ ├── PlanRequest.php │ ├── PlanResponse.php │ ├── PlanUpdateRequest.php │ ├── Product.php │ ├── ProductDataResponse.php │ ├── ProductOrderResponse.php │ ├── ResendRequest.php │ ├── RiskRulesData.php │ ├── RiskRulesList.php │ ├── ShippingOrderResponse.php │ ├── ShippingRequest.php │ ├── SmsCheckoutRequest.php │ ├── SubscriptionEventsResponse.php │ ├── SubscriptionRequest.php │ ├── SubscriptionResponse.php │ ├── SubscriptionUpdateRequest.php │ ├── Token.php │ ├── TokenCard.php │ ├── TokenCheckout.php │ ├── TokenResponse.php │ ├── TokenResponseCheckout.php │ ├── TransactionResponse.php │ ├── TransferDestinationResponse.php │ ├── TransferMethodResponse.php │ ├── TransferResponse.php │ ├── TransfersResponse.php │ ├── UpdateCustomer.php │ ├── UpdateCustomerAntifraudInfo.php │ ├── UpdateCustomerFiscalEntitiesResponse.php │ ├── UpdateCustomerPaymentMethodsResponse.php │ ├── UpdateOrderDiscountLinesRequest.php │ ├── UpdateOrderTaxRequest.php │ ├── UpdateOrderTaxResponse.php │ ├── UpdatePaymentMethods.php │ ├── UpdateProduct.php │ ├── WebhookKeyCreateResponse.php │ ├── WebhookKeyDeleteResponse.php │ ├── WebhookKeyRequest.php │ ├── WebhookKeyResponse.php │ ├── WebhookKeyUpdateRequest.php │ ├── WebhookLog.php │ ├── WebhookRequest.php │ ├── WebhookResponse.php │ ├── WebhookUpdateRequest.php │ └── WhitelistlistRuleResponse.php ├── ObjectSerializer.php └── ssl_data │ └── ca_bundle.crt ├── phpunit.xml.dist ├── ssl_data └── ca_bundle.crt ├── templates └── php │ ├── Configuration.mustache │ ├── HeaderSelector.mustache │ ├── VERSION.mustache │ ├── api.mustache │ ├── composer.mustache │ ├── gitignore │ └── phpunit.xml.mustache └── test └── Api ├── AntifraudApiTest.php ├── ApiKeysApiTest.php ├── BalancesApiTest.php ├── ChargesApiTest.php ├── CompaniesApiTest.php ├── CustomersApiTest.php ├── DiscountsApiTest.php ├── EventsApiTest.php ├── LogsApiTest.php ├── OrdersApiTest.php ├── PaymentLinkApiTest.php ├── PaymentMethodsApiTest.php ├── PayoutOrdersApiTest.php ├── PlansApiTest.php ├── ProductsApiTest.php ├── ShippingContactsApiTest.php ├── ShippingsApiTest.php ├── SubscriptionsApiTest.php ├── TaxesApiTest.php ├── TokensApiTest.php ├── TransactionsApiTest.php ├── TransfersApiTest.php ├── WebhookKeysApiTest.php └── WebhooksApiTest.php /.devcontainer/devcontainer.json: -------------------------------------------------------------------------------- 1 | // For format details, see https://aka.ms/devcontainer.json. For config options, see the 2 | // README at: https://github.com/devcontainers/templates/tree/main/src/docker-existing-dockerfile 3 | { 4 | "name": "Existing Dockerfile", 5 | "build": { 6 | // Sets the run context to one level up instead of the .devcontainer folder. 7 | "context": "..", 8 | // Update the 'dockerFile' property if you aren't using the standard 'Dockerfile' filename. 9 | "dockerfile": "../Dockerfile" 10 | }, 11 | "containerEnv": { 12 | "BASE_PATH" : "http://host.docker.internal:3000" 13 | }, 14 | "customizations": { 15 | "vscode": { 16 | "extensions": [ 17 | "DEVSENSE.phptools-vscode", 18 | "github.vscode-github-actions", 19 | "bmewburn.vscode-intelephense-client", 20 | "GitHub.copilot", 21 | "ms-azuretools.vscode-docker", 22 | "ms-vscode.makefile-tools" 23 | ] 24 | } 25 | } 26 | 27 | // Features to add to the dev container. More info: https://containers.dev/features. 28 | // "features": {}, 29 | 30 | // Use 'forwardPorts' to make a list of ports inside the container available locally. 31 | // "forwardPorts": [], 32 | 33 | // Uncomment the next line to run commands after the container is created. 34 | // "postCreateCommand": "cat /etc/os-release", 35 | 36 | // Configure tool-specific properties. 37 | // "customizations": {}, 38 | 39 | // Uncomment to connect as an existing user other than the container default. More info: https://aka.ms/dev-containers-non-root. 40 | // "remoteUser": "devcontainer" 41 | } 42 | -------------------------------------------------------------------------------- /.devcontainer/docker-compose.yml: -------------------------------------------------------------------------------- 1 | version: '3.7' 2 | services: 3 | # Update this to the name of the service you want to work with in your docker-compose.yml file 4 | php: 5 | # Uncomment if you want to override the service's Dockerfile to one in the .devcontainer 6 | # folder. Note that the path of the Dockerfile and context is relative to the *primary* 7 | # docker-compose.yml file (the first in the devcontainer.json "dockerComposeFile" 8 | # array). The sample below assumes your primary file is in the root of your project. 9 | # 10 | # build: 11 | # context: . 12 | # dockerfile: .devcontainer/Dockerfile 13 | 14 | volumes: 15 | # Update this to wherever you want VS Code to mount the folder of your project 16 | - ../..:/workspaces:cached 17 | 18 | # Uncomment the next four lines if you will use a ptrace-based debugger like C++, Go, and Rust. 19 | # cap_add: 20 | # - SYS_PTRACE 21 | # security_opt: 22 | # - seccomp:unconfined 23 | 24 | # Overrides default command so things don't shut down after the process ends. 25 | command: /bin/sh -c "while sleep 1000; do :; done" 26 | 27 | -------------------------------------------------------------------------------- /.docker/php/Dockerfile: -------------------------------------------------------------------------------- 1 | FROM php:8.0-cli-alpine 2 | 3 | RUN apk add --no-cache $PHPIZE_DEPS \ 4 | libxml2-dev \ 5 | php-soap linux-headers bash \ 6 | git \ 7 | && docker-php-ext-install soap \ 8 | && pecl install xdebug \ 9 | && docker-php-ext-enable xdebug 10 | 11 | COPY --from=composer:2.5.1 /usr/bin/composer /usr/bin/composer 12 | 13 | RUN composer global require phpunit/phpunit ~9 14 | 15 | RUN echo 'alias phpunit="./vendor/bin/phpunit"' >> ~/.bashrc 16 | -------------------------------------------------------------------------------- /.editorconfig: -------------------------------------------------------------------------------- 1 | ; https://editorconfig.org/ 2 | 3 | root = true 4 | 5 | [*] 6 | indent_style = space 7 | indent_size = 4 8 | insert_final_newline = true 9 | trim_trailing_whitespace = true 10 | end_of_line = lf 11 | charset = utf-8 12 | 13 | [*.{json,yml}] 14 | indent_size = 2 15 | 16 | [*.neon] 17 | indent_style = tab 18 | 19 | [Makefile] 20 | indent_style = tab 21 | -------------------------------------------------------------------------------- /.github/dependabot.yml: -------------------------------------------------------------------------------- 1 | # To get started with Dependabot version updates, you'll need to specify which 2 | # package ecosystems to update and where the package manifests are located. 3 | # Please see the documentation for all configuration options: 4 | # https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates 5 | 6 | version: 2 7 | updates: 8 | - package-ecosystem: "composer" # See documentation for possible values 9 | directory: "/" # Location of package manifests 10 | schedule: 11 | interval: "daily" 12 | -------------------------------------------------------------------------------- /.github/workflows/build_test.yml: -------------------------------------------------------------------------------- 1 | name: CI 2 | on: 3 | push: 4 | branches: [master] 5 | pull_request: 6 | branches: [master] 7 | jobs: 8 | phpunit: 9 | name: PHPUnit 10 | runs-on: ubuntu-latest 11 | strategy: 12 | fail-fast: false 13 | matrix: 14 | php-version: 15 | - "7.4" 16 | - "8.0" 17 | - "8.1" 18 | - "8.2" 19 | - "8.3" 20 | dependency-versions: 21 | - "lowest" 22 | steps: 23 | - name: Checkout 24 | uses: actions/checkout@v3 25 | 26 | - name: Setup PHP 27 | uses: shivammathur/setup-php@v2 28 | with: 29 | php-version: ${{ matrix.php-version }} 30 | coverage: none 31 | 32 | - name: Install composer dependencies 33 | uses: ramsey/composer-install@v2 34 | with: 35 | dependency-versions: ${{ matrix.dependency-versions }} 36 | - name: phpstan 37 | uses: php-actions/phpstan@v3 38 | with: 39 | path: lib/ 40 | php_version: ${{ matrix.php-version }} 41 | command: --version 42 | level: 2 43 | php_extensions: xdebug 44 | - name: Run Mockoon CLI 45 | uses: mockoon/cli-action@v1 46 | with: 47 | version: '6.0.1' 48 | data-file: 'https://raw.githubusercontent.com/conekta/openapi/main/mocks/conekta_api.json' 49 | port: 3000 50 | - name: Run PHPUnit 51 | run: vendor/bin/phpunit 52 | env: 53 | BASE_PATH: localhost:3000 54 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Ignore build files 2 | build/* 3 | 4 | # Mac OS X dumps these all over the place. 5 | .DS_Store 6 | 7 | # Ignore the SimpleTest library if it is installed to /test/. 8 | /test/simpletest/ 9 | 10 | # Ignore the /vendor/ directory for people using composer 11 | /vendor/ 12 | 13 | # If the vendor directory isn't being commited the composer.lock file should also be ignored 14 | composer.lock 15 | 16 | # Ignore PHPUnit coverage file 17 | clover.xml 18 | 19 | # Ignore IDE's configuration files 20 | .idea 21 | 22 | # Ignore PHP CS Fixer local config and cache 23 | .php_cs 24 | .php_cs.cache 25 | .php-cs-fixer.cache 26 | 27 | # Ignore PHPStan local config 28 | .phpstan.neon 29 | 30 | # Ignore phpDocumentor's local config and artifacts 31 | .phpdoc/* 32 | phpdoc.xml 33 | 34 | # Ignore cached PHPUnit results. 35 | .phpunit.result.cache 36 | -------------------------------------------------------------------------------- /.openapi-generator-ignore: -------------------------------------------------------------------------------- 1 | # OpenAPI Generator Ignore 2 | # Generated by openapi-generator https://github.com/openapitools/openapi-generator 3 | 4 | # Use this file to prevent files from being overwritten by the generator. 5 | # The patterns follow closely to .gitignore or .dockerignore. 6 | 7 | # As an example, the C# client generator defines ApiClient.cs. 8 | # You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line: 9 | #ApiClient.cs 10 | 11 | # You can match any string of characters against a directory, file or extension with a single asterisk (*): 12 | #foo/*/qux 13 | # The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux 14 | 15 | # You can recursively match patterns against a directory, file or extension with a double asterisk (**): 16 | #foo/**/qux 17 | # This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux 18 | 19 | # You can also negate patterns with an exclamation (!). 20 | # For example, you can ignore all files in a docs folder with the file extension .md: 21 | #docs/*.md 22 | # Then explicitly reverse the ignore rule for a single file: 23 | #!docs/README.md 24 | .travis.yml 25 | git_push.sh 26 | 27 | -------------------------------------------------------------------------------- /.openapi-generator/VERSION: -------------------------------------------------------------------------------- 1 | 7.9.0 2 | -------------------------------------------------------------------------------- /.php-cs-fixer.dist.php: -------------------------------------------------------------------------------- 1 | in(__DIR__) 9 | ->exclude('vendor') 10 | ->exclude('test') 11 | ->exclude('tests') 12 | ; 13 | 14 | $config = new PhpCsFixer\Config(); 15 | return $config->setRules([ 16 | '@PSR12' => true, 17 | 'phpdoc_order' => true, 18 | 'array_syntax' => [ 'syntax' => 'short' ], 19 | 'strict_comparison' => true, 20 | 'strict_param' => true, 21 | 'no_trailing_whitespace' => false, 22 | 'no_trailing_whitespace_in_comment' => false, 23 | 'braces' => false, 24 | 'single_blank_line_at_eof' => false, 25 | 'blank_line_after_namespace' => false, 26 | 'no_leading_import_slash' => false, 27 | ]) 28 | ->setFinder($finder) 29 | ; 30 | -------------------------------------------------------------------------------- /AUTHORS.md: -------------------------------------------------------------------------------- 1 | title: Authors 2 | 3 | Primary Authors 4 | =============== 5 | 6 | * __[Franklin Carrero](https://github.com/fcarrero)__ 7 | 8 | @fcarrero is the current maintainer of the code and has written much of the 9 | current code base, including a complete refactor of the core for version 2.0. 10 | He started out by authoring many of the available extensions and later was 11 | asked to join Yuri, where he began fixing numerous bugs, adding 12 | documentation and making general improvements to the existing code base. 13 | 14 | * __[Jorge Alberto Alonso](https://github.com/jalonsoDevConekta)__ 15 | 16 | @jalonsoDevConekta is the current maintainer of the code and has written much of the 17 | current code base, including a complete refactor of the core for version 2.0. 18 | He started out by authoring many of the available extensions and later was 19 | asked to join Yuri, where he began fixing numerous bugs, adding 20 | documentation and making general improvements to the existing code base. 21 | 22 | * __[Ezequiel Rozen](https://github.com/ezerozen)__ 23 | 24 | @ezerozen is the current maintainer of the code and has written much of the 25 | current code base, including a complete refactor of the core for version 2.0. 26 | He started out by authoring many of the available extensions and later was 27 | asked to join Yuri, where he began fixing numerous bugs, adding 28 | documentation and making general improvements to the existing code base. 29 | -------------------------------------------------------------------------------- /CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | # Contribution guidelines 2 | 3 | ## How to contribute step-by-step 4 | 5 | 1. Fork the `conekta/#$repo repository. 6 | 2. Create a new branch from `main` in your fork. This makes it easier for you to keep track of your changes. 7 | 3. Make the desired changes to the code. 8 | * If you are adding new functionality or fixing a bug, we recommend you add unit tests that cover it. 9 | 4. Push the changes to your fork. 10 | 5. Create a pull request to the `conekta/#$repo` repository. 11 | 6. In your pull request, please describe in detail: 12 | * What problem you’re solving 13 | * Your approach to fixing the problem 14 | * Any tests you wrote 15 | 7. Check Allow edits from maintainers. 16 | 8. Create the pull request. 17 | 9. Ensure that all checks have passed. 18 | 19 | After you create your pull request, one of the code owners will review your code. We aim to review your request within 2-3 business days. 20 | -------------------------------------------------------------------------------- /Dockerfile: -------------------------------------------------------------------------------- 1 | FROM php:8.2.1-cli-alpine 2 | 3 | RUN apk add --no-cache $PHPIZE_DEPS \ 4 | libxml2-dev \ 5 | php-soap linux-headers bash \ 6 | git \ 7 | && docker-php-ext-install soap \ 8 | && pecl install xdebug \ 9 | && docker-php-ext-enable xdebug 10 | 11 | COPY --from=composer:2.5.1 /usr/bin/composer /usr/bin/composer 12 | 13 | RUN composer global require phpunit/phpunit ~9 14 | 15 | RUN echo 'alias phpunit="./vendor/bin/phpunit"' >> ~/.bashrc 16 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | MIT License 2 | 3 | Copyright (c) 2014 - Conekta, Inc. (https://www.conekta.io) 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining 6 | a copy of this software and associated documentation files (the 7 | "Software"), to deal in the Software without restriction, including 8 | without limitation the rights to use, copy, modify, merge, publish, 9 | distribute, sublicense, and/or sell copies of the Software, and to 10 | permit persons to whom the Software is furnished to do so, subject to 11 | the following conditions: 12 | 13 | The above copyright notice and this permission notice shall be 14 | included in all copies or substantial portions of the Software. 15 | 16 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, 17 | EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF 18 | MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND 19 | NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE 20 | LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION 21 | OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION 22 | WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. -------------------------------------------------------------------------------- /Makefile: -------------------------------------------------------------------------------- 1 | php-test: 2 | vendor/bin/phpunit test/Api 3 | phpstan: 4 | vendor/bin/phpstan analyse lib --level 7 5 | php: 6 | rm -rf docs && rm -rf test && \ 7 | rm -rf lib/Model && \ 8 | docker run --rm \ 9 | -v ${PWD}:/local openapitools/openapi-generator-cli:v7.9.0 generate \ 10 | -i https://raw.githubusercontent.com/conekta/openapi/main/_build/api.yaml \ 11 | -g php \ 12 | -o /local \ 13 | -c /local/config-php.json \ 14 | --global-property modelTests=false 15 | -------------------------------------------------------------------------------- /VERSION: -------------------------------------------------------------------------------- 1 | 7.0.1 2 | -------------------------------------------------------------------------------- /composer.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "conekta/conekta-php", 3 | "version": "7.0.1", 4 | "description": "Conekta PHP Library", 5 | "type": "library", 6 | "keywords": [ 7 | "php", 8 | "sdk", 9 | "rest", 10 | "api", 11 | "conekta" 12 | ], 13 | "homepage": "https://www.conekta.com/", 14 | "license": "MIT", 15 | "authors": [ 16 | { 17 | "name": "engineering@conekta.com", 18 | "homepage": "https://github.com/conekta/conekta-php/contributors" 19 | } 20 | ], 21 | "require": { 22 | "php": "^7.4 || ^8.0", 23 | "ext-curl": "*", 24 | "ext-json": "*", 25 | "ext-mbstring": "*", 26 | "guzzlehttp/guzzle": "^7.3", 27 | "guzzlehttp/psr7": "^1.7 || ^2.0" 28 | }, 29 | "require-dev": { 30 | "phpunit/phpunit": "^9.0 || ^10.0", 31 | "friendsofphp/php-cs-fixer": "^3.5", 32 | "phpstan/phpstan": "2.0.1" 33 | }, 34 | "autoload": { 35 | "psr-4": { "Conekta\\" : "lib/" } 36 | }, 37 | "autoload-dev": { 38 | "psr-4": { "Conekta\\Test\\" : "test/" } 39 | } 40 | } 41 | -------------------------------------------------------------------------------- /conekta.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/conekta/conekta-php/852b14307e97f97d56030daf83efbcc80bb9ec30/conekta.png -------------------------------------------------------------------------------- /config-php.json: -------------------------------------------------------------------------------- 1 | { 2 | "packageName": "conekta", 3 | "generateSourceCodeOnly": "false", 4 | "artifactVersion": "7.0.1", 5 | "packageUrl": "https://developers.conekta.com/", 6 | "projectName": "conekta-php", 7 | "appDescriptionV2" : "Conekta PHP Library", 8 | "useOneOfDiscriminatorLookup" : true, 9 | "nonCompliantUseDiscriminatorIfCompositionFails" : false, 10 | "httpUserAgent": "Conekta/v2 PhpBindings/7.0.1", 11 | "packageAuthors" : "engineering@conekta.com", 12 | "files": { 13 | "/local/CODE_OF_CONDUCT.md" : {}, 14 | "/local/AUTHORS.md" : {}, 15 | "/local/CONTRIBUTING.md" : {}, 16 | "/local/LICENSE" : {}, 17 | "/local/conekta.png" : {}, 18 | "VERSION.mustache" : { 19 | "templateType": "SupportingFiles", 20 | "destinationFilename": "VERSION" 21 | }, 22 | "/local/ssl_data/ca_bundle.crt": { 23 | "destinationFilename": "lib/ssl_data/ca_bundle.crt" 24 | } 25 | }, 26 | "gitUserId": "conekta", 27 | "gitRepoId": "conekta-php", 28 | "modern" : true, 29 | "disallowAdditionalPropertiesIfNotPresent" : true, 30 | "invokerPackage" : "Conekta", 31 | "templateDir": "/local/templates/php", 32 | "legacyDiscriminatorBehavior" : false 33 | } 34 | -------------------------------------------------------------------------------- /docs/Api/BalancesApi.md: -------------------------------------------------------------------------------- 1 | # Conekta\BalancesApi 2 | 3 | All URIs are relative to https://api.conekta.io, except if the operation defines another base path. 4 | 5 | | Method | HTTP request | Description | 6 | | ------------- | ------------- | ------------- | 7 | | [**getBalance()**](BalancesApi.md#getBalance) | **GET** /balance | Get a company's balance | 8 | 9 | 10 | ## `getBalance()` 11 | 12 | ```php 13 | getBalance($accept_language): \Conekta\Model\BalanceResponse 14 | ``` 15 | 16 | Get a company's balance 17 | 18 | Get a company's balance 19 | 20 | ### Example 21 | 22 | ```php 23 | setAccessToken('YOUR_ACCESS_TOKEN'); 29 | 30 | 31 | $apiInstance = new Conekta\Api\BalancesApi( 32 | // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. 33 | // This is optional, `GuzzleHttp\Client` will be used as default. 34 | new GuzzleHttp\Client(), 35 | $config 36 | ); 37 | $accept_language = es; // string | Use for knowing which language to use 38 | 39 | try { 40 | $result = $apiInstance->getBalance($accept_language); 41 | print_r($result); 42 | } catch (Exception $e) { 43 | echo 'Exception when calling BalancesApi->getBalance: ', $e->getMessage(), PHP_EOL; 44 | } 45 | ``` 46 | 47 | ### Parameters 48 | 49 | | Name | Type | Description | Notes | 50 | | ------------- | ------------- | ------------- | ------------- | 51 | | **accept_language** | **string**| Use for knowing which language to use | [optional] [default to 'es'] | 52 | 53 | ### Return type 54 | 55 | [**\Conekta\Model\BalanceResponse**](../Model/BalanceResponse.md) 56 | 57 | ### Authorization 58 | 59 | [bearerAuth](../../README.md#bearerAuth) 60 | 61 | ### HTTP request headers 62 | 63 | - **Content-Type**: Not defined 64 | - **Accept**: `application/vnd.conekta-v2.2.0+json` 65 | 66 | [[Back to top]](#) [[Back to API list]](../../README.md#endpoints) 67 | [[Back to Model list]](../../README.md#models) 68 | [[Back to README]](../../README.md) 69 | -------------------------------------------------------------------------------- /docs/Api/TokensApi.md: -------------------------------------------------------------------------------- 1 | # Conekta\TokensApi 2 | 3 | All URIs are relative to https://api.conekta.io, except if the operation defines another base path. 4 | 5 | | Method | HTTP request | Description | 6 | | ------------- | ------------- | ------------- | 7 | | [**createToken()**](TokensApi.md#createToken) | **POST** /tokens | Create Token | 8 | 9 | 10 | ## `createToken()` 11 | 12 | ```php 13 | createToken($token, $accept_language): \Conekta\Model\TokenResponse 14 | ``` 15 | 16 | Create Token 17 | 18 | Generate a payment token, to associate it with a card 19 | 20 | ### Example 21 | 22 | ```php 23 | setAccessToken('YOUR_ACCESS_TOKEN'); 29 | 30 | 31 | $apiInstance = new Conekta\Api\TokensApi( 32 | // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. 33 | // This is optional, `GuzzleHttp\Client` will be used as default. 34 | new GuzzleHttp\Client(), 35 | $config 36 | ); 37 | $token = new \Conekta\Model\Token(); // \Conekta\Model\Token | requested field for token 38 | $accept_language = es; // string | Use for knowing which language to use 39 | 40 | try { 41 | $result = $apiInstance->createToken($token, $accept_language); 42 | print_r($result); 43 | } catch (Exception $e) { 44 | echo 'Exception when calling TokensApi->createToken: ', $e->getMessage(), PHP_EOL; 45 | } 46 | ``` 47 | 48 | ### Parameters 49 | 50 | | Name | Type | Description | Notes | 51 | | ------------- | ------------- | ------------- | ------------- | 52 | | **token** | [**\Conekta\Model\Token**](../Model/Token.md)| requested field for token | | 53 | | **accept_language** | **string**| Use for knowing which language to use | [optional] [default to 'es'] | 54 | 55 | ### Return type 56 | 57 | [**\Conekta\Model\TokenResponse**](../Model/TokenResponse.md) 58 | 59 | ### Authorization 60 | 61 | [bearerAuth](../../README.md#bearerAuth) 62 | 63 | ### HTTP request headers 64 | 65 | - **Content-Type**: `application/json` 66 | - **Accept**: `application/vnd.conekta-v2.2.0+json` 67 | 68 | [[Back to top]](#) [[Back to API list]](../../README.md#endpoints) 69 | [[Back to Model list]](../../README.md#models) 70 | [[Back to README]](../../README.md) 71 | -------------------------------------------------------------------------------- /docs/Model/ApiKeyCreateResponse.md: -------------------------------------------------------------------------------- 1 | # # ApiKeyCreateResponse 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **active** | **bool** | Indicates if the api key is active | [optional] 8 | **created_at** | **int** | Unix timestamp in seconds of when the api key was created | [optional] 9 | **updated_at** | **int** | Unix timestamp in seconds of when the api key was last updated | [optional] 10 | **deactivated_at** | **int** | Unix timestamp in seconds of when the api key was deleted | [optional] 11 | **last_used_at** | **int** | Unix timestamp in seconds with the api key was used | [optional] 12 | **description** | **string** | A name or brief explanation of what this api key is used for | [optional] 13 | **id** | **string** | Unique identifier of the api key | [optional] 14 | **livemode** | **bool** | Indicates if the api key is in production | [optional] 15 | **object** | **string** | Object name, value is 'api_key' | [optional] 16 | **prefix** | **string** | The first few characters of the authentication_token | [optional] 17 | **role** | **string** | Indicates if the api key is private or public | [optional] 18 | **authentication_token** | **string** | It is occupied as a user when authenticated with basic authentication, with a blank password. This value will only appear once, in the request to create a new key. Copy and save it in a safe place. | [optional] 19 | 20 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 21 | -------------------------------------------------------------------------------- /docs/Model/ApiKeyRequest.md: -------------------------------------------------------------------------------- 1 | # # ApiKeyRequest 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **description** | **string** | A name or brief explanation of what this api key is used for | [optional] 8 | **role** | **string** | | 9 | 10 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 11 | -------------------------------------------------------------------------------- /docs/Model/ApiKeyResponse.md: -------------------------------------------------------------------------------- 1 | # # ApiKeyResponse 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **active** | **bool** | Indicates if the api key is active | [optional] 8 | **created_at** | **int** | Unix timestamp in seconds of when the api key was created | [optional] 9 | **updated_at** | **int** | Unix timestamp in seconds of when the api key was last updated | [optional] 10 | **deactivated_at** | **int** | Unix timestamp in seconds of when the api key was deleted | [optional] 11 | **last_used_at** | **int** | Unix timestamp in seconds with the api key was used | [optional] 12 | **description** | **string** | A name or brief explanation of what this api key is used for | [optional] 13 | **id** | **string** | Unique identifier of the api key | [optional] 14 | **livemode** | **bool** | Indicates if the api key is in production | [optional] 15 | **object** | **string** | Object name, value is 'api_key' | [optional] 16 | **prefix** | **string** | The first few characters of the authentication_token | [optional] 17 | **role** | **string** | Indicates if the api key is private or public | [optional] 18 | 19 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 20 | -------------------------------------------------------------------------------- /docs/Model/ApiKeyResponseOnDelete.md: -------------------------------------------------------------------------------- 1 | # # ApiKeyResponseOnDelete 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **active** | **bool** | Indicates if the api key is active | [optional] 8 | **created_at** | **int** | Unix timestamp in seconds of when the api key was created | [optional] 9 | **description** | **string** | A name or brief explanation of what this api key is used for | [optional] 10 | **livemode** | **bool** | Indicates if the api key is in production | [optional] 11 | **prefix** | **string** | The first few characters of the authentication_token | [optional] 12 | **id** | **string** | Unique identifier of the api key | [optional] 13 | **object** | **string** | Object name, value is 'api_key' | [optional] 14 | **last_used_at** | **int** | Unix timestamp in seconds with the api key was used | [optional] 15 | **role** | **string** | Indicates if the api key is private or public | [optional] 16 | 17 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 18 | -------------------------------------------------------------------------------- /docs/Model/ApiKeyUpdateRequest.md: -------------------------------------------------------------------------------- 1 | # # ApiKeyUpdateRequest 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **active** | **bool** | Indicates if the webhook key is active | [optional] 8 | **description** | **string** | A name or brief explanation of what this api key is used for | [optional] 9 | 10 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 11 | -------------------------------------------------------------------------------- /docs/Model/BalanceCommonField.md: -------------------------------------------------------------------------------- 1 | # # BalanceCommonField 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **amount** | **int** | The balance's amount | [optional] 8 | **currency** | **string** | The balance's currency | [optional] 9 | 10 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 11 | -------------------------------------------------------------------------------- /docs/Model/BalanceResponse.md: -------------------------------------------------------------------------------- 1 | # # BalanceResponse 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **available** | [**\Conekta\Model\BalanceCommonField[]**](BalanceCommonField.md) | The balance's available | [optional] 8 | **cashout_retention_amount** | [**\Conekta\Model\BalanceCommonField[]**](BalanceCommonField.md) | The balance's cashout retention amount | [optional] 9 | **conekta_retention** | [**\Conekta\Model\BalanceCommonField[]**](BalanceCommonField.md) | The balance's conekta retention | [optional] 10 | **gateway** | [**\Conekta\Model\BalanceCommonField[]**](BalanceCommonField.md) | The balance's gateway | [optional] 11 | **pending** | [**\Conekta\Model\BalanceCommonField[]**](BalanceCommonField.md) | The balance's pending | [optional] 12 | **retained** | [**\Conekta\Model\BalanceCommonField[]**](BalanceCommonField.md) | The balance's retained | [optional] 13 | **retention_amount** | [**\Conekta\Model\BalanceCommonField[]**](BalanceCommonField.md) | The balance's retention amount | [optional] 14 | **target_collateral_amount** | **object** | The balance's target collateral amount | [optional] 15 | **target_retention_amount** | [**\Conekta\Model\BalanceCommonField[]**](BalanceCommonField.md) | The balance's target retention amount | [optional] 16 | **temporarily_retained** | [**\Conekta\Model\BalanceCommonField[]**](BalanceCommonField.md) | The balance's temporarily retained | [optional] 17 | 18 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 19 | -------------------------------------------------------------------------------- /docs/Model/BlacklistRuleResponse.md: -------------------------------------------------------------------------------- 1 | # # BlacklistRuleResponse 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **id** | **string** | Blacklist rule id | [optional] 8 | **field** | **string** | field used for blacklists rule | [optional] 9 | **value** | **string** | value used for blacklists rule | [optional] 10 | **description** | **string** | use an description for blacklisted rule | [optional] 11 | 12 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 13 | -------------------------------------------------------------------------------- /docs/Model/ChargeOrderResponse.md: -------------------------------------------------------------------------------- 1 | # # ChargeOrderResponse 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **amount** | **int** | | [optional] 8 | **channel** | [**\Conekta\Model\ChargeResponseChannel**](ChargeResponseChannel.md) | | [optional] 9 | **created_at** | **int** | | [optional] 10 | **currency** | **string** | | [optional] 11 | **customer_id** | **string** | | [optional] 12 | **description** | **string** | | [optional] 13 | **device_fingerprint** | **string** | | [optional] 14 | **failure_code** | **string** | | [optional] 15 | **failure_message** | **string** | | [optional] 16 | **id** | **string** | | [optional] 17 | **livemode** | **bool** | | [optional] 18 | **monthly_installments** | **int** | | [optional] 19 | **object** | **string** | | [optional] 20 | **order_id** | **string** | | [optional] 21 | **paid_at** | **int** | | [optional] 22 | **payment_method** | [**\Conekta\Model\ChargeOrderResponsePaymentMethod**](ChargeOrderResponsePaymentMethod.md) | | [optional] 23 | **reference_id** | **string** | Reference ID of the charge | [optional] 24 | **refunds** | **object[]** | | [optional] 25 | **status** | **string** | | [optional] 26 | 27 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 28 | -------------------------------------------------------------------------------- /docs/Model/ChargeRequest.md: -------------------------------------------------------------------------------- 1 | # # ChargeRequest 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **amount** | **int** | Amount to be charged in cents | [optional] 8 | **payment_method** | [**\Conekta\Model\ChargeRequestPaymentMethod**](ChargeRequestPaymentMethod.md) | | 9 | **reference_id** | **string** | Custom reference to add to the charge | [optional] 10 | 11 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 12 | -------------------------------------------------------------------------------- /docs/Model/ChargeRequestPaymentMethod.md: -------------------------------------------------------------------------------- 1 | # # ChargeRequestPaymentMethod 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **type** | **string** | Type of payment method | 8 | **cancel_url** | **string** | URL to redirect the customer after a canceled payment | 9 | **can_not_expire** | **bool** | Indicates if the payment method can not expire | 10 | **failure_url** | **string** | URL to redirect the customer after a failed payment | 11 | **product_type** | **string** | Product type of the payment method, use for the payment method to know the product type | 12 | **success_url** | **string** | URL to redirect the customer after a successful payment | 13 | **cvc** | **string** | Optional, It is a value that allows identifying the security code of the card. Only for PCI merchants | 14 | **exp_month** | **string** | Card expiration month | 15 | **exp_year** | **string** | Card expiration year | 16 | **name** | **string** | Cardholder name | 17 | **number** | **string** | Card number | 18 | **customer_ip_address** | **string** | Optional field used to capture the customer's IP address for fraud prevention and security monitoring purposes | [optional] 19 | **expires_at** | **int** | Method expiration date as unix timestamp | [optional] 20 | **monthly_installments** | **int** | How many months without interest to apply, it can be 3, 6, 9, 12 or 18 | [optional] 21 | **token_id** | **string** | | [optional] 22 | **payment_source_id** | **string** | | [optional] 23 | **contract_id** | **string** | Optional id sent to indicate the bank contract for recurrent card charges. | [optional] 24 | 25 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 26 | -------------------------------------------------------------------------------- /docs/Model/ChargeResponse.md: -------------------------------------------------------------------------------- 1 | # # ChargeResponse 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **amount** | **int** | | 8 | **channel** | [**\Conekta\Model\ChargeResponseChannel**](ChargeResponseChannel.md) | | [optional] 9 | **created_at** | **int** | | 10 | **currency** | **string** | | 11 | **customer_id** | **string** | | [optional] 12 | **description** | **string** | | [optional] 13 | **device_fingerprint** | **string** | | [optional] 14 | **failure_code** | **string** | | [optional] 15 | **failure_message** | **string** | | [optional] 16 | **id** | **string** | Charge ID | 17 | **livemode** | **bool** | Whether the charge was made in live mode or not | 18 | **object** | **string** | | 19 | **order_id** | **string** | Order ID | 20 | **paid_at** | **int** | Payment date | [optional] 21 | **payment_method** | [**\Conekta\Model\ChargeResponsePaymentMethod**](ChargeResponsePaymentMethod.md) | | [optional] 22 | **reference_id** | **string** | Reference ID of the charge | [optional] 23 | **refunds** | [**\Conekta\Model\ChargeResponseRefunds**](ChargeResponseRefunds.md) | | [optional] 24 | **status** | **string** | Charge status | 25 | 26 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 27 | -------------------------------------------------------------------------------- /docs/Model/ChargeResponseChannel.md: -------------------------------------------------------------------------------- 1 | # # ChargeResponseChannel 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **segment** | **string** | | [optional] 8 | **checkout_request_id** | **string** | | [optional] 9 | **checkout_request_type** | **string** | | [optional] 10 | **id** | **string** | | [optional] 11 | 12 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 13 | -------------------------------------------------------------------------------- /docs/Model/ChargeResponseRefunds.md: -------------------------------------------------------------------------------- 1 | # # ChargeResponseRefunds 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **has_more** | **bool** | Indicates if there are more pages to be requested | 8 | **object** | **string** | Object type, in this case is list | 9 | **next_page_url** | **string** | URL of the next page. | [optional] 10 | **previous_page_url** | **string** | Url of the previous page. | [optional] 11 | **data** | [**\Conekta\Model\ChargeResponseRefundsData[]**](ChargeResponseRefundsData.md) | refunds | [optional] 12 | 13 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 14 | -------------------------------------------------------------------------------- /docs/Model/ChargeResponseRefundsData.md: -------------------------------------------------------------------------------- 1 | # # ChargeResponseRefundsData 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **amount** | **int** | | 8 | **auth_code** | **string** | | [optional] 9 | **created_at** | **int** | | 10 | **expires_at** | **int** | refund expiration date | [optional] 11 | **id** | **string** | | 12 | **object** | **string** | | 13 | **status** | **string** | refund status | [optional] 14 | 15 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 16 | -------------------------------------------------------------------------------- /docs/Model/ChargeUpdateRequest.md: -------------------------------------------------------------------------------- 1 | # # ChargeUpdateRequest 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **reference_id** | **string** | custom reference id | [optional] 8 | 9 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 10 | -------------------------------------------------------------------------------- /docs/Model/ChargesDataResponse.md: -------------------------------------------------------------------------------- 1 | # # ChargesDataResponse 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **amount** | **int** | | 8 | **channel** | [**\Conekta\Model\ChargeResponseChannel**](ChargeResponseChannel.md) | | [optional] 9 | **created_at** | **int** | | 10 | **currency** | **string** | | 11 | **customer_id** | **string** | | [optional] 12 | **description** | **string** | | [optional] 13 | **device_fingerprint** | **string** | | [optional] 14 | **failure_code** | **string** | | [optional] 15 | **failure_message** | **string** | | [optional] 16 | **id** | **string** | Charge ID | 17 | **livemode** | **bool** | Whether the charge was made in live mode or not | 18 | **object** | **string** | | 19 | **order_id** | **string** | Order ID | 20 | **paid_at** | **int** | Payment date | [optional] 21 | **payment_method** | [**\Conekta\Model\ChargeResponsePaymentMethod**](ChargeResponsePaymentMethod.md) | | [optional] 22 | **reference_id** | **string** | Reference ID of the charge | [optional] 23 | **refunds** | [**\Conekta\Model\ChargeResponseRefunds**](ChargeResponseRefunds.md) | | [optional] 24 | **status** | **string** | Charge status | 25 | 26 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 27 | -------------------------------------------------------------------------------- /docs/Model/ChargesOrderResponse.md: -------------------------------------------------------------------------------- 1 | # # ChargesOrderResponse 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **has_more** | **bool** | Indicates if there are more pages to be requested | 8 | **object** | **string** | Object type, in this case is list | 9 | **data** | [**\Conekta\Model\ChargesOrderResponseAllOfData[]**](ChargesOrderResponseAllOfData.md) | | [optional] 10 | 11 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 12 | -------------------------------------------------------------------------------- /docs/Model/ChargesOrderResponseAllOfData.md: -------------------------------------------------------------------------------- 1 | # # ChargesOrderResponseAllOfData 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **amount** | **int** | | 8 | **channel** | [**\Conekta\Model\ChargeResponseChannel**](ChargeResponseChannel.md) | | [optional] 9 | **created_at** | **int** | | 10 | **currency** | **string** | | 11 | **customer_id** | **string** | | [optional] 12 | **description** | **string** | | [optional] 13 | **device_fingerprint** | **string** | | [optional] 14 | **failure_code** | **string** | | [optional] 15 | **failure_message** | **string** | | [optional] 16 | **id** | **string** | Charge ID | 17 | **livemode** | **bool** | Whether the charge was made in live mode or not | 18 | **object** | **string** | | 19 | **order_id** | **string** | Order ID | 20 | **paid_at** | **int** | Payment date | [optional] 21 | **payment_method** | [**\Conekta\Model\ChargeResponsePaymentMethod**](ChargeResponsePaymentMethod.md) | | [optional] 22 | **reference_id** | **string** | Reference ID of the charge | [optional] 23 | **refunds** | [**\Conekta\Model\ChargeResponseRefunds**](ChargeResponseRefunds.md) | | [optional] 24 | **status** | **string** | Charge status | 25 | 26 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 27 | -------------------------------------------------------------------------------- /docs/Model/Checkout.md: -------------------------------------------------------------------------------- 1 | # # Checkout 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **allowed_payment_methods** | **string[]** | Those are the payment methods that will be available for the link | 8 | **expires_at** | **int** | It is the time when the link will expire. It is expressed in seconds since the Unix epoch. The valid range is from 2 to 365 days (the valid range will be taken from the next day of the creation date at 00:01 hrs) | 9 | **monthly_installments_enabled** | **bool** | This flag allows you to specify if months without interest will be active. | [optional] 10 | **monthly_installments_options** | **int[]** | This field allows you to specify the number of months without interest. | [optional] 11 | **three_ds_mode** | **string** | Indicates the 3DS2 mode for the order, either smart or strict. | [optional] 12 | **name** | **string** | Reason for charge | 13 | **needs_shipping_contact** | **bool** | This flag allows you to fill in the shipping information at checkout. | [optional] 14 | **on_demand_enabled** | **bool** | This flag allows you to specify if the link will be on demand. | [optional] 15 | **order_template** | [**\Conekta\Model\CheckoutOrderTemplate**](CheckoutOrderTemplate.md) | | 16 | **payments_limit_count** | **int** | It is the number of payments that can be made through the link. | [optional] 17 | **recurrent** | **bool** | false: single use. true: multiple payments | 18 | **type** | **string** | It is the type of link that will be created. It must be a valid type. | 19 | 20 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 21 | -------------------------------------------------------------------------------- /docs/Model/CheckoutOrderTemplate.md: -------------------------------------------------------------------------------- 1 | # # CheckoutOrderTemplate 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **currency** | **string** | It is the currency in which the order will be created. It must be a valid ISO 4217 currency code. | 8 | **customer_info** | [**\Conekta\Model\CheckoutOrderTemplateCustomerInfo**](CheckoutOrderTemplateCustomerInfo.md) | | [optional] 9 | **line_items** | [**\Conekta\Model\Product[]**](Product.md) | They are the products to buy. Each contains the \"unit price\" and \"quantity\" parameters that are used to calculate the total amount of the order. | 10 | **plan_ids** | **string[]** | It is a list of plan IDs that will be associated with the order. | [optional] 11 | **metadata** | **array** | It is a set of key-value pairs that you can attach to the order. It can be used to store additional information about the order in a structured format. | [optional] 12 | 13 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 14 | -------------------------------------------------------------------------------- /docs/Model/CheckoutOrderTemplateCustomerInfo.md: -------------------------------------------------------------------------------- 1 | # # CheckoutOrderTemplateCustomerInfo 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **name** | **string** | | 8 | **email** | **string** | | 9 | **phone** | **string** | | 10 | **corporate** | **bool** | | [optional] 11 | **object** | **string** | | [optional] 12 | **customer_id** | **string** | | 13 | 14 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 15 | -------------------------------------------------------------------------------- /docs/Model/CheckoutRequest.md: -------------------------------------------------------------------------------- 1 | # # CheckoutRequest 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **allowed_payment_methods** | **string[]** | Are the payment methods available for this link. For subscriptions, only 'card' is allowed due to the recurring nature of the payments. | 8 | **plan_ids** | **string[]** | List of plan IDs that will be available for subscription. This field is required for subscription payments but optional for other types of payments. | 9 | **expires_at** | **int** | Unix timestamp of checkout expiration | [optional] 10 | **failure_url** | **string** | Redirection url back to the site in case of failed payment, applies only to HostedPayment. | [optional] 11 | **monthly_installments_enabled** | **bool** | | [optional] 12 | **monthly_installments_options** | **int[]** | | [optional] 13 | **max_failed_retries** | **int** | Number of retries allowed before the checkout is marked as failed | [optional] 14 | **name** | **string** | Reason for payment | [optional] 15 | **on_demand_enabled** | **bool** | | [optional] 16 | **redirection_time** | **int** | number of seconds to wait before redirecting to the success_url | [optional] 17 | **success_url** | **string** | Redirection url back to the site in case of successful payment, applies only to HostedPayment | [optional] 18 | **type** | **string** | This field represents the type of checkout | [optional] 19 | 20 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 21 | -------------------------------------------------------------------------------- /docs/Model/CheckoutResponse.md: -------------------------------------------------------------------------------- 1 | # # CheckoutResponse 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **allowed_payment_methods** | **string[]** | Are the payment methods available for this link | [optional] 8 | **plan_ids** | **string[]** | List of plan IDs that are available for subscription | [optional] 9 | **can_not_expire** | **bool** | | [optional] 10 | **emails_sent** | **int** | | [optional] 11 | **exclude_card_networks** | **object[]** | | [optional] 12 | **expires_at** | **int** | | [optional] 13 | **failure_url** | **string** | | [optional] 14 | **force_3ds_flow** | **bool** | | [optional] 15 | **id** | **string** | | 16 | **livemode** | **bool** | | 17 | **metadata** | **array** | | [optional] 18 | **monthly_installments_enabled** | **bool** | | [optional] 19 | **monthly_installments_options** | **int[]** | | [optional] 20 | **name** | **string** | Reason for charge | 21 | **needs_shipping_contact** | **bool** | | [optional] 22 | **object** | **string** | | 23 | **paid_payments_count** | **int** | | [optional] 24 | **payments_limit_count** | **int** | | [optional] 25 | **recurrent** | **bool** | | [optional] 26 | **slug** | **string** | | [optional] 27 | **sms_sent** | **int** | | [optional] 28 | **starts_at** | **int** | | [optional] 29 | **status** | **string** | | [optional] 30 | **success_url** | **string** | | [optional] 31 | **type** | **string** | | [optional] 32 | **url** | **string** | | [optional] 33 | 34 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 35 | -------------------------------------------------------------------------------- /docs/Model/CheckoutsResponse.md: -------------------------------------------------------------------------------- 1 | # # CheckoutsResponse 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **has_more** | **bool** | Indicates if there are more pages to be requested | 8 | **object** | **string** | Object type, in this case is list | 9 | **next_page_url** | **string** | URL of the next page. | [optional] 10 | **previous_page_url** | **string** | Url of the previous page. | [optional] 11 | **data** | [**\Conekta\Model\CheckoutResponse[]**](CheckoutResponse.md) | | [optional] 12 | 13 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 14 | -------------------------------------------------------------------------------- /docs/Model/CompanyFiscalInfoAddressResponse.md: -------------------------------------------------------------------------------- 1 | # # CompanyFiscalInfoAddressResponse 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **object** | **string** | The resource's type | [optional] 8 | **street1** | **string** | Street Address | [optional] 9 | **street2** | **string** | Colonia | [optional] 10 | **city** | **string** | City | [optional] 11 | **state** | **string** | State | [optional] 12 | **country** | **string** | Country | [optional] 13 | **postal_code** | **string** | Postal code | [optional] 14 | **external_number** | **string** | Street number | [optional] 15 | **internal_number** | **string** | Unit / apartment number | [optional] 16 | 17 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 18 | -------------------------------------------------------------------------------- /docs/Model/CompanyFiscalInfoResponse.md: -------------------------------------------------------------------------------- 1 | # # CompanyFiscalInfoResponse 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **object** | **string** | The resource's type | [optional] 8 | **tax_id** | **string** | Tax ID of the company | [optional] 9 | **legal_entity_name** | **string** | Legal name of the company | [optional] 10 | **business_type** | **string** | Business type of the company | [optional] 11 | **phone** | **string** | Phone number of the company | [optional] 12 | **physical_person_business_type** | **string** | Business type if 'persona_fisica' | [optional] 13 | **address** | [**\Conekta\Model\CompanyFiscalInfoAddressResponse**](CompanyFiscalInfoAddressResponse.md) | | [optional] 14 | 15 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 16 | -------------------------------------------------------------------------------- /docs/Model/CompanyPayoutDestinationResponse.md: -------------------------------------------------------------------------------- 1 | # # CompanyPayoutDestinationResponse 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **object** | **string** | The resource's type | [optional] 8 | **currency** | **string** | currency of the receiving account | [optional] 9 | **account_holder_name** | **string** | Name of the account holder | [optional] 10 | **bank** | **string** | Name of the bank | [optional] 11 | **type** | **string** | Type of the payout destination | [optional] 12 | **account_number** | **string** | Account number of the receiving account | [optional] 13 | 14 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 15 | -------------------------------------------------------------------------------- /docs/Model/CompanyResponse.md: -------------------------------------------------------------------------------- 1 | # # CompanyResponse 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **id** | **string** | The child company's unique identifier | [optional] 8 | **created_at** | **int** | The resource's creation date (unix timestamp) | [optional] 9 | **name** | **string** | The child company's name | [optional] 10 | **object** | **string** | The resource's type | [optional] 11 | **parent_company_id** | **string** | Id of the parent company | [optional] 12 | **use_parent_fiscal_data** | **bool** | Whether the parent company's fiscal data is to be used for liquidation and tax purposes | [optional] 13 | **payout_destination** | [**\Conekta\Model\CompanyPayoutDestinationResponse**](CompanyPayoutDestinationResponse.md) | | [optional] 14 | **fiscal_info** | [**\Conekta\Model\CompanyFiscalInfoResponse**](CompanyFiscalInfoResponse.md) | | [optional] 15 | 16 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 17 | -------------------------------------------------------------------------------- /docs/Model/CreateCustomerFiscalEntitiesResponse.md: -------------------------------------------------------------------------------- 1 | # # CreateCustomerFiscalEntitiesResponse 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **address** | [**\Conekta\Model\CustomerAddress**](CustomerAddress.md) | | 8 | **tax_id** | **string** | | [optional] 9 | **email** | **string** | | [optional] 10 | **phone** | **string** | | [optional] 11 | **metadata** | **array** | | [optional] 12 | **company_name** | **string** | | [optional] 13 | **id** | **string** | | 14 | **object** | **string** | | 15 | **created_at** | **int** | | 16 | **parent_id** | **string** | | [optional] 17 | **default** | **bool** | | [optional] 18 | 19 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 20 | -------------------------------------------------------------------------------- /docs/Model/CreateCustomerPaymentMethodsRequest.md: -------------------------------------------------------------------------------- 1 | # # CreateCustomerPaymentMethodsRequest 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **type** | **string** | Type of payment method | 8 | **token_id** | **string** | Token id that will be used to create a \"card\" type payment method. See the (subscriptions)[https://developers.conekta.com/v2.2.0/reference/createsubscription] tutorial for more information on how to tokenize cards. | 9 | **expires_at** | **int** | | [optional] 10 | 11 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 12 | -------------------------------------------------------------------------------- /docs/Model/CreateCustomerPaymentMethodsResponse.md: -------------------------------------------------------------------------------- 1 | # # CreateCustomerPaymentMethodsResponse 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **type** | **string** | | 8 | **id** | **string** | | 9 | **object** | **string** | | 10 | **created_at** | **int** | | 11 | **parent_id** | **string** | | [optional] 12 | **agreements** | [**\Conekta\Model\PaymentMethodCashResponseAllOfAgreements[]**](PaymentMethodCashResponseAllOfAgreements.md) | | [optional] 13 | **reference** | **string** | | [optional] 14 | **barcode** | **string** | | [optional] 15 | **barcode_url** | **string** | URL to the barcode image, reference is the same as barcode | [optional] 16 | **expires_at** | **string** | | [optional] 17 | **provider** | **string** | | [optional] 18 | **last4** | **string** | | [optional] 19 | **bin** | **string** | | [optional] 20 | **card_type** | **string** | | [optional] 21 | **exp_month** | **string** | | [optional] 22 | **exp_year** | **string** | | [optional] 23 | **brand** | **string** | | [optional] 24 | **name** | **string** | | [optional] 25 | **default** | **bool** | | [optional] 26 | **visible_on_checkout** | **bool** | | [optional] 27 | **payment_source_status** | **string** | | [optional] 28 | 29 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 30 | -------------------------------------------------------------------------------- /docs/Model/CreateRiskRulesData.md: -------------------------------------------------------------------------------- 1 | # # CreateRiskRulesData 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **description** | **string** | Description of the rule | 8 | **field** | **string** | Field to be used for the rule | 9 | **value** | **string** | Value to be used for the rule | 10 | 11 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 12 | -------------------------------------------------------------------------------- /docs/Model/Customer.md: -------------------------------------------------------------------------------- 1 | # # Customer 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **antifraud_info** | [**\Conekta\Model\CustomerAntifraudInfo**](CustomerAntifraudInfo.md) | | [optional] 8 | **corporate** | **bool** | It is a value that allows identifying if the email is corporate or not. | [optional] [default to false] 9 | **custom_reference** | **string** | It is an undefined value. | [optional] 10 | **date_of_birth** | **string** | It is a parameter that allows to identify the date of birth of the client. | [optional] 11 | **email** | **string** | An email address is a series of customizable characters followed by a universal Internet symbol, the at symbol (@), the name of a host server, and a web domain ending (.mx, .com, .org, . net, etc). | 12 | **default_payment_source_id** | **string** | It is a parameter that allows to identify in the response, the Conekta ID of a payment method (payment_id) | [optional] 13 | **default_shipping_contact_id** | **string** | It is a parameter that allows to identify in the response, the Conekta ID of the shipping address (shipping_contact) | [optional] 14 | **fiscal_entities** | [**\Conekta\Model\CustomerFiscalEntitiesRequest[]**](CustomerFiscalEntitiesRequest.md) | | [optional] 15 | **metadata** | **array** | | [optional] 16 | **name** | **string** | Client's name | 17 | **national_id** | **string** | It is a parameter that allows to identify the national identification number of the client. | [optional] 18 | **payment_sources** | [**\Conekta\Model\CustomerPaymentMethodsRequest[]**](CustomerPaymentMethodsRequest.md) | Contains details of the payment methods that the customer has active or has used in Conekta | [optional] 19 | **phone** | **string** | Is the customer's phone number | 20 | **plan_id** | **string** | Contains the ID of a plan, which could together with name, email and phone create a client directly to a subscription | [optional] 21 | **shipping_contacts** | [**\Conekta\Model\CustomerShippingContacts[]**](CustomerShippingContacts.md) | Contains the detail of the shipping addresses that the client has active or has used in Conekta | [optional] 22 | **subscription** | [**\Conekta\Model\SubscriptionRequest**](SubscriptionRequest.md) | | [optional] 23 | 24 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 25 | -------------------------------------------------------------------------------- /docs/Model/CustomerAddress.md: -------------------------------------------------------------------------------- 1 | # # CustomerAddress 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **street1** | **string** | | 8 | **street2** | **string** | | [optional] 9 | **postal_code** | **string** | | 10 | **city** | **string** | | 11 | **state** | **string** | | [optional] 12 | **country** | **string** | this field follows the [ISO 3166-1 alpha-2 standard](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) | [optional] 13 | **residential** | **bool** | | [optional] [default to false] 14 | **external_number** | **string** | | [optional] 15 | 16 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 17 | -------------------------------------------------------------------------------- /docs/Model/CustomerAntifraudInfo.md: -------------------------------------------------------------------------------- 1 | # # CustomerAntifraudInfo 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **account_created_at** | **int** | | [optional] 8 | **first_paid_at** | **int** | | [optional] 9 | 10 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 11 | -------------------------------------------------------------------------------- /docs/Model/CustomerAntifraudInfoResponse.md: -------------------------------------------------------------------------------- 1 | # # CustomerAntifraudInfoResponse 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **first_paid_at** | **int** | | [optional] 8 | **account_created_at** | **int** | | [optional] 9 | 10 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 11 | -------------------------------------------------------------------------------- /docs/Model/CustomerFiscalEntitiesDataResponse.md: -------------------------------------------------------------------------------- 1 | # # CustomerFiscalEntitiesDataResponse 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **address** | [**\Conekta\Model\CustomerAddress**](CustomerAddress.md) | | 8 | **tax_id** | **string** | | [optional] 9 | **email** | **string** | | [optional] 10 | **phone** | **string** | | [optional] 11 | **metadata** | **array** | | [optional] 12 | **company_name** | **string** | | [optional] 13 | **id** | **string** | | 14 | **object** | **string** | | 15 | **created_at** | **int** | | 16 | **parent_id** | **string** | | [optional] 17 | **default** | **bool** | | [optional] 18 | 19 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 20 | -------------------------------------------------------------------------------- /docs/Model/CustomerFiscalEntitiesRequest.md: -------------------------------------------------------------------------------- 1 | # # CustomerFiscalEntitiesRequest 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **address** | [**\Conekta\Model\CustomerAddress**](CustomerAddress.md) | | 8 | **tax_id** | **string** | | [optional] 9 | **email** | **string** | | [optional] 10 | **phone** | **string** | | [optional] 11 | **metadata** | **array** | | [optional] 12 | **company_name** | **string** | | [optional] 13 | 14 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 15 | -------------------------------------------------------------------------------- /docs/Model/CustomerFiscalEntitiesResponse.md: -------------------------------------------------------------------------------- 1 | # # CustomerFiscalEntitiesResponse 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **has_more** | **bool** | Indicates if there are more pages to be requested | 8 | **object** | **string** | Object type, in this case is list | 9 | **data** | [**\Conekta\Model\CustomerFiscalEntitiesDataResponse[]**](CustomerFiscalEntitiesDataResponse.md) | | [optional] 10 | 11 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 12 | -------------------------------------------------------------------------------- /docs/Model/CustomerInfo.md: -------------------------------------------------------------------------------- 1 | # # CustomerInfo 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **name** | **string** | | 8 | **email** | **string** | | 9 | **phone** | **string** | | 10 | **corporate** | **bool** | | [optional] 11 | **object** | **string** | | [optional] 12 | 13 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 14 | -------------------------------------------------------------------------------- /docs/Model/CustomerInfoJustCustomerId.md: -------------------------------------------------------------------------------- 1 | # # CustomerInfoJustCustomerId 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **customer_id** | **string** | | 8 | 9 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 10 | -------------------------------------------------------------------------------- /docs/Model/CustomerInfoJustCustomerIdResponse.md: -------------------------------------------------------------------------------- 1 | # # CustomerInfoJustCustomerIdResponse 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **customer_id** | **string** | | [optional] 8 | 9 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 10 | -------------------------------------------------------------------------------- /docs/Model/CustomerPaymentMethodRequest.md: -------------------------------------------------------------------------------- 1 | # # CustomerPaymentMethodRequest 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **type** | **string** | Type of payment method | 8 | 9 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 10 | -------------------------------------------------------------------------------- /docs/Model/CustomerPaymentMethodsData.md: -------------------------------------------------------------------------------- 1 | # # CustomerPaymentMethodsData 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **type** | **string** | | 8 | **id** | **string** | | 9 | **object** | **string** | | 10 | **created_at** | **int** | | 11 | **parent_id** | **string** | | [optional] 12 | **agreements** | [**\Conekta\Model\PaymentMethodCashResponseAllOfAgreements[]**](PaymentMethodCashResponseAllOfAgreements.md) | | [optional] 13 | **reference** | **string** | | [optional] 14 | **barcode** | **string** | | [optional] 15 | **barcode_url** | **string** | URL to the barcode image, reference is the same as barcode | [optional] 16 | **expires_at** | **string** | | [optional] 17 | **provider** | **string** | | [optional] 18 | **last4** | **string** | | [optional] 19 | **bin** | **string** | | [optional] 20 | **card_type** | **string** | | [optional] 21 | **exp_month** | **string** | | [optional] 22 | **exp_year** | **string** | | [optional] 23 | **brand** | **string** | | [optional] 24 | **name** | **string** | | [optional] 25 | **default** | **bool** | | [optional] 26 | **visible_on_checkout** | **bool** | | [optional] 27 | **payment_source_status** | **string** | | [optional] 28 | 29 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 30 | -------------------------------------------------------------------------------- /docs/Model/CustomerPaymentMethodsRequest.md: -------------------------------------------------------------------------------- 1 | # # CustomerPaymentMethodsRequest 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **type** | **string** | Type of payment method | 8 | **token_id** | **string** | Token id that will be used to create a \"card\" type payment method. See the (subscriptions)[https://developers.conekta.com/v2.2.0/reference/createsubscription] tutorial for more information on how to tokenize cards. | 9 | **expires_at** | **int** | | [optional] 10 | 11 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 12 | -------------------------------------------------------------------------------- /docs/Model/CustomerPaymentMethodsResponse.md: -------------------------------------------------------------------------------- 1 | # # CustomerPaymentMethodsResponse 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **has_more** | **bool** | Indicates if there are more pages to be requested | 8 | **object** | **string** | Object type, in this case is list | 9 | **next_page_url** | **string** | URL of the next page. | [optional] 10 | **previous_page_url** | **string** | Url of the previous page. | [optional] 11 | **data** | [**\Conekta\Model\CustomerPaymentMethodsData[]**](CustomerPaymentMethodsData.md) | | [optional] 12 | 13 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 14 | -------------------------------------------------------------------------------- /docs/Model/CustomerResponse.md: -------------------------------------------------------------------------------- 1 | # # CustomerResponse 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **antifraud_info** | [**\Conekta\Model\CustomerAntifraudInfoResponse**](CustomerAntifraudInfoResponse.md) | | [optional] 8 | **corporate** | **bool** | true if the customer is a company | [optional] 9 | **created_at** | **int** | Creation date of the object | 10 | **custom_reference** | **string** | Custom reference | [optional] 11 | **date_of_birth** | **string** | It is a parameter that allows to identify the date of birth of the client. | [optional] 12 | **default_fiscal_entity_id** | **string** | | [optional] 13 | **default_shipping_contact_id** | **string** | | [optional] 14 | **default_payment_source_id** | **string** | | [optional] 15 | **email** | **string** | | [optional] 16 | **fiscal_entities** | [**\Conekta\Model\CustomerFiscalEntitiesResponse**](CustomerFiscalEntitiesResponse.md) | | [optional] 17 | **id** | **string** | Customer's ID | 18 | **livemode** | **bool** | true if the object exists in live mode or the value false if the object exists in test mode | 19 | **name** | **string** | Customer's name | 20 | **national_id** | **string** | It is a parameter that allows to identify the national identification number of the client. | [optional] 21 | **metadata** | **array** | | [optional] 22 | **object** | **string** | | 23 | **payment_sources** | [**\Conekta\Model\CustomerPaymentMethodsResponse**](CustomerPaymentMethodsResponse.md) | | [optional] 24 | **phone** | **string** | Customer's phone number | [optional] 25 | **shipping_contacts** | [**\Conekta\Model\CustomerResponseShippingContacts**](CustomerResponseShippingContacts.md) | | [optional] 26 | **subscription** | [**\Conekta\Model\SubscriptionResponse**](SubscriptionResponse.md) | | [optional] 27 | 28 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 29 | -------------------------------------------------------------------------------- /docs/Model/CustomerResponseShippingContacts.md: -------------------------------------------------------------------------------- 1 | # # CustomerResponseShippingContacts 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **has_more** | **bool** | Indicates if there are more pages to be requested | 8 | **object** | **string** | Object type, in this case is list | 9 | **data** | [**\Conekta\Model\CustomerShippingContactsDataResponse[]**](CustomerShippingContactsDataResponse.md) | | [optional] 10 | 11 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 12 | -------------------------------------------------------------------------------- /docs/Model/CustomerShippingContacts.md: -------------------------------------------------------------------------------- 1 | # # CustomerShippingContacts 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **phone** | **string** | Phone contact | [optional] 8 | **receiver** | **string** | Name of the person who will receive the order | [optional] 9 | **between_streets** | **string** | The street names between which the order will be delivered. | [optional] 10 | **address** | [**\Conekta\Model\CustomerShippingContactsAddress**](CustomerShippingContactsAddress.md) | | 11 | **parent_id** | **string** | | [optional] 12 | **default** | **bool** | | [optional] 13 | **deleted** | **bool** | | [optional] 14 | **metadata** | **array** | Metadata associated with the shipping contact | [optional] 15 | 16 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 17 | -------------------------------------------------------------------------------- /docs/Model/CustomerShippingContactsAddress.md: -------------------------------------------------------------------------------- 1 | # # CustomerShippingContactsAddress 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **street1** | **string** | | [optional] 8 | **street2** | **string** | | [optional] 9 | **postal_code** | **string** | | [optional] 10 | **city** | **string** | | [optional] 11 | **state** | **string** | | [optional] 12 | **country** | **string** | this field follows the [ISO 3166-1 alpha-2 standard](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) | [optional] 13 | **residential** | **bool** | | [optional] 14 | 15 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 16 | -------------------------------------------------------------------------------- /docs/Model/CustomerShippingContactsDataResponse.md: -------------------------------------------------------------------------------- 1 | # # CustomerShippingContactsDataResponse 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **phone** | **string** | Phone contact | [optional] 8 | **receiver** | **string** | Name of the person who will receive the order | [optional] 9 | **between_streets** | **string** | The street names between which the order will be delivered. | [optional] 10 | **address** | [**\Conekta\Model\CustomerShippingContactsAddress**](CustomerShippingContactsAddress.md) | | 11 | **parent_id** | **string** | | [optional] 12 | **default** | **bool** | | [optional] 13 | **deleted** | **bool** | | [optional] 14 | **metadata** | **array** | Metadata associated with the shipping contact | [optional] 15 | **id** | **string** | | 16 | **object** | **string** | | 17 | **created_at** | **int** | | 18 | 19 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 20 | -------------------------------------------------------------------------------- /docs/Model/CustomerShippingContactsResponse.md: -------------------------------------------------------------------------------- 1 | # # CustomerShippingContactsResponse 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **phone** | **string** | | [optional] 8 | **receiver** | **string** | | [optional] 9 | **between_streets** | **string** | | [optional] 10 | **address** | [**\Conekta\Model\CustomerShippingContactsResponseAddress**](CustomerShippingContactsResponseAddress.md) | | [optional] 11 | **parent_id** | **string** | | [optional] 12 | **default** | **bool** | | [optional] 13 | **id** | **string** | | [optional] 14 | **created_at** | **int** | | [optional] 15 | **metadata** | **array** | Metadata associated with the shipping contact | [optional] 16 | **object** | **string** | | [optional] 17 | **deleted** | **bool** | | [optional] 18 | 19 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 20 | -------------------------------------------------------------------------------- /docs/Model/CustomerShippingContactsResponseAddress.md: -------------------------------------------------------------------------------- 1 | # # CustomerShippingContactsResponseAddress 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **object** | **string** | | [optional] 8 | **street1** | **string** | | [optional] 9 | **street2** | **string** | | [optional] 10 | **postal_code** | **string** | | [optional] 11 | **city** | **string** | | [optional] 12 | **state** | **string** | | [optional] 13 | **country** | **string** | | [optional] 14 | **residential** | **bool** | | [optional] 15 | 16 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 17 | -------------------------------------------------------------------------------- /docs/Model/CustomerUpdateFiscalEntitiesRequest.md: -------------------------------------------------------------------------------- 1 | # # CustomerUpdateFiscalEntitiesRequest 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **address** | [**\Conekta\Model\CustomerAddress**](CustomerAddress.md) | | [optional] 8 | **tax_id** | **string** | | [optional] 9 | **email** | **string** | | [optional] 10 | **phone** | **string** | | [optional] 11 | **metadata** | **array** | | [optional] 12 | **company_name** | **string** | | [optional] 13 | 14 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 15 | -------------------------------------------------------------------------------- /docs/Model/CustomerUpdateShippingContacts.md: -------------------------------------------------------------------------------- 1 | # # CustomerUpdateShippingContacts 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **phone** | **string** | Phone contact | [optional] 8 | **receiver** | **string** | Name of the person who will receive the order | [optional] 9 | **between_streets** | **string** | The street names between which the order will be delivered. | [optional] 10 | **address** | [**\Conekta\Model\CustomerShippingContactsAddress**](CustomerShippingContactsAddress.md) | | [optional] 11 | **parent_id** | **string** | | [optional] 12 | **default** | **bool** | | [optional] 13 | **deleted** | **bool** | | [optional] 14 | 15 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 16 | -------------------------------------------------------------------------------- /docs/Model/CustomersResponse.md: -------------------------------------------------------------------------------- 1 | # # CustomersResponse 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **has_more** | **bool** | Indicates if there are more pages to be requested | 8 | **object** | **string** | Object type, in this case is list | 9 | **next_page_url** | **string** | URL of the next page. | [optional] 10 | **previous_page_url** | **string** | Url of the previous page. | [optional] 11 | **data** | [**\Conekta\Model\CustomerResponse[]**](CustomerResponse.md) | | [optional] 12 | 13 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 14 | -------------------------------------------------------------------------------- /docs/Model/DeleteApiKeysResponse.md: -------------------------------------------------------------------------------- 1 | # # DeleteApiKeysResponse 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **active** | **bool** | Indicates if the api key is active | [optional] 8 | **created_at** | **int** | Unix timestamp in seconds of when the api key was created | [optional] 9 | **description** | **string** | A name or brief explanation of what this api key is used for | [optional] 10 | **livemode** | **bool** | Indicates if the api key is in production | [optional] 11 | **prefix** | **string** | The first few characters of the authentication_token | [optional] 12 | **id** | **string** | Unique identifier of the api key | [optional] 13 | **object** | **string** | Object name, value is 'api_key' | [optional] 14 | **last_used_at** | **int** | Unix timestamp in seconds with the api key was used | [optional] 15 | **role** | **string** | Indicates if the api key is private or public | [optional] 16 | **deleted** | **bool** | | [optional] 17 | 18 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 19 | -------------------------------------------------------------------------------- /docs/Model/DeletedBlacklistRuleResponse.md: -------------------------------------------------------------------------------- 1 | # # DeletedBlacklistRuleResponse 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **id** | **string** | Blacklist rule id | [optional] 8 | **field** | **string** | field used for blacklists rule deleted | [optional] 9 | **value** | **string** | value used for blacklists rule deleted | [optional] 10 | **description** | **string** | use an description for blacklisted rule | [optional] 11 | 12 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 13 | -------------------------------------------------------------------------------- /docs/Model/DeletedWhitelistRuleResponse.md: -------------------------------------------------------------------------------- 1 | # # DeletedWhitelistRuleResponse 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **id** | **string** | Whitelist rule id | [optional] 8 | **field** | **string** | field used for whitelists rule deleted | [optional] 9 | **value** | **string** | value used for whitelists rule deleted | [optional] 10 | **description** | **string** | use an description for whitelisted rule | [optional] 11 | 12 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 13 | -------------------------------------------------------------------------------- /docs/Model/Details.md: -------------------------------------------------------------------------------- 1 | # # Details 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **details** | [**\Conekta\Model\DetailsError[]**](DetailsError.md) | | [optional] 8 | 9 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 10 | -------------------------------------------------------------------------------- /docs/Model/DetailsError.md: -------------------------------------------------------------------------------- 1 | # # DetailsError 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **code** | **string** | | [optional] 8 | **param** | **string** | | [optional] 9 | **message** | **string** | | [optional] 10 | **debug_message** | **string** | | [optional] 11 | 12 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 13 | -------------------------------------------------------------------------------- /docs/Model/DiscountLinesDataResponse.md: -------------------------------------------------------------------------------- 1 | # # DiscountLinesDataResponse 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **amount** | **int** | The amount to be deducted from the total sum of all payments, in cents. | 8 | **code** | **string** | Discount code. | 9 | **type** | **string** | It can be 'loyalty', 'campaign', 'coupon' o 'sign' | 10 | **id** | **string** | The discount line id | 11 | **object** | **string** | The object name | 12 | **parent_id** | **string** | The order id | 13 | 14 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 15 | -------------------------------------------------------------------------------- /docs/Model/DiscountLinesResponse.md: -------------------------------------------------------------------------------- 1 | # # DiscountLinesResponse 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **amount** | **int** | The amount to be deducted from the total sum of all payments, in cents. | 8 | **code** | **string** | Discount code. | 9 | **type** | **string** | It can be 'loyalty', 'campaign', 'coupon' o 'sign' | 10 | **id** | **string** | The discount line id | 11 | **object** | **string** | The object name | 12 | **parent_id** | **string** | The order id | 13 | 14 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 15 | -------------------------------------------------------------------------------- /docs/Model/EmailCheckoutRequest.md: -------------------------------------------------------------------------------- 1 | # # EmailCheckoutRequest 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **email** | **string** | | 8 | 9 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 10 | -------------------------------------------------------------------------------- /docs/Model/Error.md: -------------------------------------------------------------------------------- 1 | # # Error 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **details** | [**\Conekta\Model\DetailsError[]**](DetailsError.md) | | [optional] 8 | **log_id** | **string** | log id | [optional] 9 | **type** | **string** | | [optional] 10 | **object** | **string** | | [optional] 11 | 12 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 13 | -------------------------------------------------------------------------------- /docs/Model/EventResponse.md: -------------------------------------------------------------------------------- 1 | # # EventResponse 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **created_at** | **int** | | [optional] 8 | **data** | **array** | | [optional] 9 | **id** | **string** | | [optional] 10 | **livemode** | **bool** | | [optional] 11 | **object** | **string** | | [optional] 12 | **type** | **string** | | [optional] 13 | **webhook_logs** | [**\Conekta\Model\WebhookLog[]**](WebhookLog.md) | | [optional] 14 | **webhook_status** | **string** | | [optional] 15 | 16 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 17 | -------------------------------------------------------------------------------- /docs/Model/EventTypes.md: -------------------------------------------------------------------------------- 1 | # # EventTypes 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | 8 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 9 | -------------------------------------------------------------------------------- /docs/Model/EventsResendResponse.md: -------------------------------------------------------------------------------- 1 | # # EventsResendResponse 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **failed_attempts** | **int** | | [optional] 8 | **id** | **string** | | [optional] 9 | **last_attempted_at** | **int** | | [optional] 10 | **last_http_response_status** | **int** | | [optional] 11 | **response_data** | **array** | | [optional] 12 | **url** | **string** | | [optional] 13 | 14 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 15 | -------------------------------------------------------------------------------- /docs/Model/FiscalEntityAddress.md: -------------------------------------------------------------------------------- 1 | # # FiscalEntityAddress 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **street1** | **string** | Street name and number | 8 | **street2** | **string** | Street name and number | [optional] 9 | **postal_code** | **string** | Postal code | 10 | **city** | **string** | City | 11 | **state** | **string** | State | [optional] 12 | **country** | **string** | this field follows the [ISO 3166-1 alpha-2 standard](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) | 13 | **external_number** | **string** | External number | 14 | 15 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 16 | -------------------------------------------------------------------------------- /docs/Model/GetApiKeysResponse.md: -------------------------------------------------------------------------------- 1 | # # GetApiKeysResponse 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **next_page_url** | **string** | URL of the next page. | [optional] 8 | **previous_page_url** | **string** | Url of the previous page. | [optional] 9 | **has_more** | **bool** | Indicates if there are more pages to be requested | 10 | **object** | **string** | Object type, in this case is list | 11 | **data** | [**\Conekta\Model\ApiKeyResponse[]**](ApiKeyResponse.md) | | [optional] 12 | 13 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 14 | -------------------------------------------------------------------------------- /docs/Model/GetChargesResponse.md: -------------------------------------------------------------------------------- 1 | # # GetChargesResponse 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **has_more** | **bool** | Indicates if there are more pages to be requested | 8 | **object** | **string** | Object type, in this case is list | 9 | **next_page_url** | **string** | URL of the next page. | [optional] 10 | **previous_page_url** | **string** | Url of the previous page. | [optional] 11 | **data** | [**\Conekta\Model\ChargeResponse[]**](ChargeResponse.md) | | [optional] 12 | 13 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 14 | -------------------------------------------------------------------------------- /docs/Model/GetCompaniesResponse.md: -------------------------------------------------------------------------------- 1 | # # GetCompaniesResponse 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **has_more** | **bool** | Indicates if there are more pages to be requested | 8 | **object** | **string** | Object type, in this case is list | 9 | **next_page_url** | **string** | URL of the next page. | [optional] 10 | **previous_page_url** | **string** | Url of the previous page. | [optional] 11 | **data** | [**\Conekta\Model\CompanyResponse[]**](CompanyResponse.md) | | [optional] 12 | 13 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 14 | -------------------------------------------------------------------------------- /docs/Model/GetCustomerPaymentMethodDataResponse.md: -------------------------------------------------------------------------------- 1 | # # GetCustomerPaymentMethodDataResponse 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **type** | **string** | | 8 | **id** | **string** | | 9 | **object** | **string** | | 10 | **created_at** | **int** | | 11 | **parent_id** | **string** | | [optional] 12 | **agreements** | [**\Conekta\Model\PaymentMethodCashResponseAllOfAgreements[]**](PaymentMethodCashResponseAllOfAgreements.md) | | [optional] 13 | **reference** | **string** | | [optional] 14 | **barcode** | **string** | | [optional] 15 | **barcode_url** | **string** | URL to the barcode image, reference is the same as barcode | [optional] 16 | **expires_at** | **string** | | [optional] 17 | **provider** | **string** | | [optional] 18 | **last4** | **string** | | [optional] 19 | **bin** | **string** | | [optional] 20 | **card_type** | **string** | | [optional] 21 | **exp_month** | **string** | | [optional] 22 | **exp_year** | **string** | | [optional] 23 | **brand** | **string** | | [optional] 24 | **name** | **string** | | [optional] 25 | **default** | **bool** | | [optional] 26 | **visible_on_checkout** | **bool** | | [optional] 27 | **payment_source_status** | **string** | | [optional] 28 | 29 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 30 | -------------------------------------------------------------------------------- /docs/Model/GetEventsResponse.md: -------------------------------------------------------------------------------- 1 | # # GetEventsResponse 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **has_more** | **bool** | Indicates if there are more pages to be requested | 8 | **object** | **string** | Object type, in this case is list | 9 | **next_page_url** | **string** | URL of the next page. | [optional] 10 | **previous_page_url** | **string** | Url of the previous page. | [optional] 11 | **data** | [**\Conekta\Model\EventResponse[]**](EventResponse.md) | | [optional] 12 | 13 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 14 | -------------------------------------------------------------------------------- /docs/Model/GetOrderDiscountLinesResponse.md: -------------------------------------------------------------------------------- 1 | # # GetOrderDiscountLinesResponse 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **has_more** | **bool** | Indicates if there are more pages to be requested | 8 | **object** | **string** | Object type, in this case is list | 9 | **next_page_url** | **string** | URL of the next page. | [optional] 10 | **previous_page_url** | **string** | Url of the previous page. | [optional] 11 | **data** | [**\Conekta\Model\DiscountLinesResponse[]**](DiscountLinesResponse.md) | | [optional] 12 | 13 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 14 | -------------------------------------------------------------------------------- /docs/Model/GetOrdersResponse.md: -------------------------------------------------------------------------------- 1 | # # GetOrdersResponse 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **data** | [**\Conekta\Model\OrderResponse[]**](OrderResponse.md) | | 8 | **has_more** | **bool** | Indicates if there are more pages to be requested | 9 | **object** | **string** | Object type, in this case is list | 10 | **next_page_url** | **string** | URL of the next page. | [optional] 11 | **previous_page_url** | **string** | Url of the previous page. | [optional] 12 | 13 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 14 | -------------------------------------------------------------------------------- /docs/Model/GetPaymentMethodResponse.md: -------------------------------------------------------------------------------- 1 | # # GetPaymentMethodResponse 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **has_more** | **bool** | Indicates if there are more pages to be requested | 8 | **object** | **string** | Object type, in this case is list | 9 | **next_page_url** | **string** | URL of the next page. | [optional] 10 | **previous_page_url** | **string** | Url of the previous page. | [optional] 11 | **data** | [**\Conekta\Model\GetCustomerPaymentMethodDataResponse[]**](GetCustomerPaymentMethodDataResponse.md) | | [optional] 12 | 13 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 14 | -------------------------------------------------------------------------------- /docs/Model/GetPlansResponse.md: -------------------------------------------------------------------------------- 1 | # # GetPlansResponse 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **has_more** | **bool** | Indicates if there are more pages to be requested | 8 | **object** | **string** | Object type, in this case is list | 9 | **next_page_url** | **string** | URL of the next page. | [optional] 10 | **previous_page_url** | **string** | Url of the previous page. | [optional] 11 | **data** | [**\Conekta\Model\PlanResponse[]**](PlanResponse.md) | | [optional] 12 | 13 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 14 | -------------------------------------------------------------------------------- /docs/Model/GetTransactionsResponse.md: -------------------------------------------------------------------------------- 1 | # # GetTransactionsResponse 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **has_more** | **bool** | Indicates if there are more pages to be requested | 8 | **object** | **string** | Object type, in this case is list | 9 | **next_page_url** | **string** | URL of the next page. | [optional] 10 | **previous_page_url** | **string** | Url of the previous page. | [optional] 11 | **data** | [**\Conekta\Model\TransactionResponse[]**](TransactionResponse.md) | Transactions | [optional] 12 | 13 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 14 | -------------------------------------------------------------------------------- /docs/Model/GetTransfersResponse.md: -------------------------------------------------------------------------------- 1 | # # GetTransfersResponse 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **has_more** | **bool** | Indicates if there are more pages to be requested | 8 | **object** | **string** | Object type, in this case is list | 9 | **next_page_url** | **string** | URL of the next page. | [optional] 10 | **previous_page_url** | **string** | Url of the previous page. | [optional] 11 | **data** | [**\Conekta\Model\TransfersResponse[]**](TransfersResponse.md) | Transfers | [optional] 12 | 13 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 14 | -------------------------------------------------------------------------------- /docs/Model/GetWebhookKeysResponse.md: -------------------------------------------------------------------------------- 1 | # # GetWebhookKeysResponse 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **has_more** | **bool** | Indicates if there are more pages to be requested | 8 | **object** | **string** | Object type, in this case is list | 9 | **next_page_url** | **string** | URL of the next page. | [optional] 10 | **previous_page_url** | **string** | Url of the previous page. | [optional] 11 | **data** | [**\Conekta\Model\WebhookKeyResponse[]**](WebhookKeyResponse.md) | | [optional] 12 | 13 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 14 | -------------------------------------------------------------------------------- /docs/Model/GetWebhooksResponse.md: -------------------------------------------------------------------------------- 1 | # # GetWebhooksResponse 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **has_more** | **bool** | Indicates if there are more pages to be requested | 8 | **object** | **string** | Object type, in this case is list | 9 | **next_page_url** | **string** | URL of the next page. | [optional] 10 | **previous_page_url** | **string** | Url of the previous page. | [optional] 11 | **data** | [**\Conekta\Model\WebhookResponse[]**](WebhookResponse.md) | | [optional] 12 | 13 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 14 | -------------------------------------------------------------------------------- /docs/Model/LogResponse.md: -------------------------------------------------------------------------------- 1 | # # LogResponse 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **created_at** | **int** | | 8 | **id** | **string** | | 9 | **ip_address** | **string** | | [optional] 10 | **livemode** | **bool** | | 11 | **loggable_id** | **string** | | [optional] 12 | **loggable_type** | **string** | | [optional] 13 | **method** | **string** | | [optional] 14 | **oauth_token_id** | **string** | | [optional] 15 | **query_string** | **array** | | [optional] 16 | **related** | **string** | | [optional] 17 | **request_body** | **object** | | [optional] 18 | **request_headers** | **array** | | [optional] 19 | **response_body** | **object** | | [optional] 20 | **response_headers** | **array** | | [optional] 21 | **searchable_tags** | **string[]** | | [optional] 22 | **status** | **string** | | [optional] 23 | **updated_at** | **string** | | [optional] 24 | **url** | **string** | | [optional] 25 | **user_account_id** | **string** | | [optional] 26 | **version** | **string** | | [optional] 27 | 28 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 29 | -------------------------------------------------------------------------------- /docs/Model/LogsResponse.md: -------------------------------------------------------------------------------- 1 | # # LogsResponse 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **has_more** | **bool** | True, if there are more pages. | [optional] [readonly] 8 | **object** | **string** | The object type | [optional] [readonly] 9 | **next_page_url** | **string** | URL of the next page. | [optional] 10 | **previous_page_url** | **string** | Url of the previous page. | [optional] 11 | **data** | [**\Conekta\Model\LogsResponseData[]**](LogsResponseData.md) | set to page results. | [optional] 12 | 13 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 14 | -------------------------------------------------------------------------------- /docs/Model/LogsResponseData.md: -------------------------------------------------------------------------------- 1 | # # LogsResponseData 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **created_at** | **int** | | [optional] 8 | **id** | **string** | | [optional] 9 | **ip_address** | **string** | | [optional] 10 | **livemode** | **bool** | | [optional] 11 | **loggable_id** | **string** | | [optional] 12 | **loggable_type** | **string** | | [optional] 13 | **method** | **string** | | [optional] 14 | **oauth_token_id** | **string** | | [optional] 15 | **query_string** | **array** | | [optional] 16 | **related** | **string** | | [optional] 17 | **request_body** | **object** | | [optional] 18 | **request_headers** | **array** | | [optional] 19 | **response_body** | **object** | | [optional] 20 | **response_headers** | **array** | | [optional] 21 | **searchable_tags** | **string[]** | | [optional] 22 | **status** | **string** | | [optional] 23 | **updated_at** | **string** | | [optional] 24 | **url** | **string** | | [optional] 25 | **user_account_id** | **string** | | [optional] 26 | **version** | **string** | | [optional] 27 | 28 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 29 | -------------------------------------------------------------------------------- /docs/Model/OrderCaptureRequest.md: -------------------------------------------------------------------------------- 1 | # # OrderCaptureRequest 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **amount** | **int** | Amount to capture | 8 | 9 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 10 | -------------------------------------------------------------------------------- /docs/Model/OrderChannelResponse.md: -------------------------------------------------------------------------------- 1 | # # OrderChannelResponse 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **segment** | **string** | | [optional] 8 | **checkout_request_id** | **string** | | [optional] 9 | **checkout_request_type** | **string** | | [optional] 10 | **id** | **string** | | [optional] 11 | 12 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 13 | -------------------------------------------------------------------------------- /docs/Model/OrderChargesResponse.md: -------------------------------------------------------------------------------- 1 | # # OrderChargesResponse 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **has_more** | **bool** | Indicates if there are more pages to be requested | 8 | **object** | **string** | Object type, in this case is list | 9 | **data** | [**\Conekta\Model\ChargesDataResponse[]**](ChargesDataResponse.md) | | [optional] 10 | 11 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 12 | -------------------------------------------------------------------------------- /docs/Model/OrderCustomerInfoResponse.md: -------------------------------------------------------------------------------- 1 | # # OrderCustomerInfoResponse 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **customer_custom_reference** | **string** | Custom reference | [optional] 8 | **name** | **string** | | [optional] 9 | **email** | **string** | | [optional] 10 | **phone** | **string** | | [optional] 11 | **corporate** | **bool** | | [optional] [default to false] 12 | **object** | **string** | | [optional] 13 | 14 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 15 | -------------------------------------------------------------------------------- /docs/Model/OrderDiscountLinesRequest.md: -------------------------------------------------------------------------------- 1 | # # OrderDiscountLinesRequest 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **amount** | **int** | The amount to be deducted from the total sum of all payments, in cents. | 8 | **code** | **string** | Discount code. | 9 | **type** | **string** | It can be 'loyalty', 'campaign', 'coupon' o 'sign' | 10 | 11 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 12 | -------------------------------------------------------------------------------- /docs/Model/OrderDiscountLinesResponse.md: -------------------------------------------------------------------------------- 1 | # # OrderDiscountLinesResponse 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **has_more** | **bool** | Indicates if there are more pages to be requested | 8 | **object** | **string** | Object type, in this case is list | 9 | **data** | [**\Conekta\Model\DiscountLinesDataResponse[]**](DiscountLinesDataResponse.md) | | [optional] 10 | 11 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 12 | -------------------------------------------------------------------------------- /docs/Model/OrderFiscalEntityAddressResponse.md: -------------------------------------------------------------------------------- 1 | # # OrderFiscalEntityAddressResponse 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **street1** | **string** | Street name and number | 8 | **street2** | **string** | Street name and number | [optional] 9 | **postal_code** | **string** | Postal code | 10 | **city** | **string** | City | 11 | **state** | **string** | State | [optional] 12 | **country** | **string** | this field follows the [ISO 3166-1 alpha-2 standard](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) | 13 | **external_number** | **string** | External number | 14 | **object** | **string** | | [optional] 15 | 16 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 17 | -------------------------------------------------------------------------------- /docs/Model/OrderFiscalEntityRequest.md: -------------------------------------------------------------------------------- 1 | # # OrderFiscalEntityRequest 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **address** | [**\Conekta\Model\FiscalEntityAddress**](FiscalEntityAddress.md) | | 8 | **email** | **string** | Email of the fiscal entity | [optional] 9 | **metadata** | **array** | Metadata associated with the fiscal entity | [optional] 10 | **name** | **string** | Name of the fiscal entity | [optional] 11 | **phone** | **string** | Phone of the fiscal entity | [optional] 12 | **tax_id** | **string** | Tax ID of the fiscal entity | [optional] 13 | 14 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 15 | -------------------------------------------------------------------------------- /docs/Model/OrderFiscalEntityResponse.md: -------------------------------------------------------------------------------- 1 | # # OrderFiscalEntityResponse 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **address** | [**\Conekta\Model\OrderFiscalEntityAddressResponse**](OrderFiscalEntityAddressResponse.md) | | 8 | **email** | **string** | Email of the fiscal entity | [optional] 9 | **metadata** | **array** | Metadata associated with the fiscal entity | [optional] 10 | **name** | **string** | Name of the fiscal entity | [optional] 11 | **tax_id** | **string** | Tax ID of the fiscal entity | [optional] 12 | **id** | **string** | ID of the fiscal entity | 13 | **created_at** | **int** | The time at which the object was created in seconds since the Unix epoch | 14 | **object** | **string** | | 15 | **phone** | **string** | Phone of the fiscal entity | [optional] 16 | 17 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 18 | -------------------------------------------------------------------------------- /docs/Model/OrderNextActionResponse.md: -------------------------------------------------------------------------------- 1 | # # OrderNextActionResponse 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **redirect_to_url** | [**\Conekta\Model\OrderNextActionResponseRedirectToUrl**](OrderNextActionResponseRedirectToUrl.md) | | [optional] 8 | **type** | **string** | Indicates the type of action to be taken | [optional] 9 | 10 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 11 | -------------------------------------------------------------------------------- /docs/Model/OrderNextActionResponseRedirectToUrl.md: -------------------------------------------------------------------------------- 1 | # # OrderNextActionResponseRedirectToUrl 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **url** | **string** | pay.conekta.com/{id} Indicates the url of the Conekta component to authenticate the flow through 3DS2. | [optional] 8 | **return_url** | **string** | Indicates the url to which the 3DS2 flow returns at the end, when the integration is redirected. | [optional] 9 | 10 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 11 | -------------------------------------------------------------------------------- /docs/Model/OrderRefundRequest.md: -------------------------------------------------------------------------------- 1 | # # OrderRefundRequest 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **amount** | **int** | Amount to be refunded in cents | 8 | **expires_at** | **int** | | [optional] 9 | **reason** | **string** | Reason for the refund | 10 | 11 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 12 | -------------------------------------------------------------------------------- /docs/Model/OrderRequestCustomerInfo.md: -------------------------------------------------------------------------------- 1 | # # OrderRequestCustomerInfo 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **name** | **string** | | 8 | **email** | **string** | | 9 | **phone** | **string** | | 10 | **corporate** | **bool** | | [optional] 11 | **object** | **string** | | [optional] 12 | **customer_id** | **string** | | 13 | 14 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 15 | -------------------------------------------------------------------------------- /docs/Model/OrderResponse.md: -------------------------------------------------------------------------------- 1 | # # OrderResponse 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **amount** | **int** | The total amount to be collected in cents | [optional] 8 | **amount_refunded** | **int** | The total amount refunded in cents | [optional] 9 | **channel** | [**\Conekta\Model\OrderChannelResponse**](OrderChannelResponse.md) | | [optional] 10 | **charges** | [**\Conekta\Model\OrderChargesResponse**](OrderChargesResponse.md) | | [optional] 11 | **checkout** | [**\Conekta\Model\OrderResponseCheckout**](OrderResponseCheckout.md) | | [optional] 12 | **created_at** | **int** | The time at which the object was created in seconds since the Unix epoch | [optional] 13 | **currency** | **string** | The three-letter ISO 4217 currency code. The currency of the order. | [optional] 14 | **customer_info** | [**\Conekta\Model\OrderResponseCustomerInfo**](OrderResponseCustomerInfo.md) | | [optional] 15 | **discount_lines** | [**\Conekta\Model\OrderDiscountLinesResponse**](OrderDiscountLinesResponse.md) | | [optional] 16 | **fiscal_entity** | [**\Conekta\Model\OrderFiscalEntityResponse**](OrderFiscalEntityResponse.md) | | [optional] 17 | **id** | **string** | | [optional] 18 | **is_refundable** | **bool** | | [optional] 19 | **line_items** | [**\Conekta\Model\OrderResponseProducts**](OrderResponseProducts.md) | | [optional] 20 | **livemode** | **bool** | Whether the object exists in live mode or test mode | [optional] 21 | **metadata** | **array** | Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. | [optional] 22 | **next_action** | [**\Conekta\Model\OrderNextActionResponse**](OrderNextActionResponse.md) | | [optional] 23 | **object** | **string** | String representing the object’s type. Objects of the same type share the same value. | [optional] 24 | **payment_status** | **string** | The payment status of the order. | [optional] 25 | **processing_mode** | **string** | Indicates the processing mode for the order, either ecommerce, recurrent or validation. | [optional] 26 | **shipping_contact** | [**\Conekta\Model\OrderResponseShippingContact**](OrderResponseShippingContact.md) | | [optional] 27 | **updated_at** | **int** | The time at which the object was last updated in seconds since the Unix epoch | [optional] 28 | 29 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 30 | -------------------------------------------------------------------------------- /docs/Model/OrderResponseCheckout.md: -------------------------------------------------------------------------------- 1 | # # OrderResponseCheckout 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **allowed_payment_methods** | **string[]** | Are the payment methods available for this link | [optional] 8 | **can_not_expire** | **bool** | | [optional] 9 | **emails_sent** | **int** | | [optional] 10 | **exclude_card_networks** | **object[]** | | [optional] 11 | **expires_at** | **int** | | [optional] 12 | **failure_url** | **string** | | [optional] 13 | **force_3ds_flow** | **bool** | | [optional] 14 | **id** | **string** | | [optional] 15 | **is_redirect_on_failure** | **bool** | | [optional] 16 | **livemode** | **bool** | | [optional] 17 | **max_failed_retries** | **int** | Number of retries allowed before the checkout is marked as failed | [optional] 18 | **metadata** | **array** | | [optional] 19 | **monthly_installments_enabled** | **bool** | | [optional] 20 | **monthly_installments_options** | **int[]** | | [optional] 21 | **name** | **string** | | [optional] 22 | **needs_shipping_contact** | **bool** | | [optional] 23 | **object** | **string** | | [optional] 24 | **on_demand_enabled** | **bool** | | [optional] 25 | **paid_payments_count** | **int** | | [optional] 26 | **recurrent** | **bool** | | [optional] 27 | **redirection_time** | **int** | number of seconds to wait before redirecting to the success_url | [optional] 28 | **slug** | **string** | | [optional] 29 | **sms_sent** | **int** | | [optional] 30 | **success_url** | **string** | | [optional] 31 | **starts_at** | **int** | | [optional] 32 | **status** | **string** | | [optional] 33 | **type** | **string** | | [optional] 34 | **url** | **string** | | [optional] 35 | 36 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 37 | -------------------------------------------------------------------------------- /docs/Model/OrderResponseCustomerInfo.md: -------------------------------------------------------------------------------- 1 | # # OrderResponseCustomerInfo 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **customer_custom_reference** | **string** | Custom reference | [optional] 8 | **name** | **string** | | [optional] 9 | **email** | **string** | | [optional] 10 | **phone** | **string** | | [optional] 11 | **corporate** | **bool** | | [optional] [default to false] 12 | **object** | **string** | | [optional] 13 | **customer_id** | **string** | | [optional] 14 | 15 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 16 | -------------------------------------------------------------------------------- /docs/Model/OrderResponseProducts.md: -------------------------------------------------------------------------------- 1 | # # OrderResponseProducts 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **has_more** | **bool** | Indicates if there are more pages to be requested | 8 | **object** | **string** | Object type, in this case is list | 9 | **next_page_url** | **string** | URL of the next page. | [optional] 10 | **previous_page_url** | **string** | Url of the previous page. | [optional] 11 | **data** | [**\Conekta\Model\ProductDataResponse[]**](ProductDataResponse.md) | | [optional] 12 | 13 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 14 | -------------------------------------------------------------------------------- /docs/Model/OrderResponseShippingContact.md: -------------------------------------------------------------------------------- 1 | # # OrderResponseShippingContact 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **phone** | **string** | | [optional] 8 | **receiver** | **string** | | [optional] 9 | **between_streets** | **string** | | [optional] 10 | **address** | [**\Conekta\Model\CustomerShippingContactsResponseAddress**](CustomerShippingContactsResponseAddress.md) | | [optional] 11 | **parent_id** | **string** | | [optional] 12 | **default** | **bool** | | [optional] 13 | **id** | **string** | | [optional] 14 | **created_at** | **int** | | [optional] 15 | **metadata** | **array** | Metadata associated with the shipping contact | [optional] 16 | **object** | **string** | | [optional] 17 | **deleted** | **bool** | | [optional] 18 | 19 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 20 | -------------------------------------------------------------------------------- /docs/Model/OrderTaxRequest.md: -------------------------------------------------------------------------------- 1 | # # OrderTaxRequest 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **amount** | **int** | The amount to be collected for tax in cents | 8 | **description** | **string** | description or tax's name | 9 | **metadata** | **array** | | [optional] 10 | 11 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 12 | -------------------------------------------------------------------------------- /docs/Model/OrderUpdateFiscalEntityRequest.md: -------------------------------------------------------------------------------- 1 | # # OrderUpdateFiscalEntityRequest 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **address** | [**\Conekta\Model\FiscalEntityAddress**](FiscalEntityAddress.md) | | 8 | **email** | **string** | Email of the fiscal entity | [optional] 9 | **name** | **string** | Name of the fiscal entity | [optional] 10 | **metadata** | **array** | Metadata associated with the fiscal entity | [optional] 11 | **phone** | **string** | Phone of the fiscal entity | [optional] 12 | **tax_id** | **string** | Tax ID of the fiscal entity | [optional] 13 | 14 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 15 | -------------------------------------------------------------------------------- /docs/Model/OrderUpdateRequest.md: -------------------------------------------------------------------------------- 1 | # # OrderUpdateRequest 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **charges** | [**\Conekta\Model\ChargeRequest[]**](ChargeRequest.md) | | [optional] 8 | **checkout** | [**\Conekta\Model\CheckoutRequest**](CheckoutRequest.md) | | [optional] 9 | **currency** | **string** | Currency with which the payment will be made. It uses the 3-letter code of the [International Standard ISO 4217.](https://es.wikipedia.org/wiki/ISO_4217) | [optional] 10 | **customer_info** | [**\Conekta\Model\OrderUpdateRequestCustomerInfo**](OrderUpdateRequestCustomerInfo.md) | | [optional] 11 | **discount_lines** | [**\Conekta\Model\OrderDiscountLinesRequest[]**](OrderDiscountLinesRequest.md) | List of [discounts](https://developers.conekta.com/v2.2.0/reference/orderscreatediscountline) that are applied to the order. You must have at least one discount. | [optional] 12 | **fiscal_entity** | [**\Conekta\Model\OrderUpdateFiscalEntityRequest**](OrderUpdateFiscalEntityRequest.md) | | [optional] 13 | **line_items** | [**\Conekta\Model\Product[]**](Product.md) | List of [products](https://developers.conekta.com/v2.2.0/reference/orderscreateproduct) that are sold in the order. You must have at least one product. | [optional] 14 | **metadata** | **array** | | [optional] 15 | **pre_authorize** | **bool** | Indicates whether the order charges must be preauthorized | [optional] [default to false] 16 | **shipping_contact** | [**\Conekta\Model\CustomerShippingContacts**](CustomerShippingContacts.md) | | [optional] 17 | **shipping_lines** | [**\Conekta\Model\ShippingRequest[]**](ShippingRequest.md) | List of [shipping costs](https://developers.conekta.com/v2.2.0/reference/orderscreateshipping). If the online store offers digital products. | [optional] 18 | **tax_lines** | [**\Conekta\Model\OrderTaxRequest[]**](OrderTaxRequest.md) | | [optional] 19 | 20 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 21 | -------------------------------------------------------------------------------- /docs/Model/OrderUpdateRequestCustomerInfo.md: -------------------------------------------------------------------------------- 1 | # # OrderUpdateRequestCustomerInfo 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **name** | **string** | | 8 | **email** | **string** | | 9 | **phone** | **string** | | 10 | **corporate** | **bool** | | [optional] 11 | **object** | **string** | | [optional] 12 | **customer_id** | **string** | | 13 | 14 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 15 | -------------------------------------------------------------------------------- /docs/Model/OrdersResponse.md: -------------------------------------------------------------------------------- 1 | # # OrdersResponse 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **data** | [**\Conekta\Model\OrderResponse[]**](OrderResponse.md) | | 8 | 9 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 10 | -------------------------------------------------------------------------------- /docs/Model/Page.md: -------------------------------------------------------------------------------- 1 | # # Page 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **next_page_url** | **string** | URL of the next page. | [optional] 8 | **previous_page_url** | **string** | Url of the previous page. | [optional] 9 | 10 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 11 | -------------------------------------------------------------------------------- /docs/Model/Pagination.md: -------------------------------------------------------------------------------- 1 | # # Pagination 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **has_more** | **bool** | Indicates if there are more pages to be requested | 8 | **object** | **string** | Object type, in this case is list | 9 | 10 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 11 | -------------------------------------------------------------------------------- /docs/Model/PaymentMethod.md: -------------------------------------------------------------------------------- 1 | # # PaymentMethod 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **type** | **string** | | [optional] 8 | **object** | **string** | | 9 | 10 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 11 | -------------------------------------------------------------------------------- /docs/Model/PaymentMethodBankTransfer.md: -------------------------------------------------------------------------------- 1 | # # PaymentMethodBankTransfer 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **type** | **string** | | [optional] 8 | **object** | **string** | | 9 | **bank** | **string** | | [optional] 10 | **clabe** | **string** | | [optional] 11 | **description** | **string** | | [optional] 12 | **executed_at** | **string** | | [optional] 13 | **expires_at** | **int** | | [optional] 14 | **issuing_account_bank** | **string** | | [optional] 15 | **issuing_account_number** | **string** | | [optional] 16 | **issuing_account_holder_name** | **string** | | [optional] 17 | **issuing_account_tax_id** | **string** | | [optional] 18 | **payment_attempts** | **mixed[]** | | [optional] 19 | **receiving_account_holder_name** | **string** | | [optional] 20 | **receiving_account_number** | **string** | | [optional] 21 | **receiving_account_bank** | **string** | | [optional] 22 | **receiving_account_tax_id** | **string** | | [optional] 23 | **reference_number** | **string** | | [optional] 24 | **tracking_code** | **string** | | [optional] 25 | **customer_ip_address** | **string** | | [optional] 26 | 27 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 28 | -------------------------------------------------------------------------------- /docs/Model/PaymentMethodBnplPayment.md: -------------------------------------------------------------------------------- 1 | # # PaymentMethodBnplPayment 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **type** | **string** | | [optional] 8 | **object** | **string** | | 9 | **cancel_url** | **string** | URL to redirect the customer after a canceled payment | [optional] 10 | **expires_at** | **int** | Expiration date of the charge | 11 | **failure_url** | **string** | URL to redirect the customer after a failed payment | [optional] 12 | **product_type** | **string** | Product type of the charge | 13 | **redirect_url** | **string** | URL to redirect the customer to complete the payment | [optional] 14 | **success_url** | **string** | URL to redirect the customer after a successful payment | [optional] 15 | 16 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 17 | -------------------------------------------------------------------------------- /docs/Model/PaymentMethodBnplRequest.md: -------------------------------------------------------------------------------- 1 | # # PaymentMethodBnplRequest 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **type** | **string** | Type of the payment method | 8 | **cancel_url** | **string** | URL to redirect the customer after a canceled payment | 9 | **can_not_expire** | **bool** | Indicates if the payment method can not expire | 10 | **failure_url** | **string** | URL to redirect the customer after a failed payment | 11 | **product_type** | **string** | Product type of the payment method, use for the payment method to know the product type | 12 | **success_url** | **string** | URL to redirect the customer after a successful payment | 13 | 14 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 15 | -------------------------------------------------------------------------------- /docs/Model/PaymentMethodCard.md: -------------------------------------------------------------------------------- 1 | # # PaymentMethodCard 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **type** | **string** | | [optional] 8 | **object** | **string** | | 9 | **account_type** | **string** | Account type of the card | [optional] 10 | **auth_code** | **string** | | [optional] 11 | **brand** | **string** | Brand of the card | [optional] 12 | **contract_id** | **string** | Id sent for recurrent charges. | [optional] 13 | **country** | **string** | Country of the card | [optional] 14 | **exp_month** | **string** | Expiration month of the card | [optional] 15 | **exp_year** | **string** | Expiration year of the card | [optional] 16 | **fraud_indicators** | **mixed[]** | | [optional] 17 | **issuer** | **string** | Issuer of the card | [optional] 18 | **last4** | **string** | Last 4 digits of the card | [optional] 19 | **name** | **string** | Name of the cardholder | [optional] 20 | **customer_ip_address** | **string** | Optional field used to capture the customer's IP address for fraud prevention and security monitoring purposes | [optional] 21 | 22 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 23 | -------------------------------------------------------------------------------- /docs/Model/PaymentMethodCardRequest.md: -------------------------------------------------------------------------------- 1 | # # PaymentMethodCardRequest 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **type** | **string** | Type of payment method | 8 | **cvc** | **string** | Card security code | 9 | **exp_month** | **string** | Card expiration month | 10 | **exp_year** | **string** | Card expiration year | 11 | **name** | **string** | Cardholder name | 12 | **number** | **string** | Card number | 13 | **customer_ip_address** | **string** | Optional field used to capture the customer's IP address for fraud prevention and security monitoring purposes | [optional] 14 | 15 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 16 | -------------------------------------------------------------------------------- /docs/Model/PaymentMethodCardResponse.md: -------------------------------------------------------------------------------- 1 | # # PaymentMethodCardResponse 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **type** | **string** | | 8 | **id** | **string** | | 9 | **object** | **string** | | 10 | **created_at** | **int** | | 11 | **parent_id** | **string** | | [optional] 12 | **last4** | **string** | | [optional] 13 | **bin** | **string** | | [optional] 14 | **card_type** | **string** | | [optional] 15 | **exp_month** | **string** | | [optional] 16 | **exp_year** | **string** | | [optional] 17 | **brand** | **string** | | [optional] 18 | **name** | **string** | | [optional] 19 | **default** | **bool** | | [optional] 20 | **visible_on_checkout** | **bool** | | [optional] 21 | **payment_source_status** | **string** | | [optional] 22 | 23 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 24 | -------------------------------------------------------------------------------- /docs/Model/PaymentMethodCash.md: -------------------------------------------------------------------------------- 1 | # # PaymentMethodCash 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **type** | **string** | | [optional] 8 | **object** | **string** | | 9 | **agreement** | **string** | Agreement ID | [optional] 10 | **auth_code** | **int** | | [optional] 11 | **cashier_id** | **string** | | [optional] 12 | **reference** | **string** | | [optional] 13 | **barcode_url** | **string** | | [optional] 14 | **expires_at** | **int** | | [optional] 15 | **product_type** | **string** | Product type, e.g. bbva_cash_in, cash_in, pespay_cash_in, etc. | [optional] 16 | **service_name** | **string** | | [optional] 17 | **store** | **string** | | [optional] 18 | **store_name** | **string** | | [optional] 19 | **customer_ip_address** | **string** | | [optional] 20 | 21 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 22 | -------------------------------------------------------------------------------- /docs/Model/PaymentMethodCashRequest.md: -------------------------------------------------------------------------------- 1 | # # PaymentMethodCashRequest 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **type** | **string** | Type of payment method | 8 | **expires_at** | **int** | | [optional] 9 | 10 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 11 | -------------------------------------------------------------------------------- /docs/Model/PaymentMethodCashResponse.md: -------------------------------------------------------------------------------- 1 | # # PaymentMethodCashResponse 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **type** | **string** | | 8 | **id** | **string** | | 9 | **object** | **string** | | 10 | **created_at** | **int** | | 11 | **parent_id** | **string** | | [optional] 12 | **agreements** | [**\Conekta\Model\PaymentMethodCashResponseAllOfAgreements[]**](PaymentMethodCashResponseAllOfAgreements.md) | | [optional] 13 | **reference** | **string** | | [optional] 14 | **barcode** | **string** | | [optional] 15 | **barcode_url** | **string** | URL to the barcode image, reference is the same as barcode | [optional] 16 | **expires_at** | **int** | | [optional] 17 | **provider** | **string** | | [optional] 18 | 19 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 20 | -------------------------------------------------------------------------------- /docs/Model/PaymentMethodCashResponseAllOfAgreements.md: -------------------------------------------------------------------------------- 1 | # # PaymentMethodCashResponseAllOfAgreements 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **agreement** | **string** | Agreement number, you can use this number to pay in the store/bbva | [optional] 8 | **provider** | **string** | Provider name, you can use this to know where to pay | [optional] 9 | 10 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 11 | -------------------------------------------------------------------------------- /docs/Model/PaymentMethodGeneralRequest.md: -------------------------------------------------------------------------------- 1 | # # PaymentMethodGeneralRequest 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **expires_at** | **int** | Method expiration date as unix timestamp | [optional] 8 | **monthly_installments** | **int** | How many months without interest to apply, it can be 3, 6, 9, 12 or 18 | [optional] 9 | **type** | **string** | Type of payment method | 10 | **token_id** | **string** | | [optional] 11 | **payment_source_id** | **string** | | [optional] 12 | **cvc** | **string** | Optional, It is a value that allows identifying the security code of the card. Only for PCI merchants | [optional] 13 | **contract_id** | **string** | Optional id sent to indicate the bank contract for recurrent card charges. | [optional] 14 | **customer_ip_address** | **string** | Optional field used to capture the customer's IP address for fraud prevention and security monitoring purposes | [optional] 15 | 16 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 17 | -------------------------------------------------------------------------------- /docs/Model/PaymentMethodResponse.md: -------------------------------------------------------------------------------- 1 | # # PaymentMethodResponse 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **type** | **string** | | 8 | **id** | **string** | | 9 | **object** | **string** | | 10 | **created_at** | **int** | | 11 | **parent_id** | **string** | | [optional] 12 | 13 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 14 | -------------------------------------------------------------------------------- /docs/Model/PaymentMethodSpeiRecurrent.md: -------------------------------------------------------------------------------- 1 | # # PaymentMethodSpeiRecurrent 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **type** | **string** | | 8 | **id** | **string** | | 9 | **object** | **string** | | 10 | **created_at** | **int** | | 11 | **parent_id** | **string** | | [optional] 12 | **reference** | **string** | | [optional] 13 | **expires_at** | **string** | | [optional] 14 | 15 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 16 | -------------------------------------------------------------------------------- /docs/Model/PaymentMethodSpeiRequest.md: -------------------------------------------------------------------------------- 1 | # # PaymentMethodSpeiRequest 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **type** | **string** | Type of payment method | 8 | **expires_at** | **int** | | [optional] 9 | 10 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 11 | -------------------------------------------------------------------------------- /docs/Model/PaymentMethodTokenRequest.md: -------------------------------------------------------------------------------- 1 | # # PaymentMethodTokenRequest 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **type** | **string** | Type of payment method | 8 | **token_id** | **string** | Token id that will be used to create a \"card\" type payment method. See the (subscriptions)[https://developers.conekta.com/v2.2.0/reference/createsubscription] tutorial for more information on how to tokenize cards. | 9 | 10 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 11 | -------------------------------------------------------------------------------- /docs/Model/Payout.md: -------------------------------------------------------------------------------- 1 | # # Payout 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **payout_method** | [**\Conekta\Model\PayoutMethod**](PayoutMethod.md) | | 8 | 9 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 10 | -------------------------------------------------------------------------------- /docs/Model/PayoutMethod.md: -------------------------------------------------------------------------------- 1 | # # PayoutMethod 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **type** | **string** | The type of the payout method. | 8 | 9 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 10 | -------------------------------------------------------------------------------- /docs/Model/PayoutOrder.md: -------------------------------------------------------------------------------- 1 | # # PayoutOrder 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **allowed_payout_methods** | **string[]** | The payout methods that are allowed for the payout order. | 8 | **amount** | **int** | The amount of the payout order. | 9 | **currency** | **string** | The currency in which the payout order is made. | [default to 'MXN'] 10 | **customer_info** | [**\Conekta\Model\CustomerInfoJustCustomerId**](CustomerInfoJustCustomerId.md) | | 11 | **metadata** | **array** | The metadata of the payout order. | [optional] 12 | **payout** | [**\Conekta\Model\Payout**](Payout.md) | | 13 | **reason** | **string** | The reason for the payout order. | 14 | 15 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 16 | -------------------------------------------------------------------------------- /docs/Model/PayoutOrderPayoutsItem.md: -------------------------------------------------------------------------------- 1 | # # PayoutOrderPayoutsItem 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **amount** | **int** | The amount of the payout. | 8 | **currency** | **string** | The currency in which the payout is made. | 9 | **expires_at** | **int** | The expiration date of the payout. | [optional] 10 | **id** | **string** | The id of the payout. | 11 | **livemode** | **bool** | The live mode of the payout. | 12 | **object** | **string** | The object of the payout. | 13 | **payout_order_id** | **string** | The id of the payout order. | [optional] 14 | **status** | **string** | The status of the payout. | [optional] 15 | 16 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 17 | -------------------------------------------------------------------------------- /docs/Model/PayoutOrderResponse.md: -------------------------------------------------------------------------------- 1 | # # PayoutOrderResponse 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **allowed_payout_methods** | **string[]** | The payout methods that are allowed for the payout order. | 8 | **amount** | **int** | The amount of the payout order. | 9 | **created_at** | **int** | The creation date of the payout order. | 10 | **currency** | **string** | The currency in which the payout order is made. | [default to 'MXN'] 11 | **customer_info** | [**\Conekta\Model\PayoutOrderResponseCustomerInfo**](PayoutOrderResponseCustomerInfo.md) | | 12 | **expires_at** | **int** | The expiration date of the payout order. | [optional] 13 | **id** | **string** | The id of the payout order. | 14 | **livemode** | **bool** | The live mode of the payout order. | 15 | **object** | **string** | The object of the payout order. | 16 | **metadata** | **array** | The metadata of the payout order. | [optional] 17 | **payouts** | [**\Conekta\Model\PayoutOrderPayoutsItem[]**](PayoutOrderPayoutsItem.md) | The payout information of the payout order. | 18 | **reason** | **string** | The reason for the payout order. | 19 | **status** | **string** | The status of the payout order. | [optional] 20 | **updated_at** | **int** | The update date of the payout order. | 21 | 22 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 23 | -------------------------------------------------------------------------------- /docs/Model/PayoutOrderResponseCustomerInfo.md: -------------------------------------------------------------------------------- 1 | # # PayoutOrderResponseCustomerInfo 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **customer_custom_reference** | **string** | Custom reference | [optional] 8 | **name** | **string** | | [optional] 9 | **email** | **string** | | [optional] 10 | **phone** | **string** | | [optional] 11 | **corporate** | **bool** | | [optional] [default to false] 12 | **object** | **string** | | [optional] 13 | **id** | **string** | The id of the customer. | 14 | 15 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 16 | -------------------------------------------------------------------------------- /docs/Model/PayoutOrdersResponse.md: -------------------------------------------------------------------------------- 1 | # # PayoutOrdersResponse 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **has_more** | **bool** | Indicates if there are more pages to be requested | 8 | **object** | **string** | Object type, in this case is list | 9 | **next_page_url** | **string** | URL of the next page. | [optional] 10 | **previous_page_url** | **string** | Url of the previous page. | [optional] 11 | **data** | [**\Conekta\Model\PayoutOrderResponse[]**](PayoutOrderResponse.md) | | [optional] 12 | 13 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 14 | -------------------------------------------------------------------------------- /docs/Model/PlanRequest.md: -------------------------------------------------------------------------------- 1 | # # PlanRequest 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **amount** | **int** | The amount in cents that will be charged on the interval specified. | 8 | **currency** | **string** | ISO 4217 for currencies, for the Mexican peso it is MXN/USD | [optional] 9 | **expiry_count** | **int** | Number of repetitions of the frequency NUMBER OF CHARGES TO BE MADE, considering the interval and frequency, this evolves over time, but is subject to the expiration count. | [optional] 10 | **frequency** | **int** | Frequency of the charge, which together with the interval, can be every 3 weeks, every 4 months, every 2 years, every 5 fortnights | 11 | **id** | **string** | internal reference id | [optional] 12 | **interval** | **string** | The interval of time between each charge. | 13 | **name** | **string** | The name of the plan. | 14 | **trial_period_days** | **int** | The number of days the customer will have a free trial. | [optional] 15 | **max_retries** | **int** | (optional) Specifies the maximum number of retry attempts for a subscription payment before it is canceled. | [optional] 16 | **retry_delay_hours** | **int** | (optional) Defines the number of hours between subscription payment retry attempts. | [optional] 17 | 18 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 19 | -------------------------------------------------------------------------------- /docs/Model/PlanResponse.md: -------------------------------------------------------------------------------- 1 | # # PlanResponse 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **amount** | **int** | | [optional] 8 | **created_at** | **int** | | [optional] 9 | **currency** | **string** | | [optional] 10 | **expiry_count** | **int** | | [optional] 11 | **frequency** | **int** | | [optional] 12 | **id** | **string** | | [optional] 13 | **interval** | **string** | | [optional] 14 | **livemode** | **bool** | | [optional] 15 | **name** | **string** | | [optional] 16 | **object** | **string** | | [optional] 17 | **trial_period_days** | **int** | | [optional] 18 | **max_retries** | **int** | | [optional] 19 | **retry_delay_hours** | **int** | | [optional] 20 | 21 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 22 | -------------------------------------------------------------------------------- /docs/Model/PlanUpdateRequest.md: -------------------------------------------------------------------------------- 1 | # # PlanUpdateRequest 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **amount** | **int** | The amount in cents that will be charged on the interval specified. | [optional] 8 | **currency** | **string** | ISO 4217 for currencies, for the Mexican peso it is MXN/USD | [optional] 9 | **expiry_count** | **int** | Number of repetitions of the frequency NUMBER OF CHARGES TO BE MADE, considering the interval and frequency, this evolves over time, but is subject to the expiration count. | [optional] 10 | **name** | **string** | The name of the plan. | [optional] 11 | 12 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 13 | -------------------------------------------------------------------------------- /docs/Model/Product.md: -------------------------------------------------------------------------------- 1 | # # Product 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **antifraud_info** | **array** | | [optional] 8 | **brand** | **string** | The brand of the item. | [optional] 9 | **description** | **string** | Short description of the item | [optional] 10 | **metadata** | **array** | It is a key/value hash that can hold custom fields. Maximum 100 elements and allows special characters. | [optional] 11 | **name** | **string** | The name of the item. It will be displayed in the order. | 12 | **quantity** | **int** | The quantity of the item in the order. | 13 | **sku** | **string** | The stock keeping unit for the item. It is used to identify the item in the order. | [optional] 14 | **tags** | **string[]** | List of tags for the item. It is used to identify the item in the order. | [optional] 15 | **unit_price** | **int** | The price of the item in cents. | 16 | 17 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 18 | -------------------------------------------------------------------------------- /docs/Model/ProductDataResponse.md: -------------------------------------------------------------------------------- 1 | # # ProductDataResponse 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **antifraud_info** | **array** | | [optional] 8 | **brand** | **string** | The brand of the item. | [optional] 9 | **description** | **string** | Short description of the item | [optional] 10 | **metadata** | **array** | It is a key/value hash that can hold custom fields. Maximum 100 elements and allows special characters. | [optional] 11 | **name** | **string** | The name of the item. It will be displayed in the order. | 12 | **quantity** | **int** | The quantity of the item in the order. | 13 | **sku** | **string** | The stock keeping unit for the item. It is used to identify the item in the order. | [optional] 14 | **tags** | **string[]** | List of tags for the item. It is used to identify the item in the order. | [optional] 15 | **unit_price** | **int** | The price of the item in cents. | 16 | **id** | **string** | | [optional] 17 | **object** | **string** | | [optional] 18 | **parent_id** | **string** | | [optional] 19 | 20 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 21 | -------------------------------------------------------------------------------- /docs/Model/ProductOrderResponse.md: -------------------------------------------------------------------------------- 1 | # # ProductOrderResponse 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **antifraud_info** | **array** | | [optional] 8 | **brand** | **string** | The brand of the item. | [optional] 9 | **description** | **string** | Short description of the item | [optional] 10 | **metadata** | **array** | It is a key/value hash that can hold custom fields. Maximum 100 elements and allows special characters. | [optional] 11 | **name** | **string** | The name of the item. It will be displayed in the order. | 12 | **quantity** | **int** | The quantity of the item in the order. | 13 | **sku** | **string** | The stock keeping unit for the item. It is used to identify the item in the order. | [optional] 14 | **tags** | **string[]** | List of tags for the item. It is used to identify the item in the order. | [optional] 15 | **unit_price** | **int** | The price of the item in cents. | 16 | **id** | **string** | | [optional] 17 | **object** | **string** | | [optional] 18 | **parent_id** | **string** | | [optional] 19 | 20 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 21 | -------------------------------------------------------------------------------- /docs/Model/ResendRequest.md: -------------------------------------------------------------------------------- 1 | # # ResendRequest 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **webhooks_ids** | **string[]** | webhooks ids to resend event | 8 | 9 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 10 | -------------------------------------------------------------------------------- /docs/Model/RiskRulesData.md: -------------------------------------------------------------------------------- 1 | # # RiskRulesData 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **id** | **string** | rule id | [optional] 8 | **field** | **string** | field to be used for the rule | [optional] 9 | **created_at** | **string** | rule creation date | [optional] 10 | **value** | **string** | value to be used for the rule | [optional] 11 | **is_global** | **bool** | if the rule is global | [optional] 12 | **is_test** | **bool** | if the rule is test | [optional] 13 | **description** | **string** | description of the rule | [optional] 14 | 15 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 16 | -------------------------------------------------------------------------------- /docs/Model/RiskRulesList.md: -------------------------------------------------------------------------------- 1 | # # RiskRulesList 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **has_more** | **bool** | Indicates if there are more pages to be requested | 8 | **object** | **string** | Object type, in this case is list | 9 | **next_page_url** | **string** | URL of the next page. | [optional] 10 | **previous_page_url** | **string** | Url of the previous page. | [optional] 11 | **data** | [**\Conekta\Model\RiskRulesData[]**](RiskRulesData.md) | | [optional] 12 | 13 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 14 | -------------------------------------------------------------------------------- /docs/Model/ShippingOrderResponse.md: -------------------------------------------------------------------------------- 1 | # # ShippingOrderResponse 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **amount** | **int** | Shipping amount in cents | 8 | **carrier** | **string** | Carrier name for the shipment | [optional] 9 | **tracking_number** | **string** | Tracking number can be used to track the shipment | [optional] 10 | **method** | **string** | Method of shipment | [optional] 11 | **metadata** | **array** | Hash where the user can send additional information for each 'shipping'. | [optional] 12 | **id** | **string** | | [optional] 13 | **object** | **string** | | [optional] 14 | **parent_id** | **string** | | [optional] 15 | 16 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 17 | -------------------------------------------------------------------------------- /docs/Model/ShippingRequest.md: -------------------------------------------------------------------------------- 1 | # # ShippingRequest 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **amount** | **int** | Shipping amount in cents | 8 | **carrier** | **string** | Carrier name for the shipment | [optional] 9 | **tracking_number** | **string** | Tracking number can be used to track the shipment | [optional] 10 | **method** | **string** | Method of shipment | [optional] 11 | **metadata** | **array** | Hash where the user can send additional information for each 'shipping'. | [optional] 12 | 13 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 14 | -------------------------------------------------------------------------------- /docs/Model/SmsCheckoutRequest.md: -------------------------------------------------------------------------------- 1 | # # SmsCheckoutRequest 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **phonenumber** | **string** | | 8 | 9 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 10 | -------------------------------------------------------------------------------- /docs/Model/SubscriptionEventsResponse.md: -------------------------------------------------------------------------------- 1 | # # SubscriptionEventsResponse 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **has_more** | **bool** | Indicates if there are more pages to be requested | 8 | **object** | **string** | Object type, in this case is list | 9 | **next_page_url** | **string** | URL of the next page. | [optional] 10 | **previous_page_url** | **string** | Url of the previous page. | [optional] 11 | **data** | [**\Conekta\Model\EventResponse[]**](EventResponse.md) | | [optional] 12 | 13 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 14 | -------------------------------------------------------------------------------- /docs/Model/SubscriptionRequest.md: -------------------------------------------------------------------------------- 1 | # # SubscriptionRequest 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **plan_id** | **string** | | 8 | **card_id** | **string** | | [optional] 9 | **trial_end** | **int** | | [optional] 10 | 11 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 12 | -------------------------------------------------------------------------------- /docs/Model/SubscriptionResponse.md: -------------------------------------------------------------------------------- 1 | # # SubscriptionResponse 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **billing_cycle_start** | **int** | | [optional] 8 | **billing_cycle_end** | **int** | | [optional] 9 | **canceled_at** | **int** | | [optional] 10 | **canceled_reason** | **string** | Reason for cancellation. This field appears when the subscription status is 'canceled'. | [optional] 11 | **card_id** | **string** | | [optional] 12 | **charge_id** | **string** | | [optional] 13 | **created_at** | **int** | | [optional] 14 | **customer_custom_reference** | **string** | | [optional] 15 | **customer_id** | **string** | | [optional] 16 | **id** | **string** | | [optional] 17 | **last_billing_cycle_order_id** | **string** | | [optional] 18 | **object** | **string** | | [optional] 19 | **paused_at** | **int** | | [optional] 20 | **plan_id** | **string** | | [optional] 21 | **status** | **string** | | [optional] 22 | **subscription_start** | **int** | | [optional] 23 | **trial_start** | **int** | | [optional] 24 | **trial_end** | **int** | | [optional] 25 | 26 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 27 | -------------------------------------------------------------------------------- /docs/Model/SubscriptionUpdateRequest.md: -------------------------------------------------------------------------------- 1 | # # SubscriptionUpdateRequest 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **plan_id** | **string** | | [optional] 8 | **card_id** | **string** | | [optional] 9 | **trial_end** | **int** | | [optional] 10 | 11 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 12 | -------------------------------------------------------------------------------- /docs/Model/Token.md: -------------------------------------------------------------------------------- 1 | # # Token 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **card** | [**\Conekta\Model\TokenCard**](TokenCard.md) | | [optional] 8 | **checkout** | [**\Conekta\Model\TokenCheckout**](TokenCheckout.md) | | [optional] 9 | 10 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 11 | -------------------------------------------------------------------------------- /docs/Model/TokenCard.md: -------------------------------------------------------------------------------- 1 | # # TokenCard 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **cvc** | **string** | It is a value that allows identifying the security code of the card. | 8 | **device_fingerprint** | **string** | It is a value that allows identifying the device fingerprint. | [optional] 9 | **exp_month** | **string** | It is a value that allows identifying the expiration month of the card. | 10 | **exp_year** | **string** | It is a value that allows identifying the expiration year of the card. | 11 | **name** | **string** | It is a value that allows identifying the name of the cardholder. | 12 | **number** | **string** | It is a value that allows identifying the number of the card. | 13 | 14 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 15 | -------------------------------------------------------------------------------- /docs/Model/TokenCheckout.md: -------------------------------------------------------------------------------- 1 | # # TokenCheckout 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **returns_control_on** | **string** | It is a value that allows identifying the returns control on. | [optional] 8 | 9 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 10 | -------------------------------------------------------------------------------- /docs/Model/TokenResponse.md: -------------------------------------------------------------------------------- 1 | # # TokenResponse 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **checkout** | [**\Conekta\Model\TokenResponseCheckout**](TokenResponseCheckout.md) | | [optional] 8 | **id** | **string** | Unique identifier for the token generated by Conekta. | 9 | **livemode** | **bool** | Indicates whether the token is in live mode or test mode. | 10 | **object** | **string** | Indicates the type of object, in this case token | 11 | **used** | **bool** | Indicates if the token has been used | 12 | 13 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 14 | -------------------------------------------------------------------------------- /docs/Model/TokenResponseCheckout.md: -------------------------------------------------------------------------------- 1 | # # TokenResponseCheckout 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **allowed_payment_methods** | **string[]** | | [optional] 8 | **can_not_expire** | **bool** | Indicates if the checkout can not expire. | [optional] 9 | **emails_sent** | **int** | | [optional] 10 | **exclude_card_networks** | **string[]** | | [optional] 11 | **expires_at** | **int** | Date and time when the checkout expires. | [optional] 12 | **failure_url** | **string** | URL to redirect the customer to if the payment process fails. | [optional] 13 | **force_3ds_flow** | **bool** | Indicates if the checkout forces the 3DS flow. | [optional] 14 | **id** | **string** | | [optional] 15 | **livemode** | **bool** | | [optional] 16 | **metadata** | **array** | | [optional] 17 | **monthly_installments_enabled** | **bool** | Indicates if the checkout allows monthly installments. | [optional] 18 | **monthly_installments_options** | **int[]** | List of monthly installments options. | [optional] 19 | **name** | **string** | | [optional] 20 | **needs_shipping_contact** | **bool** | | [optional] 21 | **object** | **string** | Indicates the type of object, in this case checkout. | [optional] 22 | **on_demand_enabled** | **bool** | Indicates if the checkout allows on demand payments. | [optional] 23 | **paid_payments_count** | **int** | Number of payments that have been paid. | [optional] 24 | **recurrent** | **bool** | Indicates if the checkout is recurrent. | [optional] 25 | **sms_sent** | **int** | | [optional] 26 | **starts_at** | **int** | Date and time when the checkout starts. | [optional] 27 | **status** | **string** | Status of the checkout. | [optional] 28 | **success_url** | **string** | URL to redirect the customer to after the payment process is completed. | [optional] 29 | **type** | **string** | Type of checkout. | [optional] 30 | 31 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 32 | -------------------------------------------------------------------------------- /docs/Model/TransactionResponse.md: -------------------------------------------------------------------------------- 1 | # # TransactionResponse 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **amount** | **int** | The amount of the transaction. | 8 | **charge** | **string** | Randomly assigned unique order identifier associated with the charge. | 9 | **created_at** | **int** | Date and time of creation of the transaction in Unix format. | 10 | **currency** | **string** | The currency of the transaction. It uses the 3-letter code of the [International Standard ISO 4217.](https://es.wikipedia.org/wiki/ISO_4217) | 11 | **fee** | **int** | The amount to be deducted for taxes and commissions. | 12 | **id** | **string** | Unique identifier of the transaction. | 13 | **livemode** | **bool** | Indicates whether the transaction was created in live mode or test mode. | 14 | **net** | **int** | The net amount after deducting commissions and taxes. | 15 | **object** | **string** | Object name, which is transaction. | 16 | **status** | **string** | Code indicating transaction status. | 17 | **type** | **string** | Transaction Type | 18 | 19 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 20 | -------------------------------------------------------------------------------- /docs/Model/TransferDestinationResponse.md: -------------------------------------------------------------------------------- 1 | # # TransferDestinationResponse 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **account_holder** | **string** | Name of the account holder. | [optional] 8 | **account_number** | **string** | Account number of the bank account. | [optional] 9 | **bank** | **string** | Name of the bank. | [optional] 10 | **created_at** | **int** | Date and time of creation of the transfer. | [optional] 11 | **id** | **string** | Unique identifier of the transfer. | [optional] 12 | **object** | **string** | Object name, which is bank_transfer_payout_method. | [optional] 13 | **payee_id** | **string** | Unique identifier of the payee. | [optional] 14 | **type** | **string** | Type of the payee. | [optional] 15 | 16 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 17 | -------------------------------------------------------------------------------- /docs/Model/TransferMethodResponse.md: -------------------------------------------------------------------------------- 1 | # # TransferMethodResponse 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **account_holder** | **string** | Name of the account holder. | [optional] 8 | **account_number** | **string** | Account number of the bank account. | [optional] 9 | **bank** | **string** | Name of the bank. | [optional] 10 | **created_at** | **int** | Date and time of creation of the transfer. | [optional] 11 | **id** | **string** | Unique identifier of the transfer. | [optional] 12 | **object** | **string** | Object name, which is bank_transfer_payout_method. | [optional] 13 | **payee_id** | **string** | Unique identifier of the payee. | [optional] 14 | **type** | **string** | Type of the payee. | [optional] 15 | 16 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 17 | -------------------------------------------------------------------------------- /docs/Model/TransferResponse.md: -------------------------------------------------------------------------------- 1 | # # TransferResponse 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **amount** | **int** | Amount in cents of the transfer. | [optional] 8 | **created_at** | **int** | Date and time of creation of the transfer in Unix format. | [optional] 9 | **currency** | **string** | The currency of the transfer. It uses the 3-letter code of the [International Standard ISO 4217.](https://es.wikipedia.org/wiki/ISO_4217) | [optional] 10 | **id** | **string** | Unique identifier of the transfer. | [optional] 11 | **livemode** | **bool** | Indicates whether the transfer was created in live mode or test mode. | [optional] 12 | **destination** | [**\Conekta\Model\TransferDestinationResponse**](TransferDestinationResponse.md) | | [optional] 13 | **object** | **string** | Object name, which is transfer. | [optional] 14 | **statement_description** | **string** | Description of the transfer. | [optional] 15 | **statement_reference** | **string** | Reference number of the transfer. | [optional] 16 | **status** | **string** | Code indicating transfer status. | [optional] 17 | 18 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 19 | -------------------------------------------------------------------------------- /docs/Model/TransfersResponse.md: -------------------------------------------------------------------------------- 1 | # # TransfersResponse 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **amount** | **int** | Amount in cents of the transfer. | [optional] 8 | **created_at** | **int** | Date and time of creation of the transfer. | [optional] 9 | **currency** | **string** | The currency of the transfer. It uses the 3-letter code of the [International Standard ISO 4217.](https://es.wikipedia.org/wiki/ISO_4217) | [optional] 10 | **id** | **string** | Unique identifier of the transfer. | [optional] 11 | **livemode** | **bool** | Indicates whether the transfer was created in live mode or test mode. | [optional] 12 | **method** | [**\Conekta\Model\TransferMethodResponse**](TransferMethodResponse.md) | | [optional] 13 | **object** | **string** | Object name, which is transfer. | [optional] 14 | **statement_description** | **string** | Description of the transfer. | [optional] 15 | **statement_reference** | **string** | Reference number of the transfer. | [optional] 16 | **status** | **string** | Code indicating transfer status. | [optional] 17 | 18 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 19 | -------------------------------------------------------------------------------- /docs/Model/UpdateCustomer.md: -------------------------------------------------------------------------------- 1 | # # UpdateCustomer 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **antifraud_info** | [**\Conekta\Model\UpdateCustomerAntifraudInfo**](UpdateCustomerAntifraudInfo.md) | | [optional] 8 | **date_of_birth** | **string** | It is a parameter that allows to identify the date of birth of the client. | [optional] 9 | **default_payment_source_id** | **string** | It is a parameter that allows to identify in the response, the Conekta ID of a payment method (payment_id) | [optional] 10 | **email** | **string** | An email address is a series of customizable characters followed by a universal Internet symbol, the at symbol (@), the name of a host server, and a web domain ending (.mx, .com, .org, . net, etc). | [optional] 11 | **name** | **string** | Client's name | [optional] 12 | **phone** | **string** | Is the customer's phone number | [optional] 13 | **plan_id** | **string** | Contains the ID of a plan, which could together with name, email and phone create a client directly to a subscription | [optional] 14 | **default_shipping_contact_id** | **string** | It is a parameter that allows to identify in the response, the Conekta ID of the shipping address (shipping_contact) | [optional] 15 | **corporate** | **bool** | It is a value that allows identifying if the email is corporate or not. | [optional] [default to false] 16 | **custom_reference** | **string** | It is an undefined value. | [optional] 17 | **fiscal_entities** | [**\Conekta\Model\CustomerFiscalEntitiesRequest[]**](CustomerFiscalEntitiesRequest.md) | | [optional] 18 | **metadata** | **array** | | [optional] 19 | **national_id** | **string** | It is a parameter that allows to identify the national identification number of the client. | [optional] 20 | **payment_sources** | [**\Conekta\Model\CustomerPaymentMethodsRequest[]**](CustomerPaymentMethodsRequest.md) | Contains details of the payment methods that the customer has active or has used in Conekta | [optional] 21 | **shipping_contacts** | [**\Conekta\Model\CustomerShippingContacts[]**](CustomerShippingContacts.md) | Contains the detail of the shipping addresses that the client has active or has used in Conekta | [optional] 22 | **subscription** | [**\Conekta\Model\SubscriptionRequest**](SubscriptionRequest.md) | | [optional] 23 | 24 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 25 | -------------------------------------------------------------------------------- /docs/Model/UpdateCustomerAntifraudInfo.md: -------------------------------------------------------------------------------- 1 | # # UpdateCustomerAntifraudInfo 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **account_created_at** | **int** | | [optional] 8 | **first_paid_at** | **int** | | [optional] 9 | 10 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 11 | -------------------------------------------------------------------------------- /docs/Model/UpdateCustomerFiscalEntitiesResponse.md: -------------------------------------------------------------------------------- 1 | # # UpdateCustomerFiscalEntitiesResponse 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **address** | [**\Conekta\Model\CustomerAddress**](CustomerAddress.md) | | 8 | **tax_id** | **string** | | [optional] 9 | **email** | **string** | | [optional] 10 | **phone** | **string** | | [optional] 11 | **metadata** | **array** | | [optional] 12 | **company_name** | **string** | | [optional] 13 | **id** | **string** | | 14 | **object** | **string** | | 15 | **created_at** | **int** | | 16 | **parent_id** | **string** | | [optional] 17 | **default** | **bool** | | [optional] 18 | 19 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 20 | -------------------------------------------------------------------------------- /docs/Model/UpdateCustomerPaymentMethodsResponse.md: -------------------------------------------------------------------------------- 1 | # # UpdateCustomerPaymentMethodsResponse 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **type** | **string** | | 8 | **id** | **string** | | 9 | **object** | **string** | | 10 | **created_at** | **int** | | 11 | **parent_id** | **string** | | [optional] 12 | **agreements** | [**\Conekta\Model\PaymentMethodCashResponseAllOfAgreements[]**](PaymentMethodCashResponseAllOfAgreements.md) | | [optional] 13 | **reference** | **string** | | [optional] 14 | **barcode** | **string** | | [optional] 15 | **barcode_url** | **string** | URL to the barcode image, reference is the same as barcode | [optional] 16 | **expires_at** | **string** | | [optional] 17 | **provider** | **string** | | [optional] 18 | **last4** | **string** | | [optional] 19 | **bin** | **string** | | [optional] 20 | **card_type** | **string** | | [optional] 21 | **exp_month** | **string** | | [optional] 22 | **exp_year** | **string** | | [optional] 23 | **brand** | **string** | | [optional] 24 | **name** | **string** | | [optional] 25 | **default** | **bool** | | [optional] 26 | **visible_on_checkout** | **bool** | | [optional] 27 | **payment_source_status** | **string** | | [optional] 28 | 29 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 30 | -------------------------------------------------------------------------------- /docs/Model/UpdateOrderDiscountLinesRequest.md: -------------------------------------------------------------------------------- 1 | # # UpdateOrderDiscountLinesRequest 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **amount** | **int** | | [optional] 8 | **code** | **string** | Discount code. | [optional] 9 | **type** | **string** | | [optional] 10 | 11 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 12 | -------------------------------------------------------------------------------- /docs/Model/UpdateOrderTaxRequest.md: -------------------------------------------------------------------------------- 1 | # # UpdateOrderTaxRequest 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **amount** | **int** | The amount to be collected for tax in cents | [optional] 8 | **description** | **string** | description or tax's name | [optional] 9 | **metadata** | **array** | | [optional] 10 | 11 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 12 | -------------------------------------------------------------------------------- /docs/Model/UpdateOrderTaxResponse.md: -------------------------------------------------------------------------------- 1 | # # UpdateOrderTaxResponse 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **amount** | **int** | The amount to be collected for tax in cents | 8 | **description** | **string** | description or tax's name | 9 | **metadata** | **array** | | [optional] 10 | **id** | **string** | | 11 | **object** | **string** | | [optional] 12 | **parent_id** | **string** | | [optional] 13 | 14 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 15 | -------------------------------------------------------------------------------- /docs/Model/UpdatePaymentMethods.md: -------------------------------------------------------------------------------- 1 | # # UpdatePaymentMethods 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **name** | **string** | | [optional] 8 | 9 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 10 | -------------------------------------------------------------------------------- /docs/Model/UpdateProduct.md: -------------------------------------------------------------------------------- 1 | # # UpdateProduct 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **antifraud_info** | **array** | | [optional] 8 | **description** | **string** | | [optional] 9 | **sku** | **string** | | [optional] 10 | **name** | **string** | | [optional] 11 | **unit_price** | **int** | | [optional] 12 | **quantity** | **int** | | [optional] 13 | **tags** | **string[]** | | [optional] 14 | **brand** | **string** | | [optional] 15 | **metadata** | **array** | | [optional] 16 | 17 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 18 | -------------------------------------------------------------------------------- /docs/Model/WebhookKeyCreateResponse.md: -------------------------------------------------------------------------------- 1 | # # WebhookKeyCreateResponse 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **active** | **bool** | Indicates if the webhook key is active | [optional] 8 | **created_at** | **int** | Unix timestamp in seconds with the creation date of the webhook key | [optional] 9 | **id** | **string** | Unique identifier of the webhook key | [optional] 10 | **livemode** | **bool** | Indicates if the webhook key is in live mode | [optional] 11 | **object** | **string** | Object name, value is webhook_key | [optional] 12 | **public_key** | **string** | Public key to be used in the webhook | [optional] 13 | 14 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 15 | -------------------------------------------------------------------------------- /docs/Model/WebhookKeyDeleteResponse.md: -------------------------------------------------------------------------------- 1 | # # WebhookKeyDeleteResponse 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **active** | **bool** | Indicates if the webhook key is active | [optional] 8 | **created_at** | **int** | Unix timestamp in seconds with the creation date of the webhook key | [optional] 9 | **deleted** | **bool** | Indicates if the webhook key is deleted | [optional] 10 | **id** | **string** | Unique identifier of the webhook key | [optional] 11 | **livemode** | **bool** | Indicates if the webhook key is in live mode | [optional] 12 | **object** | **string** | Object name, value is webhook_key | [optional] 13 | 14 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 15 | -------------------------------------------------------------------------------- /docs/Model/WebhookKeyRequest.md: -------------------------------------------------------------------------------- 1 | # # WebhookKeyRequest 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **active** | **bool** | Indicates if the webhook key is active | [optional] [default to true] 8 | 9 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 10 | -------------------------------------------------------------------------------- /docs/Model/WebhookKeyResponse.md: -------------------------------------------------------------------------------- 1 | # # WebhookKeyResponse 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **id** | **string** | Unique identifier of the webhook key | [optional] 8 | **active** | **bool** | Indicates if the webhook key is active | [optional] 9 | **created_at** | **int** | Unix timestamp in seconds with the creation date of the webhook key | [optional] 10 | **deactivated_at** | **int** | Unix timestamp in seconds with the deactivation date of the webhook key | [optional] 11 | **public_key** | **string** | Public key to be used in the webhook | [optional] 12 | **livemode** | **bool** | Indicates if the webhook key is in live mode | [optional] 13 | **object** | **string** | Object name, value is webhook_key | [optional] 14 | 15 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 16 | -------------------------------------------------------------------------------- /docs/Model/WebhookKeyUpdateRequest.md: -------------------------------------------------------------------------------- 1 | # # WebhookKeyUpdateRequest 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **active** | **bool** | Indicates if the webhook key is active | [optional] [default to false] 8 | 9 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 10 | -------------------------------------------------------------------------------- /docs/Model/WebhookLog.md: -------------------------------------------------------------------------------- 1 | # # WebhookLog 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **failed_attempts** | **int** | | [optional] 8 | **id** | **string** | | [optional] 9 | **last_attempted_at** | **int** | | [optional] 10 | **last_http_response_status** | **int** | | [optional] 11 | **object** | **string** | | [optional] 12 | **response_data** | **array** | | [optional] 13 | **url** | **string** | | [optional] 14 | 15 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 16 | -------------------------------------------------------------------------------- /docs/Model/WebhookRequest.md: -------------------------------------------------------------------------------- 1 | # # WebhookRequest 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **url** | **string** | Here you must place the URL of your Webhook remember that you must program what you will do with the events received. Also do not forget to handle the HTTPS protocol for greater security. | 8 | **subscribed_events** | **string[]** | events that will be sent to the webhook | [optional] 9 | 10 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 11 | -------------------------------------------------------------------------------- /docs/Model/WebhookResponse.md: -------------------------------------------------------------------------------- 1 | # # WebhookResponse 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **id** | **string** | id of the webhook | [optional] 8 | **description** | **string** | A name or brief explanation of what this webhook is used for | [optional] 9 | **livemode** | **bool** | Indicates if the webhook is in production | [optional] 10 | **active** | **bool** | Indicates if the webhook is actived or not | [optional] 11 | **object** | **string** | Object name, value is 'webhook' | [optional] 12 | **status** | **string** | Indicates if the webhook is ready to receive events or failing | [optional] 13 | **subscribed_events** | **string[]** | lists the events that will be sent to the webhook | [optional] 14 | **url** | **string** | url or endpoint of the webhook | [optional] 15 | 16 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 17 | -------------------------------------------------------------------------------- /docs/Model/WebhookUpdateRequest.md: -------------------------------------------------------------------------------- 1 | # # WebhookUpdateRequest 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **url** | **string** | Here you must place the URL of your Webhook remember that you must program what you will do with the events received. Also do not forget to handle the HTTPS protocol for greater security. | [optional] 8 | **subscribed_events** | **string[]** | events that will be sent to the webhook | [optional] 9 | **active** | **bool** | whether the webhook is active or not | [optional] 10 | 11 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 12 | -------------------------------------------------------------------------------- /docs/Model/WhitelistlistRuleResponse.md: -------------------------------------------------------------------------------- 1 | # # WhitelistlistRuleResponse 2 | 3 | ## Properties 4 | 5 | Name | Type | Description | Notes 6 | ------------ | ------------- | ------------- | ------------- 7 | **id** | **string** | Whitelist rule id | [optional] 8 | **field** | **string** | field used for whitelists rule | [optional] 9 | **value** | **string** | value used for whitelists rule | [optional] 10 | **description** | **string** | use an description for whitelisted rule | [optional] 11 | 12 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 13 | -------------------------------------------------------------------------------- /examples/direct_api/cargo_unico.php: -------------------------------------------------------------------------------- 1 | setAccessToken(getenv("CONEKTA_API_KEY")); 8 | $apiInstance = new OrdersApi(null, $config); 9 | 10 | 11 | $rq = new OrderRequest([ 12 | 'line_items' => [ 13 | [ 14 | 'name' => 'Nombre del Producto o Servicio', 15 | 'unit_price' => 23000, 16 | 'quantity' => 1 17 | ] 18 | ], 19 | 'currency' => 'MXN', 20 | 'customer_info' => [ 21 | 'name' => 'Jorge Martinez', 22 | 'email' => 'jorge.martinez@conekta.com', 23 | 'phone' => '+5218181818181' 24 | ], 25 | 'metadata' => [ 26 | 'datos_extra' => '12334' 27 | ], 28 | 'charges' => [ 29 | [ 30 | 'payment_method' => [ 31 | 'type' => 'card', 32 | 'number' => '4242424242424242', 33 | 'name' => 'Jorge Martinez', 34 | 'exp_month' => '12', 35 | 'exp_year' => '2025', 36 | 'cvc' => '198' 37 | ] 38 | ] 39 | ] 40 | ]); 41 | 42 | try { 43 | $result = $apiInstance->createOrder($rq); 44 | $json_string = json_encode($result, JSON_PRETTY_PRINT); 45 | print_r($json_string); 46 | } catch (Exception $e) { 47 | echo 'Exception when calling OrdersApi->createOrder: ', $e->getMessage(), PHP_EOL; 48 | 49 | } 50 | -------------------------------------------------------------------------------- /examples/direct_api/create_customer.php: -------------------------------------------------------------------------------- 1 | setAccessToken($apiKey); 11 | 12 | $apiInstance = new CustomersApi(null, $config); 13 | $rq = new Customer([ 14 | 'name' => 'Franklin carrero', 15 | 'email'=> 'mm@gmail.com', 16 | 'phone' => '+5218181818181' 17 | ]); 18 | try { 19 | $result = $apiInstance->createCustomer($rq); 20 | $json_string = json_encode($result, JSON_PRETTY_PRINT); 21 | print_r($json_string); 22 | echo $result ->getLivemode(); 23 | echo $result ->getName(); 24 | echo $result ->getEmail(); 25 | echo $result ->getId(); 26 | echo $result ->getObject(); 27 | } catch (ApiException $e) { 28 | echo 'Exception when calling CustomersApi->createCustomer: ', $e->getMessage(), PHP_EOL; 29 | } 30 | -------------------------------------------------------------------------------- /examples/direct_api/find_an_order_by_id.php: -------------------------------------------------------------------------------- 1 | setAccessToken(getenv("CONEKTA_API_KEY")); 8 | $apiInstance = new OrdersApi(null, $config); 9 | 10 | try { 11 | $result= $apiInstance->getOrderById('ord_2wxU5rd1J6po8TqVe'); 12 | $json_string = json_encode($result, JSON_PRETTY_PRINT); 13 | print_r($json_string); 14 | print_r($result->getPaymentStatus()); 15 | 16 | } catch (ApiException $e) { 17 | echo 'Exception when calling OrdersApi->getOrderById: ', $e->getMessage(), PHP_EOL; 18 | } 19 | -------------------------------------------------------------------------------- /examples/direct_api/redirect_checkout.php: -------------------------------------------------------------------------------- 1 | setAccessToken($apiKey); 11 | 12 | 13 | $apiInstance = new OrdersApi(null, $config); 14 | $accept_language = 'es'; 15 | $rq = new OrderRequest([ 16 | 'currency' => 'MXN', 17 | 'customer_info' => [ 18 | 'name' => 'fran carrero', 19 | 'email'=> 'framk@gmail.com', 20 | 'phone' => '+5218181818181' 21 | ], 22 | 'line_items' => [ 23 | [ 24 | 'name' => 'Box of Cohiba S1s', 25 | 'unit_price' => 35000, 26 | 'quantity' => 1 27 | ] 28 | ], 29 | 'shipping_lines' => [ 30 | [ 31 | 'amount' => 1500, 32 | 'carrier' => 'FEDEX' 33 | ] 34 | ], 35 | 'checkout' => [ 36 | 'allowed_payment_methods' => [ 37 | 'bank_transfer', 38 | 'card', 39 | 'cash' 40 | ], 41 | 'monthly_installments_enabled' => true, 42 | 'type' => 'HostedPayment', 43 | 'success_url' => 'https://www.example.com/success', 44 | 'failure_url' => 'https://www.example.com/failure', 45 | 'monthly_installments_options' => [3, 6, 12], 46 | 'redirection_time' => 4 //Redirect time to Success-Failure URL, thresholds 4 to 120 sec. 47 | ], 48 | 'shipping_contact' =>[ 49 | 'phone' => '+5218181818181', 50 | 'receiver' => 'Marvin Fuller', 51 | 'address' => [ 52 | 'street1' => '250 Alexis St', 53 | 'city' => 'Red Deer', 54 | 'state' => 'Alberta', 55 | 'country' => 'CA', 56 | 'postal_code' => '01000' 57 | ] 58 | ] 59 | ]); 60 | try { 61 | $result = $apiInstance->createOrder($rq, $accept_language); 62 | $json_string = json_encode($result, JSON_PRETTY_PRINT); 63 | print_r($json_string); 64 | 65 | echo $result ->getCheckout()->getUrl(); 66 | 67 | } catch (ApiException $e) { 68 | echo 'Exception when calling OrdersApi->createOrder: ', $e->getMessage(), PHP_EOL; 69 | 70 | } 71 | -------------------------------------------------------------------------------- /gitleaks.toml: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/conekta/conekta-php/852b14307e97f97d56030daf83efbcc80bb9ec30/gitleaks.toml -------------------------------------------------------------------------------- /lib/Model/EventTypes.php: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | ./lib/Api 6 | 7 | 8 | 9 | 10 | ./test/Api 11 | 12 | 13 | 14 | 15 | 16 | -------------------------------------------------------------------------------- /templates/php/VERSION.mustache: -------------------------------------------------------------------------------- 1 | {{artifactVersion}} 2 | -------------------------------------------------------------------------------- /templates/php/composer.mustache: -------------------------------------------------------------------------------- 1 | { 2 | {{#composerPackageName}} 3 | "name": "{{.}}", 4 | {{/composerPackageName}} 5 | {{#artifactVersion}} 6 | "version": "{{.}}", 7 | {{/artifactVersion}} 8 | "description": "{{appDescriptionV2}}", 9 | "type": "library", 10 | "keywords": [ 11 | "php", 12 | "sdk", 13 | "rest", 14 | "api", 15 | "conekta" 16 | ], 17 | "homepage": "https://www.conekta.com/", 18 | "license": "MIT", 19 | "authors": [ 20 | { 21 | "name": "{{{packageAuthors}}}", 22 | "homepage": "https://{{{gitHost}}}/{{{gitUserId}}}/{{{gitRepoId}}}/contributors" 23 | } 24 | ], 25 | "require": { 26 | "php": "^7.4 || ^8.0", 27 | "ext-curl": "*", 28 | "ext-json": "*", 29 | "ext-mbstring": "*", 30 | "guzzlehttp/guzzle": "^7.3", 31 | "guzzlehttp/psr7": "^1.7 || ^2.0" 32 | }, 33 | "require-dev": { 34 | "phpunit/phpunit": "^9.0 || ^10.0", 35 | "friendsofphp/php-cs-fixer": "^3.5", 36 | "phpstan/phpstan": "2.0.1" 37 | }, 38 | "autoload": { 39 | "psr-4": { "{{escapedInvokerPackage}}\\" : "{{srcBasePath}}/" } 40 | }, 41 | "autoload-dev": { 42 | "psr-4": { "{{escapedInvokerPackage}}\\Test\\" : "{{testBasePath}}/" } 43 | } 44 | } 45 | -------------------------------------------------------------------------------- /templates/php/gitignore: -------------------------------------------------------------------------------- 1 | # Ignore build files 2 | build/* 3 | 4 | # Mac OS X dumps these all over the place. 5 | .DS_Store 6 | 7 | # Ignore the SimpleTest library if it is installed to /test/. 8 | /test/simpletest/ 9 | 10 | # Ignore the /vendor/ directory for people using composer 11 | /vendor/ 12 | 13 | # If the vendor directory isn't being commited the composer.lock file should also be ignored 14 | composer.lock 15 | 16 | # Ignore PHPUnit coverage file 17 | clover.xml 18 | 19 | # Ignore IDE's configuration files 20 | .idea 21 | 22 | # Ignore PHP CS Fixer local config and cache 23 | .php_cs 24 | .php_cs.cache 25 | .php-cs-fixer.cache 26 | 27 | # Ignore PHPStan local config 28 | .phpstan.neon 29 | 30 | # Ignore phpDocumentor's local config and artifacts 31 | .phpdoc/* 32 | phpdoc.xml 33 | 34 | # Ignore cached PHPUnit results. 35 | .phpunit.result.cache 36 | -------------------------------------------------------------------------------- /templates/php/phpunit.xml.mustache: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | {{apiSrcPath}} 6 | 7 | 8 | 9 | 10 | {{apiTestPath}} 11 | 12 | 13 | 14 | 15 | 16 | -------------------------------------------------------------------------------- /test/Api/BalancesApiTest.php: -------------------------------------------------------------------------------- 1 |