Download the PHP package carlosupreme/cep-query-payment without Composer

CEP Query Service

A PHP library for querying Banco de México's CEP (Comprobantes Electrónicos de Pago / Electronic Payment Receipts) system using Guzzle HTTP client.

Overview

This library provides a simple interface to query the SPEI payment system through Banco de México's CEP website. It uses Guzzle HTTP client to make direct API requests to the CEP system.

Features

• ✅ Query payment status using tracking key or reference number
• ✅ Retrieve available bank options from CEP system
• ✅ Automatic form validation and data sanitization
• ✅ Lightweight HTTP-based approach (no browser required)
• ✅ Comprehensive error handling and logging
• ✅ Framework-agnostic with Laravel integration
• ✅ Date format normalization
• ✅ Bank code lookup by name

Requirements

• PHP 8.2 or higher
• Laravel 11.x or 12.x
• Guzzle HTTP client (installed automatically via composer)

Installation

For Laravel Projects

1. The package is available in composer. Run composer install:

2. The service provider is already registered via Laravel's package auto-discovery.

3. Run:

Usage

Basic Usage (Framework-Agnostic)

Laravel Usage

Get Available Banks

Bank Code Lookup

Date Formatting

Custom Logger

Timeout Options

Form Data Structure

Required Fields

Validation Rules

• fecha: Must be dd-mm-yyyy or dd/mm/yyyy format
• tipoCriterio: Must be 'T' or 'R'
• criterio: Max 30 chars for tracking key, max 7 for reference
• emisor/receptor: Must be numeric bank codes
• cuenta: Must be 18 digits for CLABE format
• monto: Must be numeric (commas allowed)

Response Format

Successful Query (Payment Found)

Payment Not Found

No Result

Error Handling

The library throws Exception for various error conditions:

Common exceptions:

• Required field missing: {field}
• Invalid tipoCriterio. Must be 'T' or 'R'
• Invalid date format. Use dd-mm-yyyy or dd/mm/yyyy
• Invalid CLABE format. Must be 18 digits
• CEP HTTP request failed: {message}

Configuration

Timeout

Default timeout is 60 seconds.

Custom HTTP Client

You can provide a custom Guzzle HTTP client:

Security Considerations

• Form data is sanitized before logging (sensitive fields are masked)
• CLABE accounts show only last 4 digits in logs
• Tracking keys/references show only last 3 characters in logs
• Use environment variables for sensitive configuration
• Consider rate limiting to avoid overloading CEP system

Performance Tips

1. Cache Bank Options: Bank codes rarely change, cache them
2. Adjust Timeouts: Reduce for faster failures, increase for slow networks
3. Queue Jobs: For Laravel, use queues for CEP queries
4. Error Monitoring: Log failures for debugging

Troubleshooting

HTTP Request Fails

• Check network connectivity
• Verify CEP website is accessible
• Consider server location (latency)
• Review logs for detailed error messages

Timeout Errors

• Increase timeout in options
• Check network connectivity
• Verify CEP website is accessible

Invalid Response

• CEP website may have changed structure
• Verify form data is correct

No Results Found

• Verify payment date is correct
• Check tracking key/reference number
• Ensure bank codes are correct
• Confirm CLABE account matches
• Payment may not exist in system

Development

Running Tests

License

MIT License - See LICENSE file for details

Support

For issues, questions, or contributions, please feel free to open a GitHub issue.

Credits

Developed for Carlos Sosa.

Changelog

Version 1.0.0 (2025)

• Initial release
• Support for payment queries
• Bank options retrieval
• Laravel integration
• Comprehensive validation