ZuriPay
API Docs

Listing Callbacks

Security Note: Callbacks can only be managed using your Secret API Key, not your Public Key. This is for security purposes, as callbacks have access to sensitive event data.

You can list all callbacks registered in your account. The response will provide detailed information about each callback including the URL, subscribed events, and status.

Headers

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

Query Parameters

  • limit: number (optional) - Limit the number of results returned.
  • skip: number (optional) - Skip a number of results for pagination.

Sample Request to List Callbacks

curl -X GET "https://api.zuripay.app/v1/callback/list?limit=50&skip=0" \
-H "Authorization: Bearer zp_test_26PHem9AhJZvU623DfE1x4sd" \
-H "Content-Type: application/json"

Sample Responses

{
    "result": "success",
    "callbacks": [
        {
            "id": "zp_callback_1234567890",
            "url": "https://example.com/webhooks/payments",
            "description": "Payment notification endpoint",
            "events": ["payment.created", "payment.updated", "payment.completed"],
            "is_active": true,
            "failure_count": 0,
            "last_triggered": "2023-01-16T10:45:30Z",
            "date_created": "2023-01-15T14:30:45Z",
            "date_updated": "2023-01-15T14:30:45Z"
        },
        {
            "id": "zp_callback_0987654321",
            "url": "https://example.com/webhooks/payouts",
            "description": "Payout notification endpoint",
            "events": ["payout.created", "payout.completed"],
            "is_active": true,
            "failure_count": 2,
            "last_triggered": "2023-02-22T09:15:30Z",
            "date_created": "2023-02-20T09:15:30Z",
            "date_updated": "2023-02-20T09:15:30Z"
        }
    ],
    "total_count": 2,
    "message": "Callbacks listed successfully."
}