Base URL
Authentication
All requests require a Bearer token with your API key:Response format
All responses are JSON. Successful responses return the resource directly. Errors return anerror field:
Pagination
List endpoints supportlimit and offset query parameters:
| Parameter | Type | Default | Max | Description |
|---|---|---|---|---|
limit | integer | 50 | 100 | Number of items to return |
offset | integer | 0 | — | Number of items to skip |
total, limit, and offset fields.
Status codes
| Code | Description |
|---|---|
200 | Success |
201 | Resource created |
400 | Invalid request parameters |
401 | Authentication failed |
402 | Payment authorization failed |
403 | Forbidden (suspended org or missing scope) |
404 | Resource not found |
409 | Conflict (e.g. duplicate cardholder email) |
422 | Payment method required |
429 | Rate limit exceeded |
500 | Internal server error |
502 | Provider error (card close failed at Stripe) |
Endpoints
Cards
| Method | Path | Description |
|---|---|---|
POST | /cards | Create a card |
GET | /cards | List cards |
GET | /cards/:id | Get a card |
GET | /cards/:id/details | Get card details (PAN/CVV) |
DELETE | /cards/:id | Close a card |
Cardholders
| Method | Path | Description |
|---|---|---|
POST | /cardholders | Create a cardholder |
GET | /cardholders | List cardholders |
GET | /cardholders/:id | Get a cardholder |
PATCH | /cardholders/:id | Update a cardholder |
POST | /cardholders/:id/payment-method/setup | Setup payment method |
GET | /cardholders/:id/payment-method/status | Get payment method status |