Payments in the YOM system are records that document transactions between customers and the company. This page details the essential fields for recording and managing these payments accurately.
POST payment.created
POST payment.updated
The payment entity.
| Field | Type | Requirement | Description | Examples |
|---|---|---|---|---|
paymentId |
📝 Text | 🟢 Required | Unique identifier of the Payment. | "PAY001" |
internalPaymentId |
🆔 ObjectId | ⚪ Optional | Unique identifier of the Payment. | |
| *\*Generated by YOM | ||||
*Sent in the event **payment.created* |
"YOM-PAY001" |
|||
commerceId |
📝 Text | 🟢 Required | Unique identifier of the Commerce. | "CLI001" |
voucherId |
📝 Text | ⚪ Optional | Unique identifier of the voucher issued as evidence of the Payment. | |
| *\Can be related to more than one Payment. | "VOU001" |
|||
date |
📝 Text | 🟢 Required | Payment creation date in ISO 8601 format. | "2024-07-01T10:30:00.000Z" |
status |
📝 Text | 🟢 Required | Current status of the Payment. | |
"pending" → payment pending processing |
||||
"processed" → payment processed |
||||
"accepted" → payment accepted |
||||
"rejected" → payment rejected |
"pending" |
|||
"processed" |
||||
"accepted" |
||||
"rejected" |
||||
amount |
🔢 Number | 🟢 Required | Total amount of the Payment. | 500.00 |
currencyCode |
📝 Text | 🟢 Required | Currency code in ISO 4217 format. | |
"CLP" |
||||
"USD" |
||||
"COL" |
||||
"PEN" |
||||
"MXN" |
"CLP" |
|||
"USD" |
||||
"COL" |
||||
"PEN" |
||||
"MXN" |
||||
source |
📝 Object → PaymentSource | 🟢 Required | Information about the origin of the Payment record. | |
paymentDocuments |
🔡 List of Objects → PaymentDocument | 🟢 Required | List detailing the Financial Documents the Payment is made against. | |
paymentDetails |
🔡 List of Objects → PaymentDetail | 🟢 Required | List containing the details of each payment method used to make the Payment. | |
observation |
📝 Text | ⚪ Optional | Notes about the Payment. | "pagado en local 221" |
The paymentDocuments structure lets you detail the tax documents the Payment is made against, with the Payment amounts assigned to the Document.
| --- | --- | --- | --- | --- |
The paymentDetails structure lets you detail each payment method used for the Payment.
| --- | --- | --- | --- | --- |
The paymentSource structure contains information about the origin of the Payment record.
| --- | --- | --- | --- | --- |