API Endpoints - Cheqpay

Overview

Complete reference for all Cheqpay API endpoints. Full OpenAPI specification coming soon.

We’re currently preparing a complete OpenAPI specification that will provide comprehensive endpoint documentation with request/response schemas, examples, and the ability to generate API clients automatically.

Payment Orders

Create Payment Order

Create a payment order for card, SPEI transfer, PayCash, or CIE Cash Net payments. See the feature-specific guides for detailed implementation: Reference:

Card Payments

Card-specific fields, 3DS, and PCI notes

SPEI Transfers

Bank transfer implementation guide

PayCash Payments

Offline cash payment implementation guide

CIE Cash Net Payments

BBVA cash and bank deposit implementation guide

Get Payment Order

Retrieve payment order details by ID.

GET /v2/payment-orders/:id

Parameters:

:id - Payment order ID (Cheqpay ID or external ID)

Reference:

Payment Orders

Complete guide with status reference

List Payment Orders

Retrieve a list of payment orders with filtering and pagination.

GET /v2/payment-orders?limit=20&offset=0

Query Parameters:

Parameter	Type	Description
`limit`	integer	Number of results (default: 20, max: 100)
`offset`	integer	Pagination offset (default: 0)
`status`	string	Filter by status
`customerId`	string	Filter by customer ID
`startDate`	date	Filter from date (ISO 8601)
`endDate`	date	Filter to date (ISO 8601)

3D Secure

Validate Authentication

Validate 3D Secure authentication after customer completes challenge.

POST /v2/payment-orders/:id/payer-authentication/validate

Parameters:

:id - Payment order ID

Reference:

3D Secure

Complete 3DS implementation guide

Refunds

Create Refund

Issue full or partial refund on a completed payment.

POST /v2/payment-orders/:id/refund

Parameters:

:id - Payment order ID

Request Body:

{
  "amount": 5000,  // Required. Minor units (centavos): 5000 = $50.00. Pass the full amount for a full refund.
  "reason": "Customer requested refund"
}

Reference:

Refunds

Complete refund guide

Customers

Get Customer

Retrieve customer information and saved payment methods.

GET /customers/:id

Parameters:

:id - Customer ID (Cheqpay ID or external ID)

Reference:

Customers

Complete customer management guide

List Customers

Retrieve a list of customers with pagination.

GET /customers?limit=20&offset=0

Query Parameters:

Parameter	Type	Description
`limit`	integer	Number of results (default: 20, max: 100)
`offset`	integer	Pagination offset (default: 0)
`email`	string	Filter by email address
`externalId`	string	Filter by external ID

Payment Methods

List Payment Methods

Get saved payment methods for a customer.

GET /customers/:customerId/payment-methods

Parameters:

:customerId - Customer ID

Reference:

Payment Methods

Complete payment methods guide

Delete Payment Method

Remove a saved payment method.

DELETE /customers/:customerId/payment-methods/:paymentMethodId

Parameters:

:customerId - Customer ID
:paymentMethodId - Payment method ID

Common Request Fields

Customer Object

{
  "customer": {
    "externalId": "user_123",
    "firstName": "María",
    "lastName": "González",
    "email": "maria@example.com",
    "phoneNumber": "+521555123456"
  }
}

Billing Address Object

{
  "billingAddress": {
    "address": "Av. Reforma 123",
    "city": "Mexico City",
    "state": "CDMX",
    "postalCode": "01000",
    "country": "MX"
  }
}

Payment Method Object (Card)

{
  "paymentMethod": {
    "type": "card",
    "options": {
      "card": {
        "number": "4000000000002503",
        "expiryMonth": "12",
        "expiryYear": "2025",
        "cvc": "123"
      }
    },
    "persist": true
  }
}

Payment Method Object (Saved Card)

{
  "paymentMethod": {
    "type": "payment_method_id",
    "paymentMethodId": "pm_abc123",
    "cvc": "123"
  }
}

Payment Method Object (SPEI)

{
  "paymentMethod": {
    "type": "spei"
  }
}

Payment Method Object (PAYCASH)

{
  "paymentMethod": {
    "type": "paycash"
  }
}

Payment Method Object (CIE_CASH_NET)

{
  "paymentMethod": {
    "type": "cie_cash_net"
  }
}

Device Information Object

{
  "deviceInformation": {
    "ipAddress": "192.168.1.100",
    "userAgent": "Mozilla/5.0...",
    "httpBrowserLanguage": "es-MX",
    "httpBrowserScreenWidth": "1920",
    "httpBrowserScreenHeight": "1080"
  }
}

Response Objects

Payment Order Object

{
  "id": "ord_abc123",
  "externalId": "order-12345",
  "status": "COMPLETED",
  "amount": 10000,
  "currency": "MXN",
  "description": "Order payment",
  "createdAt": "2025-10-30T10:00:00.000Z",
  "completedAt": "2025-10-30T10:00:05.000Z"
}

Customer Object

{
  "id": "cus_xyz789",
  "externalId": "user_123",
  "firstName": "María",
  "lastName": "González",
  "email": "maria@example.com",
  "phoneNumber": "+521555123456",
  "createdAt": "2025-10-30T10:00:00.000Z"
}

Payment Method Object

{
  "id": "pm_abc123",
  "type": "card",
  "card": {
    "brand": "visa",
    "last4": "1111",
    "expiryMonth": "12",
    "expiryYear": "2025"
  },
  "createdAt": "2025-10-30T10:00:00.000Z"
}

OpenAPI Specification

Full OpenAPI 3.0 specification coming soon. This will include:

Complete endpoint documentation
Request/response schemas
Example requests and responses
Data type definitions
Enum values
Validation rules

The OpenAPI spec will enable you to:

Generate API clients automatically
Import into Postman or Insomnia
Generate documentation
Validate requests/responses
Mock API responses for testing

Contact support@cheqpay.mx if you need early access to the OpenAPI specification.

Feature-Specific Documentation

For detailed guides and examples, see our feature documentation:

Card Payments

Process credit and debit cards

3D Secure

Implement authentication

Refunds

Issue refunds

Customers

Manage customers

Payment Methods

Save payment methods

Need Help?

Testing Guide

Test all endpoints in sandbox

Error Reference

View all error codes

Quickstart

Process your first payment

Contact Support

Get integration help

​Overview

​Payment Orders

​Create Payment Order

Card Payments

SPEI Transfers

PayCash Payments

CIE Cash Net Payments

​Get Payment Order

Payment Orders

​List Payment Orders

​3D Secure

​Validate Authentication

3D Secure

​Refunds

​Create Refund

Refunds

​Customers

​Get Customer

Customers

​List Customers

​Payment Methods

​List Payment Methods

Payment Methods

​Delete Payment Method

​Common Request Fields

​Customer Object

​Billing Address Object

​Payment Method Object (Card)

​Payment Method Object (Saved Card)

​Payment Method Object (SPEI)

​Payment Method Object (PAYCASH)

​Payment Method Object (CIE_CASH_NET)

​Device Information Object

​Response Objects

​Payment Order Object

​Customer Object

​Payment Method Object

​OpenAPI Specification

​Feature-Specific Documentation

Card Payments

3D Secure

Refunds

Customers

Payment Methods

​Need Help?

Testing Guide

Error Reference

Quickstart

Contact Support

Overview

Payment Orders

Create Payment Order

Get Payment Order

List Payment Orders

3D Secure

Validate Authentication

Refunds

Create Refund

Customers

Get Customer

List Customers

Payment Methods

List Payment Methods

Delete Payment Method

Common Request Fields

Customer Object

Billing Address Object

Payment Method Object (Card)

Payment Method Object (Saved Card)

Payment Method Object (SPEI)

Payment Method Object (PAYCASH)

Payment Method Object (CIE_CASH_NET)

Device Information Object

Response Objects

Payment Order Object

Customer Object

Payment Method Object

OpenAPI Specification

Feature-Specific Documentation

Need Help?