Payments API
Payment integration API for connecting payment processing, checking payment availability, and reading connection status.
Generated from the Celerp 2.5.0 OpenAPI schema, 21 September 2026.
POST /payments/connect
Connect Payment Processing
Start the payment-provider connection flow.
Responses
| Status | Description | Body |
|---|---|---|
200 | Returns the URL to open to finish connecting. | object |
Example
curl -X POST http://localhost:8000/payments/connect \
-H "Authorization: Bearer $TOKEN"POST /payments/disconnect
Disconnect Payment Processing
Disconnect the company's payment integration.
Responses
| Status | Description | Body |
|---|---|---|
200 | Returns `disconnected: true`. | object |
Example
curl -X POST http://localhost:8000/payments/disconnect \
-H "Authorization: Bearer $TOKEN"GET /payments/enabled
Check Payment Processing Availability
Return whether integrated payment processing is currently available for this Celerp installation.
Responses
| Status | Description | Body |
|---|---|---|
200 | Returns `enabled: true` or `enabled: false`. | object |
Example
curl -X GET http://localhost:8000/payments/enabled \
-H "Authorization: Bearer $TOKEN"GET /payments/status
Get Payment Integration Status
Return the current payment integration status for the company.
Responses
| Status | Description | Body |
|---|---|---|
200 | Returns the requested payment integration status result. | object |
Example
curl -X GET http://localhost:8000/payments/status \
-H "Authorization: Bearer $TOKEN"