BIEASES Payment API Overview
The BIEASES Payment API enables merchants to accept payments securely through a comprehensive REST API. This documentation provides everything you need to integrate payment processing into your application.
Quick Start
- Set up authentication - Configure RSA keys and AES encryption
- Create a payment - Initialize payment orders
- Handle webhooks - Receive real-time payment notifications
- Query payments - Check payment status and details
API Architecture
Payment Flow
- Create Payment Order → Generate checkout URL
- Customer Payment → Redirect to BIEASES checkout
- Webhook Notification → Receive payment status updates
- Query Status → Verify payment completion (optional)
Security Model
- RSA Digital Signatures - Request authenticity and integrity
- AES Encryption - Request body encryption for sensitive data
- HTTPS Only - All API calls must use secure connections
- Timestamp Validation - Prevent replay attacks
Base URLs
Environment | Base URL |
---|---|
Sandbox | https://app-sandbox.bieases.com |
Production | https://app.bieases.com |
Authentication
All API requests require:
- Merchant ID - Your unique merchant identifier
- RSA Signature - Digital signature of request parameters
- AES Encryption - Encrypted request body
- Timestamp - Request timestamp for replay protection
Learn more about authentication →
Core Endpoints
Payment Operations
- Create Payment -
POST /cgi/payment/api/v1/payment-order
- Query Payment -
POST /cgi/payment/api/v1/payment-order/query
- Cancel Payment -
POST /cgi/payment/api/v1/payment-order/cancel
- Refund Payment -
POST /cgi/payment/api/v1/payment-order/refund
Webhook Events
- Webhook Configuration - Real-time payment notifications
- Event Types - All supported webhook events
Response Format
All API responses follow a consistent structure:
{
"code": "20000",
"msg": "SUCCESS",
"data": {
// Response-specific data
}
}
Error Handling
- HTTP Status Codes - Standard HTTP status codes for request status
- Error Codes - BIEASES-specific error codes in response body
- Error Messages - Human-readable error descriptions
SDKs and Tools
Official SDKs
- Java SDK - Complete implementation with examples
- Python SDK - Coming soon
- Node.js SDK - Coming soon
Development Tools
- Postman Collection - Pre-configured API requests
- Sandbox Environment - Test your integration safely
- API Explorer - Interactive API testing
Support
- Documentation - Comprehensive guides and references
- Developer Support - Technical assistance for integration
- Status Page - Real-time API status and maintenance updates
Ready to get started? Begin with our authentication guide or jump directly to creating your first payment.