reference
API reference
Base URL: https://sandbox.api.vermil.dev (sandbox) · https://api.vermil.dev (live). All endpoints require bearer authentication; mutating endpoints require an Idempotency-Key. The machine-readable spec is at /openapi.json — import it into Postman, Bruno or your generator of choice.
Payments
| POST | /v1/payments | Create a payment (idempotent; routes + falls back automatically) |
| GET | /v1/payments/:id | Retrieve a payment with its attempt timeline |
| GET | /v1/payments | Search payments (status, created range, cursor pagination) |
| POST | /v1/payments/:id/capture | Capture an authorized payment (partial allowed) |
| POST | /v1/payments/:id/void | Cancel an authorized, uncaptured payment |
| POST | /v1/payments/:id/refunds | Refund a captured payment (partial or remaining) |
Customers & payment methods
| POST | /v1/customers | Create a customer |
| GET | /v1/customers | List customers |
| POST | /v1/payment_methods | Tokenize a payment method at every eligible PSP |
| GET | /v1/payment_methods | List stored payment methods (filter by customer_id) |
| DELETE | /v1/payment_methods/:id | Revoke a token |
Routing
| POST | /v1/routing_rules | Create a rule (conditions + PSP chain) |
| GET | /v1/routing_rules | List rules by priority |
| PATCH | /v1/routing_rules/:id | Update a rule |
| DELETE | /v1/routing_rules/:id | Delete a rule |
| GET | /v1/psp_connections | List PSP connections with health |
| PATCH | /v1/psp_connections/:id | Enable / disable a connection |
Webhooks
| POST | /v1/webhook_endpoints | Register an endpoint (secret returned once) |
| GET | /v1/webhook_endpoints | List endpoints |
| GET | /v1/webhook_deliveries | Delivery log (filter by status) |
| POST | /v1/webhook_deliveries/:id/retry | Re-drive a delivery |