API coverage map
Every operation in the Jeeves Public API, and where to learn it. Each endpoint appears in at least one recipe of the flow builder and links to its entry in the API reference.
Cards
| Method | Endpoint | Summary | Scope | Flow-builder block |
|---|---|---|---|---|
| GET | /v1/cards | List all cards | cards:read | List & retire cards |
| POST | /v1/cards | Create a card | cards:write | Issue virtual cards |
| GET | /v1/cards/{id} | Retrieve a card | cards:read | Issue virtual cards |
| PATCH | /v1/cards/{id} | Update a card | cards:write | Spend controls & MCC |
| DELETE | /v1/cards/{id} | Delete a card | cards:write | List & retire cards |
| POST | /v1/cards/transactions | Retrieve card or travel transactions | transactions:read | Reconcile card & travel transactions |
| GET | /v1/cards/mcc/categories | List all MCC categories | cards:read | Spend controls & MCC |
Travel
| Method | Endpoint | Summary | Scope | Flow-builder block |
|---|---|---|---|---|
| GET | /v1/travel/transactions | Get transactions — deprecated, use POST /v1/cards/transactions with source: travel | transactions:read | Reconcile card & travel transactions (migration step) |
| PATCH | /v1/travel/cards/{id}/booking | Update booking details | cards:write | Attach booking details |
Transactions
| Method | Endpoint | Summary | Scope | Flow-builder block |
|---|---|---|---|---|
| GET | /v1/transactions | Get a list of card transactions — deprecated, use POST /v1/cards/transactions with source: cards | transactions:read | Reconcile card & travel transactions (migration step) |
| GET | /v1/payments/transactions | Get a list of payment transactions | transactions:read | Export payment transactions |
Boletos — receivables (Brazil)
| Method | Endpoint | Summary | Scope | Flow-builder block |
|---|---|---|---|---|
| GET | /v1/boletos | List Boletos | boletos:read | Collect via boleto (Brazil) |
| POST | /v1/boletos | Create Boleto | boletos:write | Collect via boleto (Brazil) |
| GET | /v1/boletos/{id} | Get Boleto by ID | boletos:read | Collect via boleto (Brazil) |
| POST | /v1/boletos/{id}/cancel | Cancel Boleto | boletos:write | Collect via boleto (Brazil) |
| POST | /v1/boletos/{id}/extend | Extend Boleto | boletos:write | Collect via boleto (Brazil) |
| POST | /v1/boletos/{id}/discount | Configure Boleto Discount | boletos:write | Collect via boleto (Brazil) |
| POST | /v1/boletos/{id}/discount/remove | Remove Boleto Discount | boletos:write | Collect via boleto (Brazil) |
| POST | /v1/boletos/{id}/rebate | Reduce Boleto Amount | boletos:write | Collect via boleto (Brazil) |
| POST | /v1/boletos/{id}/rebate/cancel | Restore Boleto Original Amount | boletos:write | Collect via boleto (Brazil) |
Pix Charges — receivables (Brazil)
| Method | Endpoint | Summary | Scope | Flow-builder block |
|---|---|---|---|---|
| GET | /v1/pix-charges | List Pix Charges | pix_charges:read | Collect via Pix (Brazil) |
| POST | /v1/pix-charges | Create Pix Charge | pix_charges:write | Collect via Pix (Brazil) |
| GET | /v1/pix-charges/{id} | Get Pix Charge by ID | pix_charges:read | Collect via Pix (Brazil) |
| POST | /v1/pix-charges/{id}/cancel | Cancel Pix Charge | pix_charges:write | Collect via Pix (Brazil) |
Webhooks
| Method | Endpoint | Summary | Scope | Flow-builder block |
|---|---|---|---|---|
| POST | /v1/webhooks/subscriptions | Create subscription | webhooks:write | Receive real-time card events |
| GET | /v1/webhooks/subscriptions | List subscriptions | webhooks:read | Operate & monitor webhooks |
| GET | /v1/webhooks/subscriptions/{id} | Get subscription | webhooks:read | Operate & monitor webhooks |
| PATCH | /v1/webhooks/subscriptions/{id} | Update subscription | webhooks:write | Operate & monitor webhooks |
| DELETE | /v1/webhooks/subscriptions/{id} | Delete subscription | webhooks:write | Operate & monitor webhooks |
| POST | /v1/webhooks/subscriptions/{id}/rotate-secret | Rotate secret | webhooks:write | Operate & monitor webhooks |
| POST | /v1/webhooks/subscriptions/{id}/test | Send test delivery | webhooks:write | Receive real-time card events |
| GET | /v1/webhooks/events | List events | webhooks:read | Operate & monitor webhooks |
| GET | /v1/webhooks/events/{id} | Get event | webhooks:read | Operate & monitor webhooks |
| GET | /v1/webhooks/events/{id}/deliveries | List deliveries | webhooks:read | Operate & monitor webhooks |
| POST | /v1/webhooks/events/{id}/retry | Retry event | webhooks:write | Operate & monitor webhooks |
Total: 35 operations — 7 Cards, 2 Travel, 2 Transactions, 9 Boletos, 4 Pix Charges, 11 Webhooks. Deep-dive material for webhooks lives in the Webhooks integration guide.
Payment API
A separate spec (reference) covering money movement: quotes, idempotent payments, and signed status webhooks. Interactive version: Build your payment flow.
| Method | Endpoint | Summary | Scope | Where documented |
|---|---|---|---|---|
| POST | /oauth/token | Get an access token | — (Basic auth) | Send a payment |
| GET | /v1/product-accounts | List funding (product) accounts | accounts:read | Funding accounts |
| GET | /v1/beneficiaries | List beneficiaries | beneficiaries:read | Beneficiaries |
| POST | /v1/quotes | Create a quote | quotes:write | Quotes & FX |
| POST | /v1/payments | Create a payment | payments:write | Send a payment · Scheduled payments |
| GET | /v1/payments/{paymentId} | Get a payment | payments:read | Tracking & webhooks |
| WEBHOOK | payment.status.updated | Payment status updated | — | Tracking & webhooks |