# Cheqpay

## Docs

- [Pay with card or spei](https://docs.cheqpay.mx/api-reference/checkout/pay-with-card-or-spei.md): Process a payment using a card or spei payment method. This endpoint will create or update a payment order and customer based on the provided external IDs.
- [Pay with transfer batch](https://docs.cheqpay.mx/api-reference/checkout/pay-with-transfer-batch.md): Process multiple payments using transfers. This endpoint will create or update multiple payment orders and customers based on the provided external IDs, then assign a single CLABE account for all transfers.
- [Create a new customer (v2)](https://docs.cheqpay.mx/api-reference/customer-v2/create-a-new-customer-v2.md): Creates a new customer for payment links. Unlike v1, this doesn't require external ID or merchant association, making it suitable for cross-merchant usage.
- [Delete customer (v2)](https://docs.cheqpay.mx/api-reference/customer-v2/delete-customer-v2.md): Soft deletes a customer by setting their active status to false. The customer record is preserved for audit purposes.
- [Get customer by ID (v2)](https://docs.cheqpay.mx/api-reference/customer-v2/get-customer-by-id-v2.md): Retrieves a specific customer by their unique ID. This uses the internal customer ID, not an external ID like v1.
- [List customers with pagination and filtering (v2)](https://docs.cheqpay.mx/api-reference/customer-v2/list-customers-with-pagination-and-filtering-v2.md): Retrieves a paginated list of customers with optional filtering by email, phone number, and active status. Designed for payment link customer management.
- [Update customer (v2)](https://docs.cheqpay.mx/api-reference/customer-v2/update-customer-v2.md): Updates an existing customer. All fields are optional - only provided fields will be updated.
- [Create or update a customer](https://docs.cheqpay.mx/api-reference/customer/create-or-update-a-customer.md): Creates a new customer or updates an existing one based on the external ID. If a customer with the given external ID exists, it will be updated. Otherwise, a new customer will be created.
- [Get customer by external ID](https://docs.cheqpay.mx/api-reference/customer/get-customer-by-external-id.md): Retrieves a customer by their external ID. The external ID is the ID provided by the merchant system.
- [API Endpoints](https://docs.cheqpay.mx/api-reference/endpoints.md): Detailed reference for all API endpoints
- [Error Codes](https://docs.cheqpay.mx/api-reference/errors.md): Complete reference for all API error codes
- [API Reference](https://docs.cheqpay.mx/api-reference/introduction.md): Complete reference for the Cheqpay API
- [Get invoice](https://docs.cheqpay.mx/api-reference/invoices/get-invoice.md): Retrieve an invoice by ID
- [List invoices](https://docs.cheqpay.mx/api-reference/invoices/list-invoices.md): Retrieve a paginated list of invoices with optional filtering and sorting options.
- [Create payment link](https://docs.cheqpay.mx/api-reference/payment-links/create-payment-link.md): Create a new payment link for a merchant
- [Get payment link](https://docs.cheqpay.mx/api-reference/payment-links/get-payment-link.md): Retrieve a payment link by ID
- [Update payment link](https://docs.cheqpay.mx/api-reference/payment-links/update-payment-link.md): Update an existing payment link
- [Create a payment method](https://docs.cheqpay.mx/api-reference/payment-method/create-a-payment-method.md): Creates a new payment method (currently only CARD type is supported). The payment method can be associated with a customer by providing customerId. If persist is true, customerId is required.
- [Delete a payment method](https://docs.cheqpay.mx/api-reference/payment-method/delete-a-payment-method.md): Deletes a payment method by its ID. This is a soft delete and the payment method can be recovered if needed.
- [Get a payment method by ID](https://docs.cheqpay.mx/api-reference/payment-method/get-a-payment-method-by-id.md): Retrieves a payment method by its ID. Returns the payment method details including masked card information.
- [List payment methods for a customer](https://docs.cheqpay.mx/api-reference/payment-method/list-payment-methods-for-a-customer.md): Retrieves all payment methods associated with a specific customer. Returns an array of payment methods with masked card information.
- [Update a payment method](https://docs.cheqpay.mx/api-reference/payment-method/update-a-payment-method.md): Updates billing information for an existing payment method. At least one billing field must be provided. Card details cannot be updated.
- [Create a payment order (v2)](https://docs.cheqpay.mx/api-reference/payment-order/create-a-payment-order-v2.md): Creates a new payment order with customer and payment method information. Can accept an existing customer by ID or create a new customer. Supports card payments, saved payment methods, and SPEI transfers. For card payments, billing address is required. Returns payment order details including 3DS aut…
- [Get payment order by external ID](https://docs.cheqpay.mx/api-reference/payment-order/get-payment-order-by-external-id.md): Retrieves a payment order by its external ID. The external ID is the ID provided by the merchant system.
- [Get payment order by ID](https://docs.cheqpay.mx/api-reference/payment-order/get-payment-order-by-id.md): Retrieves a specific payment order by its unique ID. This is an internal endpoint.
- [Initiate 3DS payer authentication](https://docs.cheqpay.mx/api-reference/payment-order/initiate-3ds-payer-authentication.md): Initiates 3D Secure (3DS) payer authentication for a payment order. This endpoint must be called when a payment order is in PAYER_AUTHENTICATION_DEVICE_DATA_REQUIRED status. It processes device information and returns authentication details for completing the 3DS challenge.
- [List all payment orders](https://docs.cheqpay.mx/api-reference/payment-order/list-all-payment-orders.md): Retrieves a list of all payment orders for the authenticated merchant. This is an internal endpoint.
- [Refund a payment order](https://docs.cheqpay.mx/api-reference/payment-order/refund-a-payment-order.md): Refunds a payment order by its id (external ID). The refund amount can be partial or full.
- [Validate 3DS payer authentication](https://docs.cheqpay.mx/api-reference/payment-order/validate-3ds-payer-authentication.md): Validates 3D Secure (3DS) payer authentication after the customer has completed the authentication challenge. This endpoint must be called when a payment order is in PAYER_AUTHENTICATION_CHALLENGE_REQUIRED status. Upon successful validation, the payment order status will typically transition to AUTH…
- [Health check endpoint](https://docs.cheqpay.mx/api-reference/system/health-check-endpoint.md): Returns the health status of the service, including database and Redis connection status. Returns 200 if all services are healthy, 500 if any service is unhealthy.
- [Authentication](https://docs.cheqpay.mx/essentials/authentication.md): Secure your API requests with API keys
- [Environments](https://docs.cheqpay.mx/essentials/environments.md): Choose between sandbox and production environments
- [Quickstart](https://docs.cheqpay.mx/essentials/quickstart.md): Process your first payment in less than 5 minutes
- [3D Secure](https://docs.cheqpay.mx/features/3d-secure.md): Add an extra layer of protection to card payments
- [Card Payments](https://docs.cheqpay.mx/features/card-payments.md): Accept credit and debit card payments with a simple API
- [Customers](https://docs.cheqpay.mx/features/customers.md): Manage your customers effortlessly with Cheqpay
- [Hosted Payment Page](https://docs.cheqpay.mx/features/hosted-payment-page.md): Integrate Cheqpay's Hosted Payment Page (HPP) to deliver a seamless payment experience
- [Integrate via SDK](https://docs.cheqpay.mx/features/integrate-via-sdk.md): Integrate Cheqpay Checkout directly into your website using our JavaScript SDK
- [Payment Methods](https://docs.cheqpay.mx/features/payment-methods.md): Accept cards and bank transfers with enterprise-grade security
- [Payment Orders](https://docs.cheqpay.mx/features/payment-orders.md): Track payment status and prevent duplicate charges
- [Refunds](https://docs.cheqpay.mx/features/refunds.md): Issue full or partial refunds easily
- [Webhooks](https://docs.cheqpay.mx/features/webhooks.md): Get real-time notifications when payments complete, fail, or change status
- [Best Practices](https://docs.cheqpay.mx/guides/best-practices.md): Follow these guidelines to build a robust integration
- [Error Handling](https://docs.cheqpay.mx/guides/error-handling.md): Handle errors gracefully to provide the best customer experience
- [Going Live](https://docs.cheqpay.mx/guides/going-live.md): Complete checklist for launching in production
- [Testing Guide](https://docs.cheqpay.mx/guides/testing.md): Test your integration thoroughly in our sandbox environment
- [Welcome to Cheqpay](https://docs.cheqpay.mx/index.md): The modern payment gateway built for Mexico and Latin America
- [Webhook Simulators](https://docs.cheqpay.mx/testing/webhook-simulators.md): Test SPEI payment flows without making real bank transfers

## OpenAPI Specs

- [link-product-openapi](https://docs.cheqpay.mx/api-reference/link-product-openapi.json)
- [orchestrator-openapi](https://docs.cheqpay.mx/api-reference/orchestrator-openapi.json)
- [openapi](https://docs.cheqpay.mx/api-reference/openapi.json)