Skip to main content
GET
cURL

Overview

Release or cancel a payment request that is no longer needed. This endpoint allows you to free up resources and prevent further processing of payment requests that should not be completed.

API Endpoint

Authentication

  • HTTP Header: X-API-Key with your API key obtained from the dashboard
  • Content Type: application/json

Path Parameters

Use Cases

Order Cancellation

  • Customer Cancellation: Customer cancels order before payment
  • Inventory Issues: Product out of stock after payment request created
  • Pricing Errors: Incorrect pricing requires payment request cancellation
  • Duplicate Orders: Remove duplicate payment requests

System Management

  • Expired Requests: Clean up expired payment requests
  • Failed Validation: Release requests that fail business validation
  • Maintenance: System maintenance requiring payment request cleanup
  • Resource Management: Free up system resources

Response

Returns release confirmation including:

Release Information

  • Status: Release operation status
  • Released At: Timestamp when request was released
  • Reason: Release reason (if provided)
  • Refund Status: Refund processing status (if payment was captured)

Impact Assessment

  • Transactions Affected: List of related transactions
  • Refunds Initiated: Automatic refunds triggered
  • Notifications Sent: Customer notifications dispatched

Example Request

Example Response

Response Status Codes

Error Response Examples

Payment Request Not Found

Cannot Release Processed Payment

Release Operation Failed

Release States and Conditions

Releasable States

  • Pending: Payment request created but not processed
  • Waiting: Awaiting customer action
  • Expired: Payment request has expired
  • Failed: Payment processing failed

Non-Releasable States

  • Processing: Payment currently being processed
  • Completed: Payment successfully completed
  • Refunded: Payment already refunded
  • Cancelled: Payment request already cancelled

Implementation Examples

JavaScript/Node.js

Batch Release Operations

PHP Implementation

Integration Patterns

Order Management Integration

Automated Cleanup

Best Practices

When to Release

  • Order Cancellation: Always release when orders are cancelled
  • Inventory Issues: Release immediately when products become unavailable
  • Expired Requests: Regularly clean up expired payment requests
  • System Maintenance: Release pending requests before maintenance

Error Handling

  • Retry Logic: Implement retry for transient failures
  • Logging: Log all release operations for audit trails
  • Monitoring: Monitor release success rates
  • Alerting: Alert on high failure rates

Customer Communication

  • Immediate Notification: Notify customers of cancellations immediately
  • Clear Messaging: Explain why payment request was cancelled
  • Refund Timeline: Provide clear refund expectations
  • Support Contact: Offer support contact for questions

System Integration

  • Order Management: Integrate with order management systems
  • Inventory Systems: Connect to inventory management
  • Customer Service: Provide tools for support teams
  • Reporting: Include release metrics in reporting

Path Parameters

id
integer<int64>
required

Response

OK