Payments API
Auto-generated from the OpenAPI spec. Run
node docs-site/scripts/fetch-openapi.jsto regenerate.
POST /api/v1/payments/stripe/checkout
Stripe Checkout
Request body
| Field | Required | Type | Description |
|---|---|---|---|
membership_type_id | Yes | integer | |
success_url | Yes | string | |
cancel_url | Yes | string |
Responses
- 200 — Successful Response
- 422 — Validation Error
POST /api/v1/payments/{payment_id}/refund
Refund Payment
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
payment_id | path | Yes | integer |
Responses
- 200 — Successful Response
- 422 — Validation Error
GET /api/v1/payments/{payment_id}
Get Payment
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
payment_id | path | Yes | integer |
Responses
- 200 — Successful Response
- 422 — Validation Error
GET /api/v1/payments
List Payments
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
client_id | query | No | integer | |
page | query | No | integer | |
page_size | query | No | integer |
Responses
- 200 — Successful Response
- 422 — Validation Error
POST /api/v1/payments
Record Manual Payment
Request body
| Field | Required | Type | Description |
|---|---|---|---|
client_id | Yes | integer | |
membership_id | No | integer | |
amount | Yes | number | |
currency | No | string | |
provider | No | string | |
notes | No | string |
Responses
- 201 — Successful Response
- 422 — Validation Error