Endpoints
This page covers the public integration API: operations an environment-bound API key can call. Dashboard-only and platform-operator routes are intentionally omitted. For request schemas, response status codes, and parameters, use the live OpenAPI 3.1 document.
Idem means an idempotency-key header is mandatory.
Payments
| Method | Path | Scope | Idem |
|---|---|---|---|
| POST | /v1/orders | orders:write | ✓ |
| GET | /v1/orders, /v1/orders/{id} | payments:read | |
| POST | /v1/payment-intents | payments:write | ✓ |
| GET | /v1/payment-intents, /v1/payment-intents/{id} | payments:read | |
| POST | /v1/payment-intents/{id}/confirm, /capture, /cancel | payments:write | ✓ |
| POST | /v1/refunds | refunds:write | ✓ |
| GET | /v1/refunds, /v1/refunds/{id} | payments:read | |
| GET | /v1/route-decisions/{id}, /v1/risk-decisions/{id} | payments:read |
Sellers, fulfilment, and payouts
| Method | Path | Scope | Idem |
|---|---|---|---|
| GET, POST | /v1/sellers | trust:read / trust:write | POST ✓ |
| GET | /v1/sellers/{id}, /{id}/attestations, /{id}/channels | trust:read | |
| POST | /v1/sellers/{id}/status, /{id}/attestations | trust:write | ✓ |
| GET, POST | /v1/beneficiaries | trust:read / trust:write | POST ✓ |
| GET | /v1/beneficiaries/{id} | trust:read | |
| GET, POST | /v1/beneficiary-changes | trust:read / beneficiary_changes:request | POST ✓ |
| GET | /v1/beneficiary-changes/{id} | trust:read | |
| POST | /v1/beneficiary-changes/{id}/cancel | beneficiary_changes:request | ✓ |
| GET, POST | /v1/fulfillment-sources | trust:read / trust:write | See OpenAPI |
| GET, POST | /v1/fulfillment-events | trust:read / trust:write | POST ✓ |
| GET | /v1/fulfillment-events/{id}, /v1/fulfillment-ingestions/{id} | trust:read | |
| GET, POST | /v1/verified-commerce-envelopes | trust:read / trust:write | POST ✓ |
| GET | /v1/verified-commerce-envelopes/{id} | trust:read | |
| GET, POST | /v1/payout-instructions | trust:read / payouts:write | POST ✓ |
| GET | /v1/payout-instructions/{id} | trust:read | |
| POST | /v1/payout-instructions/{id}/cancel | payouts:write | ✓ |
Operations requiring an interactive approval—such as approving or releasing a payout—stay in the dashboard and are not part of the integration API.
Cases
| Method | Path | Scope | Idem |
|---|---|---|---|
| POST | /v1/incidents | cases:write | ✓ |
| GET | /v1/incidents | cases:read | |
| GET | /v1/cases/{id} | cases:read | |
| POST | /v1/cases/{id}/advance, /resolve, /actions, /appeal, /appeal-link | cases:write | ✓ |
| GET, POST | /v1/cases/{id}/evidence | cases:read / cases:write | POST ✓ |
| GET | /v1/cases/{id}/evidence/{evidenceId}, /content | cases:read | |
| POST | /v1/cases/{id}/evidence/{evidenceId}/status | cases:write | ✓ |
| GET | /v1/appeals/{id} | cases:read |
Read-only operational data
| Method | Path | Scope |
|---|---|---|
| GET | /v1/webhook-endpoints, /{id}, /{id}/deliveries, /v1/webhook-inbox | webhooks:read |
| GET | /v1/policies, /templates, /{id} | policies:read |
| GET | /v1/insights/funnel, /savings, /savings/{id}, /imports, /imports/{id} | insights:read |
| GET | /v1/recon/files, /files/{id}, /exceptions, /exceptions/aging, /exceptions/{id} | recon:read |
| GET | /v1/quickstart | payments:read |
| GET | /v1/demo/seed | trust:read |
The OpenAPI document is generated from the live route table and is the authoritative operation list. If an operation is absent there, do not build an integration against it.