Skip to main content
PATCH
/
api
/
v1
/
ticket-payments
/
:id
Finalize Payment
curl --request PATCH \
  --url https://api.example.com/api/v1/ticket-payments/:id \
  --header 'Content-Type: application/json' \
  --data '
{
  "isFinal": true,
  "notes": "<string>"
}
'
{
  "id": "<string>",
  "isFinal": true,
  "notes": "<string>",
  "updatedAt": "<string>"
}

​
Overview

Updates a ticket payment to mark it as final (closing partial payments) or to add/update notes.

​
Authentication

Requires JWT authentication. RBAC filtering applies based on user role.

​
Path Parameters

​
id
string
required
UUID of the payment to update

​
Request Body

​
isFinal
boolean
Mark payment as final (updates ticket status to PAID)
​
notes
string
Update notes (max 300 characters)

​
Response

​
id
string
Payment ID
​
isFinal
boolean
Updated final status
​
notes
string
Updated notes
​
updatedAt
string
ISO 8601 timestamp of update

​
Status Codes

  • 200: Payment updated successfully
  • 400: Invalid input
  • 403: RBAC violation
  • 404: Payment not found

​
Example Request

{
  "isFinal": true,
  "notes": "Pago completado - saldo restante cancelado"
}

​
Example Response

{
  "success": true,
  "data": {
    "id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
    "ticketId": "550e8400-e29b-41d4-a716-446655440000",
    "amountPaid": 30000,
    "isFinal": true,
    "notes": "Pago completado - saldo restante cancelado",
    "updatedAt": "2024-03-15T11:30:00.000Z"
  }
}

Build docs developers (and LLMs) love

Get started for freeTalk to us