API Reference

Zoxupay API provides complete payment solutions, supporting payment services in multiple regions.

Regional APIs

Philippines API

Complete payment and payout solutions, including:

• Getting Started - Basic configuration and environment setup
• Signature - Request signature algorithm
• Error Code - Error code description
• Create Cashier - Cashier payment page
• Collection - Direct collection API
• Collection Query - Query collection status
• Payment - Payout service
• Payment Query - Query payout status
• Notification - Payment result notification
• Balance Query - Account balance query
• Bank List - Supported bank list

Bangladesh API

Localized payment services, including:

• Getting Started - Basic configuration and environment setup
• Signature - Request signature algorithm
• Error Code - Error code description
• Create Cashier - Cashier payment page
• Collection - Direct collection API
• TrxID Submit - Transaction ID submission
• Payment Query - Query payment status
• Payout - Payout service
• Payout Query - Query payout status
• Notification - Payment result notification
• Balance Query - Account balance query

Myanmar API

Localized payment services, including:

• Getting Started - Basic configuration and environment setup
• Signature - Request signature algorithm
• Error Code - Error code description
• Create Cashier - Cashier payment page
• Collection - Direct collection API
• TrxID Submit - Transaction ID submission
• Payment Query - Query payment status
• Payout - Payout service
• Payout Query - Query payout status
• Notification - Payment result notification
• Balance Query - Account balance query

Pakistan API

E-wallet and bank transfer payment services, including:

• Getting Started - Basic configuration and environment setup
• Signature - Request signature algorithm
• Error Code - Error code description
• Create Cashier - Cashier payment page
• Collection - Direct collection API
• Payment Query - Query collection status
• Payout - Payout service
• Payout Query - Query payout status
• Notification - Payment result notification
• Balance Query - Account balance query
• Bank List - Supported bank list

Mexico API

Localized collection and payout services, including:

• Getting Started - Basic configuration and environment setup
• Signature - Request signature algorithm
• Error Code - Error code description
• Create Cashier - Cashier payment page
• Collection - Direct collection API
• Payment Query - Query collection status
• Payout - Payout service
• Payout Query - Query payout status
• Notification - Payment result notification
• Balance Query - Account balance query
• Bank List - Supported bank list

General Specifications

Request Format

All API requests use HTTP POST. Follow the request examples on each regional interface page for the exact request body format; the current documentation examples use JSON bodies.

Signature Verification

All requests must include x-access-key and signature in the HTTP headers to verify request integrity and security. For the detailed signing rules, refer to the signature page for the corresponding region.

Response Format

API responses use JSON format:

{
  "code": "00000",
  "message": "success",
  "timestamp": 1742205607984,
  "success": true,
  "data": {
    // specific data
  }
}

Status Codes

• code = 00000 means the request was accepted, not that the transaction is finally successful
• Other business error codes are usually 5-digit values; refer to the corresponding regional error code page
• Determine the final transaction result by reading success, code, and data.orderStatus together

Get Started

1. Choose the regional API you need
2. Read the corresponding getting started documentation
3. Understand the signature mechanism
4. Call the appropriate interface based on business needs

For technical support, please contact: zoxupay@zoxupay.com