Square
Square payments: donations and checkout.
partLines of business17 operationsid square
How it sits
A part does one thing, and any other part can call it. The counts and the links below are from the platform's spec and the other services' own descriptions.
| Operations | 17 GET 11 · POST 6 |
| Resources | 10 |
| Leaned on by | Billing |
| Leans on | none named |
| In recipes | none yet |
What it can do
17 operations in 10 resources, as the spec declares them. Each row is one call; paths are relative to the part.
invoices
| Method | Path | Does |
|---|---|---|
| GET | /api/v1/invoices | List Square invoices (optionally per customer) |
| POST | /api/v1/invoices | Create a Square invoice (draft, or published) |
| GET | /api/v1/invoices/{invoice_id} | Get one Square invoice |
| POST | /api/v1/invoices/{invoice_id}/cancel | Cancel a published invoice |
| POST | /api/v1/invoices/{invoice_id}/publish | Publish (send) a draft invoice |
5 operations
customers
| Method | Path | Does |
|---|---|---|
| POST | /api/v1/customers | Create-or-find a Square customer by reference_id |
| GET | /api/v1/customers/{customer_id} | Get one Square customer |
2 operations
health
| Method | Path | Does |
|---|---|---|
| GET | /health | Basic health check |
| GET | /health/detailed | Detailed health check |
2 operations
payments
| Method | Path | Does |
|---|---|---|
| GET | /api/v1/payments | List recent payments |
| GET | /api/v1/payments/{payment_id} | Get one payment |
2 operations
checkout
| Method | Path | Does |
|---|---|---|
| POST | /api/v1/checkout | Create a hosted donation/checkout link |
1 operation
config
| Method | Path | Does |
|---|---|---|
| GET | /api/v1/config | Square wiring status |
1 operation
invoice-status
| Method | Path | Does |
|---|---|---|
| GET | /api/v1/invoice-status/{reference} | Invoice status + recorded webhook events by caller reference |
1 operation
prime
| Method | Path | Does |
|---|---|---|
| GET | /prime | Prime application caches |
1 operation
status
| Method | Path | Does |
|---|---|---|
| GET | /status | Service status overview |
1 operation
webhooks
| Method | Path | Does |
|---|---|---|
| POST | /api/v1/webhooks/square | Receive a Square webhook |
1 operation
All the partsLines of businessThe platform's own id for this service is cbsquare.
forge-catalog.json, generated Oct 30, 2026