Error
A valid request URL is required to generate request examples{
"id": "dep-ok",
"orderId": "order-1",
"customerId": "cust-1",
"customerName": "Camille Laurent",
"storeId": "store-rivoli",
"currency": "EUR",
"orderTotalCents": 100000,
"payments": [
{
"amountCents": 30000,
"at": "2026-07-28T09:00:00.000Z"
}
],
"status": "open",
"actorId": "user-cashier-1",
"createdAt": "2026-07-28T09:00:00.000Z"
}{
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"statusCode": 123,
"fieldErrors": [
{
"field": "<string>",
"message": "<string>"
}
]
}
}{
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"statusCode": 123
}
}{
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"statusCode": 123
}
}{
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"statusCode": 123
}
}{
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"statusCode": 123
}
}{
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"statusCode": 123
}
}Checkout
Open a deposit (acompte)
Opens a deposit (acompte) against a special order with an upfront down-payment, creating it open. The CALLER supplies the deposit id — it must be unique, so choose a stable, collision-free identifier (a duplicate is rejected, never silently merged). Money is integer cents; the down-payment must not exceed the order total. 409s when a deposit with the same id already exists; 422s when the down-payment overpays the order total.
POST
/
v1
/
deposits
Error
A valid request URL is required to generate request examples{
"id": "dep-ok",
"orderId": "order-1",
"customerId": "cust-1",
"customerName": "Camille Laurent",
"storeId": "store-rivoli",
"currency": "EUR",
"orderTotalCents": 100000,
"payments": [
{
"amountCents": 30000,
"at": "2026-07-28T09:00:00.000Z"
}
],
"status": "open",
"actorId": "user-cashier-1",
"createdAt": "2026-07-28T09:00:00.000Z"
}{
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"statusCode": 123,
"fieldErrors": [
{
"field": "<string>",
"message": "<string>"
}
]
}
}{
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"statusCode": 123
}
}{
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"statusCode": 123
}
}{
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"statusCode": 123
}
}{
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"statusCode": 123
}
}{
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"statusCode": 123
}
}Authorizations
Authorization: Bearer <token>. Accepts EITHER a Keycloak access token (scopes-in-token) OR an opaque POS session token; both resolve to the same pos.* scope vocabulary the route guards enforce.
Body
application/json
Minimum string length:
1Minimum string length:
1Minimum string length:
1Minimum string length:
1Required string length:
3Required range:
0 < x <= 9007199254740991Required range:
0 < x <= 9007199254740991Response
The opened deposit in its open state.
The opened deposit in its open state.
Required range:
0 < x <= 9007199254740991Show child attributes
Show child attributes
Available options:
open, settled 
