u
This commit is contained in:
58
docs/api/routes/order/_id/payment.post.md
Normal file
58
docs/api/routes/order/_id/payment.post.md
Normal file
@@ -0,0 +1,58 @@
|
||||
# `POST /order/{id}/payment`
|
||||
|
||||
Protected. Requires a valid session cookie (`credentials: 'include'`).
|
||||
|
||||
Add payment to an order
|
||||
|
||||
Adds a payment to the order using an account of the selected company.
|
||||
|
||||
## Path parameters
|
||||
|
||||
| Param | Required | Type | Description |
|
||||
|-------|----------|------|-------------|
|
||||
| `id` | yes | integer | Order ID |
|
||||
|
||||
## Body (JSON)
|
||||
|
||||
| Field | Required | Type | Description |
|
||||
|-------|----------|------|-------------|
|
||||
| `accountId` | yes | integer | |
|
||||
| `type` | yes | string | |
|
||||
| `amount` | yes | number | |
|
||||
|
||||
```json
|
||||
{
|
||||
"accountId": 1,
|
||||
"type": "…",
|
||||
"amount": 1
|
||||
}
|
||||
```
|
||||
|
||||
## Response `201`
|
||||
|
||||
Created payment
|
||||
|
||||
```json
|
||||
{
|
||||
"payment": {
|
||||
"id": 1,
|
||||
"accountId": 1,
|
||||
"manifestId": 1,
|
||||
"type": "…",
|
||||
"amount": 1
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## Errors
|
||||
|
||||
| Status | Description |
|
||||
|--------|-------------|
|
||||
| 400 | Validation error or no company selected — `{"error":"…"}` |
|
||||
| 401 | Unauthorized — `{"error":"…"}` |
|
||||
| 403 | Not authorized — `{"error":"…"}` |
|
||||
| 404 | Order or account not found — `{"error":"…"}` |
|
||||
|
||||
---
|
||||
|
||||
_Generated from `@openapi` JSDoc. Do not edit by hand — run `npm run docs:api`._
|
||||
Reference in New Issue
Block a user