Los Pagos en el sistema de YOM son registros que documentan las transacciones entre clientes y la empresa. Aquí se detallan los campos esenciales para registrar y gestionar estos pagos de manera precisa.
POST payment.created
POST payment.updated
La entidad payment.
| Campo | Tipo | Carácter | Descripción | Ejemplos |
|---|---|---|---|---|
paymentId |
📝 Texto | 🟢 Requerido | Identificador único del Pago. | "PAY001" |
internalPaymentId |
🆔 ObjectId | ⚪ Opcional | Identificador único del Pago. | |
| *\*Generado por YOM | ||||
*Se envía en el evento **payment.created* |
"YOM-PAY001" |
|||
commerceId |
📝 Texto | 🟢 Requerido | Identificador único del Comercio. | "CLI001" |
voucherId |
📝 Texto | ⚪ Opcional | Identificador único del comprobante emitido como evidencia del Pago. | |
| *\Puede estar relacionado a más de un Pago. | "VOU001" |
|||
date |
📝 Texto | 🟢 Requerido | Fecha de creación del Pago en formato ISO 8601. | "2024-07-01T10:30:00.000Z" |
status |
📝 Texto | 🟢 Requerido | Estado actual del Pago. | |
"pending" → pago pendiente de procesar |
||||
"processed" → pago procesado |
||||
"accepted" → pago aceptado |
||||
"rejected" → pago rechazado |
"pending" |
|||
"processed" |
||||
"accepted" |
||||
"rejected" |
||||
amount |
🔢 Número | 🟢 Requerido | Monto total del Pago. | 500.00 |
currencyCode |
📝 Texto | 🟢 Requerido | Código de moneda en formato ISO 4217. | |
"CLP" |
||||
"USD" |
||||
"COL" |
||||
"PEN" |
||||
"MXN" |
"CLP" |
|||
"USD" |
||||
"COL" |
||||
"PEN" |
||||
"MXN" |
||||
source |
📝 Objeto → PaymentSource | 🟢 Requerido | Información sobre el origen del registro del Pago. | |
paymentDocuments |
🔡 Lista de Objetos → PaymentDocument | 🟢 Requerido | Lista con el detalle de los Documentos financieros sobre los que se hace el Pago. | |
paymentDetails |
🔡 Lista de Objetos → PaymentDetail | 🟢 Requerido | Lista que contiene los detalles de cada forma de pago utilizada para realizar el Pago. | |
observation |
📝 Texto | ⚪ Opcional | Observaciones acerca del Pago. | "pagado en local 221" |
La estructura paymentDocuments permite detallar los documentos tributarios sobre los que se efectua el Pago, con los montos del Pago asignados al Documento.
| --- | --- | --- | --- | --- |
La estructura paymentDetails permite detallar cada forma de pago utilizada para el Pago.
| --- | --- | --- | --- | --- |
La estructura paymentSource contiene información sobre el origen del registro del Pago.
| --- | --- | --- | --- | --- |