Payments API
Manage transactions, payment plans, and checkout sessions.
Payment Plans
Create Payment Plan
Shell
POST /api/v1/projects/{projectId}/payment-plansJSON
{
"name": "Premium Plan",
"recipientAddress": "0x...",
"paymentOptions": [
{
"networkId": "ethereum-sepolia",
"tokenAddress": "0x...",
"amount": "10.00"
}
],
"redirectUrl": "https:">//your-site.com/success",
"quoteTtl": 300
}List Payment Plans
Shell
GET /api/v1/projects/{projectId}/payment-plansGet Payment Plan
Shell
GET /api/v1/projects/{projectId}/payment-plans/{planId}Transactions
List Transactions
Shell
GET /api/v1/projects/{projectId}/transactions?page=1&limit=20Query parameters:
| Parameter | Type | Description |
|---|---|---|
page | number | Page number (default: 1) |
limit | number | Items per page (default: 20) |
status | string | Filter by status: pending, completed, failed |
network | string | Filter by network key |
Get Transaction
Shell
GET /api/v1/projects/{projectId}/transactions/{transactionId}Transaction Statuses
| Status | Description |
|---|---|
pending | Transaction submitted, awaiting confirmation |
completed | Transaction confirmed on-chain |
failed | Transaction reverted or timed out |
Checkout Sessions
Create Checkout Session
This endpoint is public — no API key or session token required.
Shell
POST /api/v1/checkout/sessionsJSON
{
"paymentPlanId": "your-payment-plan-id",
"email": "customer@example.com",
"metadata": {
"orderId": "order_123"
}
}Get Checkout Session
Shell
GET /api/v1/checkout/sessions/{sessionId}