Overview
Retrieve comprehensive details about a specific payment request, including its current status, customer information, and transaction data.API Endpoint
Authentication
- HTTP Header:
X-API-Key
with your API key obtained from the dashboard - Content Type:
application/json
Path Parameters
Parameter | Description | Type | Required |
---|---|---|---|
id | Payment request identifier | integer (int64) | YES |
Response
Returns complete payment request information including:Payment Request Details
- ID: Unique payment request identifier
- Status: Current payment request status
- Amount: Transaction amount and currency
- Reference: Merchant reference ID
- Created Date: When the payment request was created
- Updated Date: Last modification timestamp
Customer Information
- Customer ID: Associated customer identifier
- Name: Customer full name
- Email: Customer email address
- Phone: Customer phone number
- Address: Billing/shipping address details
Payment Configuration
- Payment Methods: Available payment options
- Callback URLs: Success, failure, and notification URLs
- Expiration: Payment request expiration time
- Currency: Transaction currency code
Example Request
Example Response
Response Status Codes
Code | Description |
---|---|
200 | OK - Payment request found and returned |
400 | Bad Request - Invalid request format |
401 | Unauthorized - Invalid API key |
404 | Not Found - Payment request not found |
500 | Internal Server Error - Server error occurred |
Error Response Format
Use Cases
Order Management
- Order Tracking: Link payment requests to order management systems
- Status Monitoring: Track payment progress in real-time
- Customer Support: Provide payment details for support inquiries
Integration Scenarios
- E-commerce Platforms: Retrieve payment details for order fulfillment
- Mobile Apps: Display payment status to customers
- Admin Dashboards: Monitor payment request details
- Reporting Systems: Generate payment reports and analytics
Implementation Example
JavaScript/Node.js
PHP
Best Practices
Security
- API Key Protection: Keep API keys secure and rotate regularly
- HTTPS Only: Always use HTTPS for API communications
- Rate Limiting: Implement appropriate rate limiting
- Input Validation: Validate payment request IDs before making requests
Performance
- Caching: Cache payment request details when appropriate
- Error Handling: Implement robust error handling and retry logic
- Monitoring: Monitor API response times and success rates
- Pagination: Use pagination for bulk payment request retrieval
Integration
- Webhook Integration: Use webhooks for real-time status updates instead of constant polling
- Status Mapping: Map payment request statuses to your system’s workflow
- Logging: Log all API interactions for debugging and audit purposes
- Testing: Test with various payment request states and edge cases
Related Endpoints
- Create Payment Request: Create new payment requests
- Payment Status Check: Check payment status
- Handle Payment Request: Handle payment with specific method
- Release Payment Request: Release payment request
Path Parameters
Response
OK