Working with our APIs
API Introduction
Working with our APIs
API Introduction
Welcome to the xPay API documentation! Here, you’ll find everything you need to get started with integrating our payment solutions into your application.
Base API URL
The base URL for all xPay API requests is:
Available APIs
Here’s a list of the key APIs you can integrate with:
| API Name | Endpoint | Description | Documentation |
|---|---|---|---|
| Create Intent | /payments/create-intent | Initiates a payment intent with necessary transaction details. | Create Intent API |
| Get Intent | /payments/get-intent/{xIntentId} | Retrieves the status and details of a payment intent. | Get Intent API |
| Payment Links | /link/merchant/generate-link | Generates a payment link for a specific amount. | Payment Links API |
| Refund | /payments/merchant/refund | Processes a refund for a specified payment intent. | Refund API |
| Cancel Payment | /payments/cancel/{xIntentId} | Cancels a payment. | Cancel Payment API |
| Create Subscription | /subscription/create | Create a subscription for a customer. | Create Subscription API |
| Get Subscription | /subscription/get-subscription/{subscriptionId} | Retrieves the details of a subscription. | Get Subscription API |
| Cancel Subscription | /subscription/merchant/cancel | Cancels a subscription. | Cancel Subscription API |
| Subscription Links | /subscription/link/merchant/generate-link | Generates a subscription link for a specific amount. | Generate Subscription Link |
Postman Collection
To help you get started quickly, we have prepared a Postman collection containing all the available APIs. Click the button below to access it:
Feel free to explore the APIs and reach out at hello@xpaycheckout.com if you have any questions or need further assistance!
Was this page helpful?