Skip to main content

Payment Operations

This section covers all payment-related API operations that enable you to manage the complete payment lifecycle.

Payment Lifecycle​

The BIEASES payment system follows a standard e-commerce payment flow:

  1. Create Payment - Initialize a new payment order
  2. Customer Checkout - Redirect customer to BIEASES payment page
  3. Query Payment - Check payment status and details
  4. Cancel Payment - Cancel unpaid orders (optional)
  5. Refund Payment - Process refunds for completed payments

Available Operations​

OperationEndpointPurpose
Create PaymentPOST /cgi/payment/api/v1/payment-orderInitialize new payment orders
Query PaymentPOST /cgi/payment/api/v1/payment-order/queryRetrieve payment status and details
Cancel PaymentPOST /cgi/payment/api/v1/payment-order/cancelCancel pending payment orders
Refund PaymentPOST /cgi/payment/api/v1/payment-order/refundProcess full or partial refunds
Query RefundPOST /cgi/payment/api/v1/payment-order/refund/queryCheck refund status

Common Use Cases​

Basic Payment Flow​

  1. Create payment order with order details
  2. Redirect customer to checkout URL
  3. Handle webhook notifications for payment completion
  4. Query payment status for confirmation

Payment Management​

  • Order Cancellation: Cancel orders before customer payment
  • Refund Processing: Handle returns and refunds
  • Status Monitoring: Track payment progress and completion

Error Handling​

  • Network Failures: Use query APIs to verify payment status
  • Timeout Management: Handle payment expiration scenarios
  • Retry Logic: Implement appropriate retry mechanisms for failed requests

Next Steps: Start with creating your first payment or learn about webhook notifications.