Documentation
API reference
Endpoints, parameters and schemas, generated from the live OpenAPI specification of the sandbox.
Base URL (sandbox)
http://localhost:4610/v1
Resources at a glance
The main objects of the API and the operations available on each.
| Resource | Path | Operations |
|---|---|---|
| Payment Intents | /v1/payment_intents | create · retrieve · list · confirm · capture · cancel |
| Checkout Sessions | /v1/checkout/sessions | create · retrieve · list · expire |
| Payment Links | /v1/payment_links | create · retrieve · list · update |
| Refunds | /v1/refunds | create · retrieve · list |
| Customers | /v1/customers | create · retrieve · list · update |
| Balance | /v1/balance | retrieve (pending · available · reserved · in transit) |
| Payouts | /v1/payouts | create · retrieve · list · cancel |
| Bank Accounts | /v1/bank_accounts | retrieve · list (read-only via API; changes in the dashboard) |
| Events | /v1/events | retrieve · list |
| Webhook Endpoints | /v1/webhook_endpoints | create · retrieve · list · update · delete |
| Products | /v1/products | create · retrieve · list · update |
| Prices | /v1/prices | create · retrieve · list |
| Subscriptions | /v1/subscriptions | create · retrieve · list · update · cancel |
| Invoices | /v1/invoices | retrieve · list · pay |
| Accounts (Connect) | /v1/accounts | create · retrieve · list |
| Transfers (Connect) | /v1/transfers | create · retrieve · list · reverse |
Endpoints from the OpenAPI specification
Loading the specification…