Quickstart Guide
Accept your first zkPay payment in less than 5 minutes.
1
Get your API Keys
To authenticate your requests, you'll need an API key. You can generate one in the Developer Console.
- Go to the Developer Console.
- Navigate to the API Keys tab.
- Click Generate Key.
- Copy your new secret key (e.g.,
sk_test_...).
2
Create a Payment Request
Use your API key to request a payment from a user's zkPay handle.
cURL Request
curl -X POST https://api.zkpay.me/v1/payment \
-H "Authorization: Bearer sk_test_12345..." \
-H "Content-Type: application/json" \
-d '{
"zkpay_handle": "alice@zkpay.me",
"amount": 50.00,
"currency": "USD",
"merchant_id": "store_123",
"description": "Premium Subscription"
}'Note: In this demo environment, the endpoint is
/api/payment and does not enforce Bearer token checks yet.3
Handle the Response
The API will return the status of the payment immediately.
JSON Response
{
"success": true,
"payment_id": "pay_8a7b9c...",
"status": "COMPLETED",
"requires_approval": false,
"message": "Payment successful via Visa ****4242"
}