Sign in

v1

latestOpenAPI 3.1.0raw.githubusercontent.com2025-07-116470172.6 KB
Pagos

Crear Pago

Reportar un pago

post/payments

Headers

campusIDstring uuid required

ID del Campus que se desea trabajar.

periodIDstring uuid required

ID del periodo que se desea trabajar.

Request body

ledger_idstring uuid required

Id del invoice que desea registrar el pago

method'debit card' | 'credit card' | 'transfer' | 'cash' required

Tipo de entrada, Colegitura, Inscripcion, Complemento

ticketReferencestring required

Identificador del metodo de pago.

amountnumber required

Monto de pago complento o pendiente de la entrada

invoiceEmittedboolean required

Si desea generar factura.

paymentDatestring date required

Fecha de recepcion del pago

external_idstring

Campo arbitrario de datos de terceros

metadataobject

Campo arbitrario de datos de terceros

Example request

{
  "ledger_id": "82b41d8a-e238-4d4a-8ee1-b0e37d37aab7",
  "method": "cash",
  "ticketReference": "pi_123456789",
  "amount": 100.2,
  "paymentDate": "2024-01-20",
  "external_id": "123abc",
  "metadata": {
    "id_alumno": "123abc"
  }
}

Response

Crear Pago

idstring uuid

Identificador único del registro

created_atstring date-time

Fecha y hora de creacion del registro

updated_atstring date-time

Fecha y hora de creacion del registro

method'debit card' | 'credit card' | 'transfer' | 'cash'

Tipo de entrada, Colegitura, Inscripcion, Complemento

ticketReferencestring

Identificador del metodo de pago.

amountnumber

Monto de pago complento o pendiente de la entrada

paymentDatestring date

Fecha de recepcion del pago

status'pending' | 'waiting' | 'successful' | 'cancelled' | 'failed' | 'holding'

Estado del pago

external_idstring

Campo arbitrario de datos de terceros

metadataobject

Campo arbitrario de datos de terceros

Example response

{
  "id": "a12a51c4-3f69-464f-93eb-cc8d355f68b2",
  "created_at": "2023-09-01 14:44:17.600161",
  "updated_at": "2023-09-01 14:44:17.600161",
  "method": "cash",
  "ticketReference": "pi_123456789",
  "amount": 100.2,
  "paymentDate": "2024-01-20",
  "status": "successful",
  "external_id": "123abc",
  "metadata": {
    "id_alumno": "123abc"
  }
}