# Ecart Pay Documentation > We are a technology company with an international presence. Since our launch in 2022, we have been committed to developing innovative solutions that simplify the processing and management of online transactions. We aim to provide a secure and efficient solution for businesses of all sizes and industries, from SaaS providers and ecommerce stores to small enterprises. Our goal is to ehnance the payment experience for both businesses and their customers. ## Guides - [Ecart Pay API Developer Documentation | Payment Processing, Subscriptions & Card Issuing](https://docs.ecartpay.com/docs/all-about-ecart-pay.md): Developer Documentation and [API Reference](https://docs.ecartpay.com/reference/getting-started#/) for Ecart Pay. Fast integration with robust fintech security. - [API Keys](https://docs.ecartpay.com/docs/api-keys.md): Start making API calls from both Production and Sandbox Environments. - [Production API Keys ](https://docs.ecartpay.com/docs/api-keys-production.md): To make API calls in the production environment, you need the corresponding keys. - [Sandbox API Keys](https://docs.ecartpay.com/docs/api-keys-sandbox.md): In order to be able to make API calls for a Testing (Sandbox) Environment, it is necessary to have the corresponding Keys. - [Authorization Token](https://docs.ecartpay.com/docs/authorization-token.md): To interact with the Ecart Pay API, you must generate an authorization token. This token is required to authenticate your requests and ensure secure communication with the platform. - [Payments (Payins)](https://docs.ecartpay.com/docs/payins.md): Start receiving payments from your customers fast and simple! - [Orders](https://docs.ecartpay.com/docs/orders.md): Orders are a fundamental component in the payment process, enabling businesses to structure, track, and manage transactions effectively. - [Updates](https://docs.ecartpay.com/docs/updates.md): Keeping your order information up to date is essential to ensure smooth transactions and an optimal customer experience. Ecart Pay provides the flexibility to modify specific details of an order using its API capabilities. - [Transfers](https://docs.ecartpay.com/docs/transfers.md): Bank transfers in Ecart Pay are a versatile and efficient method for managing payments. This feature allows users to create orders that can be paid using a bank transfer, simplifying the process of exchanging money. - [Refunds](https://docs.ecartpay.com/docs/refunds.md): Ecart Pay provides an efficient and seamless way to process refunds directly to the payment method initially used by the customer. - [Payment Links](https://docs.ecartpay.com/docs/payment-links.md): Ecart Pay allows users to create and share secure payment links that serve as an additional payment method. These links offer flexibility and are easily shared through various communication channels. - [Retrieving Payment Links](https://docs.ecartpay.com/docs/retrieving-payment-link-templates.md): When working with payment links in Ecart Pay, you have two primary options for accessing them via API: retrieving all saved links or searching for a specific link. These options allow for efficient management of payment links, whether you want to review your entire inventory or find a particular one. - [Managing Payment Links](https://docs.ecartpay.com/docs/manage-payment-links.md): Ecart Pay allows you to update or delete existing payment link templates through its API. This functionality is essential for modifying details like the shipping address, items, or other configurations without creating a new link from scratch. - [Checkouts](https://docs.ecartpay.com/docs/checkout.md): Ecart Pay simplifies the payment process by providing tools to create custom checkouts, enabling businesses to offer personalized and seamless transaction experiences. This feature enhances the user journey while catering to diverse financial preferences and needs. - [Advanced Operations with Checkouts](https://docs.ecartpay.com/docs/advanced-operations-with-checkouts.md): Ecart Pay provides advanced features for managing checkouts, including the ability to update checkout details, modify items within a checkout, and retrieve checkout information. These functionalities ensure businesses can adapt to changing customer needs and provide seamless payment experiences. - [Charges (Payouts)](https://docs.ecartpay.com/docs/payouts.md): Payouts in Ecart Pay refer to the functionality of transferring money to other users within the Ecart Pay network. - [Confirmations](https://docs.ecartpay.com/docs/confirmations.md): By requiring confirmation, payouts can be either instantly credited or set to be released at a future date. - [Payout Updates](https://docs.ecartpay.com/docs/updates-1.md): The ability to update payout details is a crucial feature in Ecart Pay’s API, offering unmatched flexibility to businesses and users. - [Summaries](https://docs.ecartpay.com/docs/summaries.md): Ecart Pay provides an intuitive API for managing transactions, enabling businesses to access detailed summaries, all transactions, or individual transaction records. This system ensures precise tracking, reconciliation, and insights into the financial activities of an account. - [Token-based pagination example](https://docs.ecartpay.com/docs/token-based-pagination-example.md): This guide demonstrates a practical example of navigating through transaction results using token-based pagination. You'll learn how to retrieve the initial page, move forward to the next page, and navigate backward to the previous page. - [Billings](https://docs.ecartpay.com/docs/billings.md): Ecart Pay simplifies business invoicing by providing an integrated solution for creating, managing, and downloading electronic invoices while complying with international tax regulations. - [Billings Management](https://docs.ecartpay.com/docs/billings-management.md): Use the endpoints below to create invoices and consult billings-related information. - [Billing Providers](https://docs.ecartpay.com/docs/billing-providers.md): A billing provider is an online service that enables businesses to create, issue, and manage official digital invoices. It ensures these electronic documents are valid, legally compliant, and correctly reported to tax authorities. - [CFDI Electronic Invoice](https://docs.ecartpay.com/docs/cfdi-electronic-invoice.md) - [Verifacti Integration](https://docs.ecartpay.com/docs/verifacti-integration.md): Seamless connection to the Spanish AEAT Tax Agency. - [Billings Management](https://docs.ecartpay.com/docs/verifacti-billings-management.md) - [NIFs Management](https://docs.ecartpay.com/docs/nifs-management.md): Use this guide to learn more about NIF management with the Verifacti API integration, including AEAT and VIES validations. - [Subscriptions](https://docs.ecartpay.com/docs/subscriptions.md): Ecart Pay’s Subscriptions API allows you to create and manage recurring payments for your users. - [Subscription Templates](https://docs.ecartpay.com/docs/subscription-templates.md) - [Subscriptions Management](https://docs.ecartpay.com/docs/subscriptions-management.md) - [Merchant Management for Subscriptions](https://docs.ecartpay.com/docs/merchant-management-for-subscriptions.md): Merchant Management is a feature that allows you to delegate subscription lifecycle control to your own systems while EcartPay handles payment processing and checkout. When enabled, you receive invitation links directly in API responses and manage customer communications yourself, rather than relying on EcartPay's automated notifications. - [Implementation Example](https://docs.ecartpay.com/docs/implementation-example.md): Let's walk through a complete example of implementing a monthly subscription for a "Premium Plan" at $29.99/month: - [Subscriptions With Pricing Models](https://docs.ecartpay.com/docs/advanced-subscriptions.md): Create catalog-backed plans with usage billing, volume tiers, and usage records via API. - [Direct Debits](https://docs.ecartpay.com/docs/direct-debits.md) - [Lifecycle status & Workflows](https://docs.ecartpay.com/docs/lifecycle-status-and-workflows.md): Understanding the Direct Debit lifecycle is essential for managing automated payments effectively. This page details the various states a debit can inhabit and the automated workflows—from creation to final completion—that drive the payment engine. - [Customer CLABE Management](https://docs.ecartpay.com/docs/customer-clabe-management.md): Overview of CLABE registration, validation endpoints and the Bank codes catalog. This subpage details the lifecycle of a customer bank account record, from initial creation and bank association to the final verification step required for active Direct Debits. Direct debits are tightly coupled with payment methods of type **CLABE**. The payment method stores the 18-digit CLABE, validation status, and KYC verification state. - [Direct Debit Management](https://docs.ecartpay.com/docs/direct-debit-management.md): Direct Debit endpoints allow you to manage the full lifecycle of payment authorizations, from creation to activation and status management. - [Billing Cycles & Use Cases](https://docs.ecartpay.com/docs/billing-cycles-and-use-cases.md): Overview of recurrence logic and practical use cases. Review the supported billing intervals and the specific data structures required to automate your customer's payment schedule across daily, weekly, monthly, or yearly cycles. - [Security](https://docs.ecartpay.com/docs/notifications-and-security.md): Overview of the security guardrails. Review email lifecycle events, token expiration rules, and mandatory authorization scopes to ensure your integration meets Ecart Pay's safety standards. - [Best Practices & Troubleshooting](https://docs.ecartpay.com/docs/best-practices-troubleshooting.md): Ensure a reliable integration by following our recommended patterns for date handling, state management, and security. This guide outlines the golden rules for managing the Direct Debit lifecycle and provides solutions for common implementation errors. - [Accounts](https://docs.ecartpay.com/docs/accounts.md): The Ecart Pay API offers a versatile set of tools designed to streamline and enhance your financial operations. - [Payment Methods](https://docs.ecartpay.com/docs/payment-method.md): Adding a payment method to your Ecart Pay account allows you to manage withdrawals effectively. You can set up a debit card or a bank account using a CLABE number. - [Account Gateway Keys](https://docs.ecartpay.com/docs/account-gateway-keys.md): By integrating these keys, users can unlock the functionality of payment gateways previously detailed, ensuring smooth financial operations. - [Billing Information](https://docs.ecartpay.com/docs/billing-information.md): This resource allows access to and management of tax-related data associated with an account, facilitating invoicing processes and regulatory compliance. - [Withdrawals](https://docs.ecartpay.com/docs/withdrawals.md): Ecart Pay offers for managing withdrawal accounts and tracking withdrawal histories, enabling you to have complete control over your financial processes. - [Customers](https://docs.ecartpay.com/docs/customers-1.md): Ecart Pay offers a comprehensive system to manage customer records, enabling businesses to store, track, and utilize customer information effectively. This system includes features such as transaction history, customer details, and the generation of interbank CLABE accounts. - [Customer Cards](https://docs.ecartpay.com/docs/customer-cards.md): Ecart Pay enables businesses to create, manage, and retrieve customer cards efficiently. This system provides flexibility in handling multiple cards per customer, setting default cards, and ensuring smooth payment operations. - [Tokenized Card](https://docs.ecartpay.com/docs/tokenized-card.md): This endpoint creates a Tokenized Card. Useful to configure specific orders through your backend with options like Interest-free and Fixed Installments. - [Customer Authentication and Payment Methods](https://docs.ecartpay.com/docs/customer-authentication-and-payment-methods.md): Ecart Pay offers robust tools for managing customer authentication and payment methods. This guide explains how to generate unique customer tokens and assign versatile payment methods, enhancing the transactional flexibility and security of the platform. - [Cards](https://docs.ecartpay.com/docs/cards.md): Ecart Pay enables users to securely store card information in a PCI-compliant environment, ensuring data protection and transaction security. - [Catalogs](https://docs.ecartpay.com/docs/catalogs.md): Ecart Pay offers various catalogs that facilitate the creation of dynamic dropdowns and improve user experience. - [Banks](https://docs.ecartpay.com/docs/banks.md): Ecart Pay offers a comprehensive list of banks for conducting payouts and financial transactions. - [Exchanges](https://docs.ecartpay.com/docs/exchanges.md): Ecart Pay offers comprehensive currency exchange tools, enabling businesses to transact in multiple currencies seamlessly. - [User Information and CLABE](https://docs.ecartpay.com/docs/user-information.md): This documentation page contains relevant information about the data associated to each merchant within Ecart Pay, specially the CLABE Interbank Code.. - [Unique Transaction CLABE Backend Integration](https://docs.ecartpay.com/docs/unique-transaction-clabe-integration.md): This section explains how the unique transaction CLABE interbank code is generated in a workflow and how to consult it via API. - [Unique Customer CLABE](https://docs.ecartpay.com/docs/unique-customer-clabe.md): As a merchant, it is possible to assign a unique CLABE for a customer to make transfers to you. - [Backend Integration](https://docs.ecartpay.com/docs/backend-integration.md): The integration flow between the frontend application, the backend of the application, and the EcartPay service is outlined below. - [Chargebacks](https://docs.ecartpay.com/docs/chargebacks.md): Ecart Pay facilitates the chargeback process by serving as an intermediary between merchants and card issuers, ensuring a structured resolution. This entry details the chargeback process, its types, the required documentation, and how Ecart Pay supports merchants in managing disputes efficiently. - [Payment Gateways](https://docs.ecartpay.com/docs/payment-gateways.md): By integrating Ecart Pay, you can manage multiple gateways and configure them to suit your operational needs. This guide will introduce you to the concept of payment gateways, outline how Ecart Pay simplifies the process of receiving payments, and provide a comprehensive list of available gateways for your use. - [E-commerce ](https://docs.ecartpay.com/docs/e-commerce.md): Ecart Pay offers integrations with various e-commerce platforms. These integrations allow businesses to streamline payment processing and manage transaction histories efficiently, whether as a general overview, a detailed list, or individual transactions. - [Woocomerce](https://docs.ecartpay.com/docs/woocomerce.md): This guide provides a step-by-step process to integrate your Woocommerce store with Ecart Pay, enabling seamless payment processing. Follow the steps below to complete the setup and ensure smooth transactions. - [PrestaShop](https://docs.ecartpay.com/docs/prestashop.md): This guide provides a step-by-step process to integrate your PerstaShop store with Ecart Pay, enabling seamless payment processing. Follow the steps below to complete the setup and ensure smooth transactions. - [VTEX](https://docs.ecartpay.com/docs/vtex-nuevo.md): This guide provides a step-by-step process to integrate your VTEX store with Ecart Pay, enabling seamless payment processing. Follow the steps below to complete the setup and ensure smooth transactions. - [Shopify](https://docs.ecartpay.com/docs/shopify.md): This guide provides a step-by-step process to integrate your Shopify store with Ecart Pay, enabling seamless payment processing. Follow the steps below to complete the setup and ensure smooth transactions. - [tiendanube](https://docs.ecartpay.com/docs/tiendanube.md): This guide provides a step-by-step process to integrate your tiendanube store with Ecart Pay, enabling seamless payment processing. Follow the steps below to complete the setup and ensure smooth transactions. - [Point of Sales Integration](https://docs.ecartpay.com/docs/point-of-sales-integration.md) - [Branch Management](https://docs.ecartpay.com/docs/branch-management.md): Branches represent your physical store locations. Each branch serves as a container for multiple sales registers and POS terminals. - [Sales Register Management](https://docs.ecartpay.com/docs/sales-register-management.md): Sales registers are specific cash register stations within a branch. For a terminal to process POS transactions, it must be linked to an active Sales Register. - [Terminal POS Management](https://docs.ecartpay.com/docs/terminal-pos-management.md): These endpoints allow you to toggle the operating mode of your hardware terminals between "Standalone" and "Point of Sale" modes. - [Status Values & Error Reference](https://docs.ecartpay.com/docs/status-values-error-reference.md) - [3D Secure (3DS) Payment Flow](https://docs.ecartpay.com/docs/3d-secure-3ds-payment-flow.md): This guide explains how to integrate the **3D Secure (3DS)** redirect-based authentication flow using Ecart Pay. The goal is to authenticate the cardholder (when required) and then process the payment, returning the user to your application via a controlled redirect. - [SDK JS - Es Module](https://docs.ecartpay.com/docs/sdks.md): The EcartPay SDK v2 provides a complete interface for integrating payments into your web application. This documentation will guide you through installation, configuration, and usage of all available features. - [OAuth Ecart Pay](https://docs.ecartpay.com/docs/oauth-ecart-pay.md): Connect your platform to Ecart Pay using OAuth 2.0 (Authorization Code flow). This lets your merchants link their Ecart Pay account to your product so you can operate on their behalf — read their API credentials, create orders, and more. - [WhatsApp Business](https://docs.ecartpay.com/docs/whatsapp-business.md) - [Interest-free and Fixed Installments](https://docs.ecartpay.com/docs/interest-free-and-fixed-installments.md): The Interest-Free Months and Fixed Installments payment system allows merchants to offer their customers the ability to pay in installments with two distinct models. - [Setting up Interest-free and Fixed Installments](https://docs.ecartpay.com/docs/setting-up-interest-free-and-fixed-installments.md): Provide your customers with flexible payment options with Ecart Pay! - [Create or Update Custom Interest-free/Fixed installments Configuration](https://docs.ecartpay.com/docs/createupdate-custom-interest-freefixed-installments-configuration.md): Creates or updates custom Interest-free/Fixed installments configuration for an account. - [Turn on/off interest-free and fixed installment configurations](https://docs.ecartpay.com/docs/turn-on-off-interest-free-and-deferred-payment-options.md): Merchants can turn on/off this option using Ecart Pay user interface and also through API Calls. - [Interest-free/Fixed installments configuration](https://docs.ecartpay.com/docs/get-installments-freefixed-installments-configuration.md): Retrieve the current MSI configuration for an account, merging default and custom settings. - [Webhooks in Ecart Pay](https://docs.ecartpay.com/docs/webhooks-in-ecart-pay.md) - [Webhook Events](https://docs.ecartpay.com/docs/webhook-events.md): Webhook Events are automated HTTP notifications sent from one application (the sender) to another (the receiver) when a specific event occurs. They enable real-time communication and data synchronization between systems without the need for continuous polling. - [Webhook Authentication](https://docs.ecartpay.com/docs/webhook-authentication.md) - [Notification Retries](https://docs.ecartpay.com/docs/notification-retrie.md) - [Using SDK](https://docs.ecartpay.com/docs/tokenization.md) - [Debit/Credit Card](https://docs.ecartpay.com/docs/test-cards-1.md): Use the cards provided below to perform payment-related tests, such as declined or successful payments. - [Bank Transfers](https://docs.ecartpay.com/docs/bank-transfer.md): To better understand and test the bank transfer system, you can use the following sample data. This allows you to simulate real transactions and ensure that everything works as expected. - [Error Reference Guide](https://docs.ecartpay.com/docs/error-reference-guide.md): This guide lists application error codes, constants, and user-facing messages, categorized by functional domain. - [HTTP Status Code Guide](https://docs.ecartpay.com/docs/http-status-code-guide.md): This document outlines the standard HTTP status codes used by our API to indicate the success or failure of a request. - [MCP](https://docs.ecartpay.com/docs/mcp.md) - [Google Pay™ Integration Guide](https://docs.ecartpay.com/docs/google-paytm-integration-guide.md): The Ecart Pay SDK provides a complete integration with the Google Pay API, allowing merchants to offer Google Pay as a payment method on their websites. As a supported Payment Service Provider (PSP), Ecart Pay handles all token decryption and payment processing on your behalf. - [Apple Pay ™ Integation Guide](https://docs.ecartpay.com/docs/apple-pay-tm-integation-guide.md): Accept payments with Apple Pay using the Ecart Pay SDK. As a supported Payment Service Provider (PSP), Ecart Pay handles merchant validation, token decryption, and payment processing — your integration is just a few lines of JavaScript. ## API Reference - [Getting Started](https://docs.ecartpay.com/reference/getting-started.md): Obtain your [API Keys](https://docs.ecartpay.com/reference/getting-started-1#/your-api-keys) to make your first successful call! - [My Requests](https://docs.ecartpay.com/reference/my-requests.md): Set up the welcome page for your API to help users make their first call. - [Create Authorization Token](https://docs.ecartpay.com/reference/create-authorization-token.md): **You will need to create a token to make requests to Ecart Pay.** Create your token doing a **post** request using your public and private keys. You can find the keys in your account API Settings section. Once authorized you will receive a _token_ which you will be able to use to make requests to **Ecart Pay** endpoints. The new _token_ has an expiration of 1 hour. So you should create a new token after 1 hour in order to avoid getting the Unauthorized error through the API. Make sure you keep your token fully secure and delete the token when you don't need it anymore. The response will have the following structure: - `token`: A string representing the authorization token. Example response: ``` {"token":"eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjYxODliZTgwZGYyOTE1OTgyMjFhNWU5NSIsImlhdCI6MTcwNjAzNzYzNiwiZXhwIjoxNzA2MDQxMjM2fQ.J-bQwBP3HQEU4YodJw8dx0NuQ-Z2pgs1_GumL-FJHNy4PE9hBZW81BmH9ZwtEV2323xLHsov4YjqSe6hApQ"} ``` - [Create Order](https://docs.ecartpay.com/reference/create-order.md) - [Get Order](https://docs.ecartpay.com/reference/get-order.md): Use this endpoint to retrieve information of an specific order. - [Update Order](https://docs.ecartpay.com/reference/update-order.md): You can use this endpoint to update the shipping address of an order. - [Create a Refund](https://docs.ecartpay.com/reference/create-a-refund.md): This endpoint allows you to initiate a refund for a completed order. The refund amount and the reason for the refund must be specified in the request. - [Get Public Order](https://docs.ecartpay.com/reference/get-public-order.md): Use this endpoint to get all the relevant information about this order, including the unique transaction CLABE if it has been already generated and assigned to the order. - [Configure Order for Bank Transfers](https://docs.ecartpay.com/reference/configure-order-for-bank-transfers.md): Use this endpoint to activate Bank Transfers for an order and assign a CLABE for customer to pay. This will generate a unique transaction CLABE for this specific order. - [Create a Checkout](https://docs.ecartpay.com/reference/create-a-checkout.md): The HTTP POST request to the specified URL is used to create checkouts in the ecartpay system. The request should include the customer details, currency, amounts, concept, and other relevant information. Upon successful execution, the API returns a status code of 200 along with checkout details including account_id, items, token, public_id, link, and timestamps. ### Request Body - `customer_id` (string) **optional**: The ID of the customer. - `title` (string): Title of the checkout. - `subtitle` (string): Subtitle of the checkout. - `image_url` (string): URL of the image associated with the checkout. - `currency` (string): Currency for the transaction. - `amounts` (array of numbers): Array of amounts. - `concept` (string): Description of the checkout concept. - `notify_url` (string): URL for receiving notifications. - `reference_id` (string): Reference ID for the checkout. - `reference` (string): Reference for the checkout. ### Response - `account_id` (string): ID of the account associated with the checkout. - `title` (string): Title of the checkout. - `subtitle` (string): Subtitle of the checkout. - `image_url` (string): URL of the image associated with the checkout. - `currency` (string): Currency for the transaction. - `amounts` (array of numbers): Array of amounts. - `concept` (string): Description of the checkout concept. - `items` (array of objects): Details of the items included in the checkout. - `name` (string): Name of the item. - `quantity` (number): Quantity of the item. - `price` (number): Price of the item. - `discount` (number): Discount on the item. - `is_service` (boolean): Indicates if the item is a service. - `id` (string): ID of the item. - `customer_id` (string): ID of the customer. - `notify_url` (string): URL for receiving notifications. - `reference_id` (string): Reference ID for the checkout. - `reference` (string): Reference for the checkout. - `token` (string): Token associated with the checkout. - `public_id` (string): Public ID of the checkout. - `link` (string): Link to the checkout. - `id` (string): ID of the checkout. - `created_at` (string): Timestamp indicating the creation time. - `updated_at` (string): Timestamp indicating the last update time. #### Example Response ``` json { "account_id": "5d2d436e3199ae000449065b", "title": "Ecart Pay", "subtitle": "The best payment solution", "image_url": "https://miimage.com/image.jpg", "currency": "MXN", "amounts": [ 100, 200, 500, 1000, 1500, 3000 ], "concept": "Recharge", "items": [ { "name": "Recharge", "quantity": 1, "price": 100, "discount": 0, "is_service": false, "id": "65b011ba7f9f322421087221" } ], "customer_id": "65aff37afebdf2a42f88c178", "notify_url": "https://example.com/webhooks/checkout?user_id=1", "reference_id": "001", "reference": "Custom recharge", "token": "eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjYxODliZTgwZGYyOTE1OTgyMjFhNWU5NSIsInNjb3BlcyI6WyJ3cml0ZV9jaGVja291dHMiXSwiaWF0IjoxNzA2MDM3NjkwLCJleHAiOjE3MDYwMzg1OTAsImF1ZCI6Imh0dHBzOi8vc2FuZGJveC5lY2FydHBheS5jb20iLCJzdWIiOiJjaGVja291dHMifQ.nZHFH-4diuddAAp8hrUrg7hI0Jzti330zlAIPUz6_AB4g6KSIpJWIEL-HVxk8JPGuq6eBVj80Ji7l6cUmOqofQ", "public_id": "pub6189be80df291598221a5e93", "link": "https://sandbox.ecartpay.com/v2/checkout?id=65b011ba7f9f32242108721f", "id": "65b011ba7f9f32242108721f", "created_at": "2024-01-23T19:21:30.912Z", "updated_at": "2024-01-23T19:21:30.912Z" } ``` - [Update Checkout](https://docs.ecartpay.com/reference/update-checkout.md): This endpoint allows businesses to update key details of an existing checkout, such as customer information or notification settings. - [Update Item](https://docs.ecartpay.com/reference/update-item.md): This endpoint enables updates to specific items within a checkout, such as modifying prices or quantities. - [Get Checkout](https://docs.ecartpay.com/reference/get-checkout.md) - [Get Public Checkout](https://docs.ecartpay.com/reference/get-checkout-1.md) - [Create Payment Link Template](https://docs.ecartpay.com/reference/create-payment-link-template.md): This endpoint allows you to create a new payment link template. quantity_uses = -1 for infinite uses. - [Retrieve All Payment Link Templates](https://docs.ecartpay.com/reference/retrieve-all-payment-links.md): Use this template to retreive all the templates saved on your account. - [Retrieve Specific Payment Link Template](https://docs.ecartpay.com/reference/retrieve-specific-payment-link-template.md): This request will get you an specific template on your account. - [Update Payment Link Status](https://docs.ecartpay.com/reference/update-payment-link-status.md): Use this enpoint to update your templates. - [Update Payment Link Template](https://docs.ecartpay.com/reference/update-payment-link-template.md): Use the following endpoint to update an existing payment link template. You can adjust various parameters such as the recipient's details, item information, usage limits, and more. - [Delete Payment Link Template](https://docs.ecartpay.com/reference/delete-payment-link-template.md): Ecart Pay allows you to delete payment link templates when they are no longer needed. - [Create a Payout](https://docs.ecartpay.com/reference/create-a-payout.md): **Creating payouts to other accounts is very simple.** You can send money to any person that has an account registered in Ecart Pay. This is very useful because you can send money from your account to their account for FREE. Once they receive the money, they can withdraw the balance to their own account in any of the countries that Ecart Pay operates. You can also add items to the payout, so the recipient will know exactly wich items you are paying them. This is a very useful tool for marketplaces and drop shipping solutions. Review the examples in the documentations to review the payload body. | **key** | **type** | **options** | | --- | --- | --- | | email | string | The customer or provider **email**. | | reference_id | string | A **unique ID** which you will be able to use only once. | | amount | int | The **amount** you want to send to the customer. | | currency | string | The **currency** of the payment. (You can use any currency allowed by Ecart Pay) | | require_confirmation | boolean | **true**: [Needs to be confirmed afterwards.](https://docs.ecartpay.com/#a4cf59d6-9bc9-4ecd-b1b1-9eed8f3157a6)
**false**: The payment is credited instantly. | | | | | - [Get All Payouts](https://docs.ecartpay.com/reference/get-all-payouts.md): **Retrieve the payouts that have processed by your account.** Get a list of every payout you have made. You can use Query params to filter your request. - [Get single payout](https://docs.ecartpay.com/reference/get-single-payout.md): Get single payout - [Confirm payout](https://docs.ecartpay.com/reference/confirm-a-payout.md): If there is no available_at the confirmation will be effective immediately. If you send available_at, it will be available the date you stablished. - [Update payout items](https://docs.ecartpay.com/reference/update-payout-items.md): Update payout items - [Retrieve All Transactions](https://docs.ecartpay.com/reference/retrieve-all-transactions.md): Retrieves a detailed list of all transactions in the account. By default, this endpoint returns the transactions from the last 30 days. - [Retrieve Transaction Summary](https://docs.ecartpay.com/reference/retrieve-transaction-summary.md): Retrieves a summary of the account’s transactions, including total pay-ins and payouts in the specified currency. - [Retrieve a Single Transaction](https://docs.ecartpay.com/reference/retrieve-a-single-transaction.md): Retrieve detailed information about a specific transaction, including fees, gateway details, and associated orders. - [Create Client Billing Information](https://docs.ecartpay.com/reference/create-client-billing-information.md) - [Get Client Billing Information](https://docs.ecartpay.com/reference/get-client-billing-information.md): This endpoint retrieves billing information for clients associated with a specific user and country - [Get Client Billing Invoices](https://docs.ecartpay.com/reference/get-client-billing-invoices.md): This endpoint retrieves a list of invoices associated with registered clients. - [Create Order Invoice](https://docs.ecartpay.com/reference/create-order-invoice.md) - [Get Order Invoice Creation](https://docs.ecartpay.com/reference/get-order-invoice-creation.md) - [Get Billing Providers](https://docs.ecartpay.com/reference/get-billing-providers.md): This endpoint will return all the relevant information about billing providers. This information may be useful when using enpoints like Create Client Billing Information to get relevant information like the `provider_id` - [Download CFDI](https://docs.ecartpay.com/reference/download-cfdi.md): Download CFDI - [Verifacti API Status](https://docs.ecartpay.com/reference/verifacti-api-status.md): This endpoint returns the status of the API key. It is mainly used to verify that the API is active and to know which NIF and environment it refers to. - [Cancel Invoice](https://docs.ecartpay.com/reference/cancel-invoice.md): This endpoint allows you to cancel existing invoices. By doing so, new information is sent to the AEAT. - [Invoice Status](https://docs.ecartpay.com/reference/invoice-status.md): This endpoint allows you to consult the status of an invoice in the AEAT system. - [Submission Status](https://docs.ecartpay.com/reference/submission-status.md): Technical query to the AEAT about the invoice submission status using the uuid. - [List Invoices](https://docs.ecartpay.com/reference/list-invoices.md): Consultation of invoices presented to the AEAT with filters. - [Responsible Declaration](https://docs.ecartpay.com/reference/responsible-declaration.md): Obtain the Verifacti responsible declaration document. The response will include a URL to access the responsible declaration document. - [Change Invoice Language](https://docs.ecartpay.com/reference/change-invoice-language.md): Use this endpoint to update the language the invoice PDF will be rendered. The default language of a Verifactu invoice is Spanish, but can be update to Italian and French. - [Verifacti API Key from a NIF](https://docs.ecartpay.com/reference/verifacti-api-key-from-a-nif.md): This endpoint returns the API key for a specific NIF and in a specific environment. You need to add your NIF management API key provided by Verifacti to your Ecart Pay account through the Billing Gateways settings. NIF management API keys start with `vfn_`. - [List NIFs](https://docs.ecartpay.com/reference/list-nifs.md): This endpoint returns a list of all NIFs. By default, it returns both active and inactive in both environments, although it allows you to filter only active or inactive and the environment. - [Add NIF](https://docs.ecartpay.com/reference/add-nif.md): New NIFs are added through this endpoint. NIFs are used to issue Verifactu invoices. Each NIF has a unique Verifacti API Key, which Verifacti generates upon adding a new NIF. - [NIF Information](https://docs.ecartpay.com/reference/nif-information.md): This endpoint returns the information of a specific NIF. - [Update NIF](https://docs.ecartpay.com/reference/update-nif.md): This endpoint allows you to modify the information of a specific NIF. - [Deactivate NIF](https://docs.ecartpay.com/reference/deactivate-nif.md): This endpoint allows you to deactivate a NIF. Any deactivated NIF can be reactivated at any time to continue sending invoices. - [Activate NIF](https://docs.ecartpay.com/reference/activate-nif.md): This endpoint allows you to activate a NIF that has been previously deactivated. - [VIES Validation](https://docs.ecartpay.com/reference/vies-validation.md): This endpoint allows you to validate that an intra-community NIF-IVA number is in the VIES census. - [AEAT Validation](https://docs.ecartpay.com/reference/aeat-validation.md): This endpoint allows you to validate that a NIF is identified in the AEAT. - [Create Subscription](https://docs.ecartpay.com/reference/create-subscription.md): Create subscription - [Create a Subscription Template](https://docs.ecartpay.com/reference/create-a-subscription-template.md): Use a template when you want to define a reusable subscription model with parameters like billing frequency and trial period. - [Get All Subscrption Templates](https://docs.ecartpay.com/reference/get-all-subscription-templates.md): Get All Subcription Templates - [Get All Subscriptions](https://docs.ecartpay.com/reference/get-all-subscriptions.md): Get all subscriptions - [Get My Subscriptions](https://docs.ecartpay.com/reference/get-my-subscriptions.md): Get my subscriptions - [Get Single Subscription](https://docs.ecartpay.com/reference/get-single-subscription.md): Get single subscription - [Update Subscription](https://docs.ecartpay.com/reference/update-subscription.md): This critical endpoint adds or removes payment methods to a subscription. When card_ids are added, the system automatically determines the payment processing schedule based on the subscription's trial periods, billing cycles, and payment dates. - [Customer Update Subscription](https://docs.ecartpay.com/reference/customer-update-subscription.md): Allows customers to update their own subscriptions from their dashboard. This is the endpoint used by the customer portal when they add payment methods. - [Resend Invitation Link](https://docs.ecartpay.com/reference/resend-invitation-link.md): Resends the subscription invitation email to the customer. Limited to 5 invitations per subscription with 24-hour cooldown. - [Create Customer CLABE](https://docs.ecartpay.com/reference/create-customer-clabe.md): Register a new 18-digit interbank CLABE for a specific customer. - [Retrieve Customer CLABE](https://docs.ecartpay.com/reference/retrieve-customer-clabe.md): Fetch the full details of a previously registered CLABE. - [Create Direct Debit](https://docs.ecartpay.com/reference/create-direct-debit.md): Use this endpoint to initialize a new direct debit authorization. If no bank account is provided, the system will automatically trigger an activation email flow. - [Get Direct Debit](https://docs.ecartpay.com/reference/get-direct-debit.md): Retrieve the full details, including customer info and billing account status, for a specific direct debit. - [Update Direct Debit Status](https://docs.ecartpay.com/reference/update-direct-debit-status.md): Use this endpoint to modify the status of an existing direct debit (e.g., to pause or cancel it). Note that strict state transitions apply (e.g., you cannot go from `cancelled` to `active`). - [List Direct Debits](https://docs.ecartpay.com/reference/list-direct-debits.md): Retrieve a paginated list of all direct debits associated with your account, with optional filtering. - [Create New Payment Method](https://docs.ecartpay.com/reference/create-new-payment-method.md): In this section you will be able to add a payment method for your withdrawals. You can add a debit card or add your bank account with "clabe number". - [Update Payment Method](https://docs.ecartpay.com/reference/update-payment-method.md): Once a payment method is created, you can modify its details using the following endpoint. - [Delete Payment Method](https://docs.ecartpay.com/reference/delete-payment-method.md): If a payment method is no longer needed, you can delete it using this endpoint. - [Create Account Gateway Keys](https://docs.ecartpay.com/reference/create-account-gateway-keys.md): Create Account Gateway Keys - [Update Account Gateway](https://docs.ecartpay.com/reference/update-account-gateway.md): Update account gateway - [Get Client Billing Information](https://docs.ecartpay.com/reference/retrieve-a-single-gateway.md): See all your withrawal accounts - [Retrieve Active Withdrawal Bank Accounts](https://docs.ecartpay.com/reference/retrieve-active-withdrawal-accounts.md): See all your withrawal accounts - [Retrieve Withdrawals History](https://docs.ecartpay.com/reference/getwithdrawals-1.md): See all your withrawal accounts - [Create Customer](https://docs.ecartpay.com/reference/create-customer.md): Create customer - [Retrieve Customers](https://docs.ecartpay.com/reference/retrieve-customers.md): Get all customers - [Update Customer](https://docs.ecartpay.com/reference/update-customer.md): Updates the information from an existing customer. Updated email or phone number must not be associated to any other existing customer within the same merchant. - [Delete Customer](https://docs.ecartpay.com/reference/delete-customer.md): Delete an existing customer. - [Create Customer Card](https://docs.ecartpay.com/reference/create-customer-card.md): Create customer card - [Retrieve Customer Cards](https://docs.ecartpay.com/reference/retrieve-customer-cards.md): Get customer cards - [Update Customer Card as Default](https://docs.ecartpay.com/reference/update-customer-card-as-default.md): Update customer card as default - [Delete Customer Card](https://docs.ecartpay.com/reference/delete-customer-card.md): Delete customer card - [Create Customer Token](https://docs.ecartpay.com/reference/create-customer-token.md): Create customer token - [Create Customer Payment Method](https://docs.ecartpay.com/reference/create-customer-payment-method.md): ## Add Payment Method for Customer This endpoint allows you to add a payment method for a specific customer. ### Request Body - `name` (string, required): The name associated with the payment method. - `business_name` (string, required): The business name associated with the payment method. - `bank` (string, required): The bank associated with the payment method. - `number` (string, required): The number associated with the payment method. - `method` (string, required): The payment method type. - `country` (string, required): The country associated with the payment method. ### Response - `authorization_id` (string): The authorization ID of the payment method. - `account_id` (string): The account ID of the payment method. - `customer_id` (string): The customer ID associated with the payment method. - `name` (string): The name associated with the payment method. - `bank` (string): The bank associated with the payment method. - `business_name` (string): The business name associated with the payment method. - `number` (string): The number associated with the payment method. - `method` (string): The payment method type. - `country` (string): The country associated with the payment method. - `default` (boolean): Indicates if the payment method is set as default. - `deleted` (boolean): Indicates if the payment method is deleted. - `id` (string): The ID of the payment method. ### Example ``` json { "authorization_id": "6189be80d3xw1598221a5e95", "account_id": "5d2d436e333e000449065b", "customer_id": "65aff37afebx32a42f88c178", "name": "Main", "bank": "40002", "business_name": "John Doe", "number": "1234567891234567", "method": "clabe", "country": "MX", "default": true, "deleted": false, "id": "65b012a47f3wx22421087230" } ``` - [Create Tokenized Card](https://docs.ecartpay.com/reference/create-tokenized-card.md): Use this endpoint to create a tokenized card. - [Create and Store a Card](https://docs.ecartpay.com/reference/create-and-store-a-card.md): Add a card to your account which you will be able to use to receive money or make payments. - [Delete Stored Card](https://docs.ecartpay.com/reference/delete-stored-card.md): Delete card - [Retrieve All Stored Cards](https://docs.ecartpay.com/reference/retrieve-all-stored-cards.md): Retrieve the list of cards that are active in your account. - [Retrieve a Single Card](https://docs.ecartpay.com/reference/retrieve-a-single-card.md): Retrieve the information of an specific card in your accorunt by using this endpoint. - [Get CFDI uses](https://docs.ecartpay.com/reference/cfdi-uses.md): With this endpoint you can get a list of all the CFDI uses in Mexico. With this you can create a dropdown list with CFDI Uses. - [Get Countries](https://docs.ecartpay.com/reference/countries.md): With this endpoint you can get a list of all the CFDI uses in Mexico. With this you can create a dropdown list with CFDI Uses. - [Get States](https://docs.ecartpay.com/reference/states.md): With this endpoint you can get a list of all the CFDI uses in Mexico. With this you can create a dropdown list with CFDI Uses. - [Get Zipcode](https://docs.ecartpay.com/reference/zipcode.md): With this endpoint you can get a list of all the CFDI uses in Mexico. With this you can create a dropdown list with CFDI Uses. - [Get Localities](https://docs.ecartpay.com/reference/localities.md): With this endpoint you can get a list of all the CFDI uses in Mexico. With this you can create a dropdown list with CFDI Uses. - [Get Catalog](https://docs.ecartpay.com/reference/catalog.md): With this endpoint you can get a list of all the CFDI uses in Mexico. With this you can create a dropdown list with CFDI Uses. - [Get Billing Form](https://docs.ecartpay.com/reference/billing-form.md): With this endpoint you can get a list of all the CFDI uses in Mexico. With this you can create a dropdown list with CFDI Uses. - [Retrieve Exchanges by Currency Base](https://docs.ecartpay.com/reference/retrieve-exchanges-by-currency-base.md): With this endpoint you can retrieve the list of exchanges by currency base - [Retrieve Available Currencies](https://docs.ecartpay.com/reference/retrieve-available-currencies.md): Get a complete list of all the exchanges available on **Ecart Pay** - [Get All Banks by Country](https://docs.ecartpay.com/reference/get-all-banks-by-country.md): Get a list of banks by country. You can use this list to create a dropdown menu or to verify that we operate with the bank you need. - [Get Single Bank](https://docs.ecartpay.com/reference/get-single-bank.md): This endpoint responds with a single bank. Send the bank id in order to receive the banks detailed information. - [Create Chargeback](https://docs.ecartpay.com/reference/create-chargeback.md): Create chargeback - [Retrieve All Chargebacks](https://docs.ecartpay.com/reference/retrieve-all-chargebacks.md): Get all chargebacks - [Retrieve a Single Chargeback](https://docs.ecartpay.com/reference/retrieve-a-single-chargeback.md): Get single chargeback - [Update Chargeback](https://docs.ecartpay.com/reference/update-chargeback.md): Update chargeback - [Retrieve All Available Payment Gateways](https://docs.ecartpay.com/reference/retrieve-all-available-payment-gateways.md): Get all gateways - [Retrieve Single Payment Gateway](https://docs.ecartpay.com/reference/retrieve-single-payment-gateway.md): Get single gateway - [Update Payment Gateway](https://docs.ecartpay.com/reference/update-payment-gateway.md): Update gateway - [Update Gateway Method](https://docs.ecartpay.com/reference/update-payment-gateway-method.md): Update gateway method - [Create or Update Custom Interest-free and Fixed Installments configuration](https://docs.ecartpay.com/reference/create-or-update-custom-interest-free-and-fixed-installments-configuration.md): Create or Update Custom Interest-free and Fixed Installments configuration - [Turn on/off Interest-free and Fixed Installments Configurations](https://docs.ecartpay.com/reference/turn-on-off-interest-free-and-fixed-installment-configurations.md) - [Retrieve Interest-free and Fixed Installments Configuration](https://docs.ecartpay.com/reference/retrieve-interest-free-and-fixed-installments-configuration.md): This endpoint retrieves the current Installments-free/Fixed installments for an account, if there is no custom configuration, it creates a new one for the account with the default values. - [Get All Notifications](https://docs.ecartpay.com/reference/get-all-notifications.md): Get all notifications - [Update Notification Seen](https://docs.ecartpay.com/reference/update-notification-seen.md): Update notification seen - [Get All Activity](https://docs.ecartpay.com/reference/get-all-activity.md): Get all activity - [Get Activity](https://docs.ecartpay.com/reference/get-activity.md): Get Activity - [Create Woocommerce Order](https://docs.ecartpay.com/reference/woocommerce-create-order.md): Create order - [Get all Scopes](https://docs.ecartpay.com/reference/get-all-scopes.md): Get all scopes - [Create Scopes Token](https://docs.ecartpay.com/reference/create-scopes-token.md): Create scopes token - [Create Webhook](https://docs.ecartpay.com/reference/create-webhook-1.md): Create Webhook - [Update Webhook Status](https://docs.ecartpay.com/reference/update-webhook-status.md): Updates the active status of a webhook. - [Delete Webhook](https://docs.ecartpay.com/reference/delete-webhook.md): Deletes a webhook by its ID. - [Estado API](https://docs.ecartpay.com/reference/estadoapi.md): Estado API - [Declaración responsable](https://docs.ecartpay.com/reference/declaracinresponsable.md): Declaración responsable - [Crear factura](https://docs.ecartpay.com/reference/crearfactura.md): Crear factura - [Anular factura](https://docs.ecartpay.com/reference/anularfactura.md): Anular factura - [Estado de la Factura](https://docs.ecartpay.com/reference/estadodelafactura.md): Estado de la Factura - [Estado de Registro](https://docs.ecartpay.com/reference/estadoderegistro.md): Estado de Registro - [Listar facturas](https://docs.ecartpay.com/reference/listarfacturas.md): Listar facturas - [Cambiar idioma de factura](https://docs.ecartpay.com/reference/cambiaridiomadefactura.md): Cambiar idioma de factura - [API Key de un NIF](https://docs.ecartpay.com/reference/apikeydeunnif.md): API Key de un NIF - [Listar NIFs](https://docs.ecartpay.com/reference/listarnifs.md): Listar NIFs - [Añadir NIF](https://docs.ecartpay.com/reference/aadirnif.md): Añadir NIF - [Informacion del NIF](https://docs.ecartpay.com/reference/informaciondelnif.md): Informacion del NIF - [Modificar NIF](https://docs.ecartpay.com/reference/modificarnif.md): Modificar NIF - [Desactivar NIF](https://docs.ecartpay.com/reference/desactivarnif.md): Desactivar NIF - [Activar NIF](https://docs.ecartpay.com/reference/activarnif.md): Activar NIF - [Validar IVA en VIES](https://docs.ecartpay.com/reference/validarivaenvies.md): Validar IVA en VIES - [Validar NIF en AEAT](https://docs.ecartpay.com/reference/validarnifenaeat.md): Validar NIF en AEAT ## Recipes - [Integrating the SDK Billing and Client management modules](https://docs.ecartpay.com/recipes/integrating-the-sdk-billing-and-client-management-modules.md) - [Integrating the SDK Checkout module](https://docs.ecartpay.com/recipes/integrating-the-sdk-payment-popup-checkout.md) ## Pages - [EcartPay Backend Integration](https://docs.ecartpay.com/page/ecartpay-backend-integration.md) - [Ecommerce Integrations](https://docs.ecartpay.com/page/ecommerce-integrations.md) ## Changelog - [🚀 Smarter Subscriptions & Webhooks - October 02 2025 Update](https://docs.ecartpay.com/changelog/smarter-subscriptions-webhooks-october-02-2025-update.md)