Listing Payment Links

You can list payment links using various query parameters. The response will provide detailed information about the payment links.

Headers

• Authorization: Bearer YOUR_SECRET_KEY
• Content-Type: application/json

Query Parameters

• start_date: string (optional) - Start date for listing payment links (format: YYYY-MM-DD).
• end_date: string (optional) - End date for listing payment links (format: YYYY-MM-DD).

Sample Request to List Payment Links

1. List Payment Links using Date Range

cURL

curl -X GET "https://api.zuripay.app/v1/links/list?start_date=2023-01-01&end_date=2023-01-31" \
-H "Authorization: Bearer zp_test_26PHem9AhJZvU623DfE1x4sd" \
-H "Content-Type: application/json"

Python

import requests

url = "https://api.zuripay.app/v1/links/list"

params = {
    "start_date": "2023-01-01",
    "end_date": "2023-01-31"
}

headers = {
    "Authorization": "Bearer zp_test_26PHem9AhJZvU623DfE1x4sd",
    "Content-Type": "application/json"
}

response = requests.get(url, headers=headers, params=params)

if response.status_code == 200:
    print("Payment link details:", response.json())
else:
    print("Error:", response.status_code, response.text)

2. List Last 100 Payment Links

cURL

curl -X GET "https://api.zuripay.app/v1/links/list?limit=100" \
-H "Authorization: Bearer zp_test_26PHem9AhJZvU623DfE1x4sd" \
-H "Content-Type: application/json"

Python

import requests

url = "https://api.zuripay.app/v1/links/list"

params = {
    "limit": 100
}

headers = {
    "Authorization": "Bearer zp_test_26PHem9AhJZvU623DfE1x4sd",
    "Content-Type": "application/json"
}

response = requests.get(url, headers=headers, params=params)

if response.status_code == 200:
    print("Payment link details:", response.json())
else:
    print("Error:", response.status_code, response.text)

Sample Responses

Successful Listing (200)

{
    "result": "success",
    "payment_links": [
        {
            "payment_link_id": "zp_link_1234567890",
            "amount": "100.00",
            "currency": "USD",
            "message": "Payment link listed successfully.",
            "details": {}
        }
    ]
}

Bad Request (400)

{
    "result": "error",
    "message": "Invalid request parameters."
}

Unauthorized (401)

{
    "result": "error",
    "message": "Unauthorized. Please provide a valid API key."
}

Internal Server Error (500)

{
    "result": "error",
    "message": "Internal server error. Please try again later."
}