Introduction

API Introduction

Welcome to our API documentation! Our API is designed to provide seamless and secure access to our services, allowing developers to integrate and interact with our platform programmatically. Whether you are building an application, automating workflows, or accessing data, our API offers a robust set of endpoints that cater to various needs.

Key Features:

Authentication: Secure your API calls with our API key authentication mechanism to ensure that only authorized users have access.
Data Interchange: Easily send and receive data in JSON format, enabling efficient communication between your application and our services.
Error Handling: Our API provides clear and consistent error messages, making it easier for you to troubleshoot and resolve any issues.

Getting Started:

API Key: Obtain your unique API key by signing up for an account. This key is required for all API requests.
Endpoints: Explore the available endpoints to understand the capabilities of our API and how you can leverage them for your use case.
Request Format: All API requests should be made using the POST method with data formatted as JSON.
Response Handling: The API responses are returned in JSON format, with appropriate HTTP status codes to indicate the success or failure of your request.

We are committed to ensuring that our API is easy to use and well-documented, so you can focus on building great applications. If you have any questions or need further assistance, our support team is always here to help. Happy coding!

Create a Payment Request

POST /v1/payment

Create a new payment request.

// Example request
POST /v1/payment HTTP/1.1
Host: api.mydomain.com
X-API-KEY: your_api_key_here
Content-Type: application/json

{
    "amount": 100.0,
    "currency": "USD",
    "description": "Payment for services"
}

// Example response
{
    "status": true,
    "message": "Payment request created successfully",
    "data": {
        "id": 1,
        "amount": 100.0,
        "currency": "USD",
        "description": "Payment for services",
        "status": "pending"
    }
}

Retrieve All Payment Requests

GET /v1/payments

Retrieve a list of all payment requests.

// Example request
GET /v1/payments HTTP/1.1
Host: api.mydomain.com
X-API-KEY: your_api_key_here

// Example response
{
    "status": true,
    "data": [
        {
            "id": 1,
            "amount": 100.0,
            "currency": "USD",
            "description": "Payment for services",
            "status": "pending"
        },
        {
            "id": 2,
            "amount": 50.0,
            "currency": "USD",
            "description": "Payment for products",
            "status": "completed"
        }
    ]
}

Retrieve Payment Request Details

GET /v1/payment/{id}

Retrieve the details of a specific payment request.

// Example request
GET /v1/payment/1 HTTP/1.1
Host: api.mydomain.com
X-API-KEY: your_api_key_here

// Example response
{
    "status": true,
    "data": {
        "id": 1,
        "amount": 100.0,
        "currency": "USD",
        "description": "Payment for services",
        "status": "pending"
    }
}

Delete a Payment Request

DELETE /v1/payment/{id}

Delete a specific payment request.

// Example request
DELETE /v1/payment/1 HTTP/1.1
Host: api.mydomain.com
X-API-KEY: your_api_key_here

// Example response
{
    "status": true,
    "message": "Payment request deleted successfully"
}