Os Pagamentos no sistema da YOM são registros que documentam as transações entre clientes e a empresa. Aqui são detalhados os campos essenciais para registrar e gerenciar esses pagamentos de forma precisa.
POST payment.created
POST payment.updated
A entidade payment.
| Campo | Tipo | Obrigatoriedade | Descrição | Exemplos |
|---|---|---|---|---|
paymentId |
📝 Texto | 🟢 Obrigatório | Identificador único do Pagamento. | "PAY001" |
internalPaymentId |
🆔 ObjectId | ⚪ Opcional | Identificador único do Pagamento. | |
| *\*Gerado pela YOM | ||||
*É enviado no evento **payment.created* |
"YOM-PAY001" |
|||
commerceId |
📝 Texto | 🟢 Obrigatório | Identificador único do Comércio. | "CLI001" |
voucherId |
📝 Texto | ⚪ Opcional | Identificador único do comprovante emitido como evidência do Pagamento. | |
| *\Pode estar relacionado a mais de um Pagamento. | "VOU001" |
|||
date |
📝 Texto | 🟢 Obrigatório | Data de criação do Pagamento no formato ISO 8601. | "2024-07-01T10:30:00.000Z" |
status |
📝 Texto | 🟢 Obrigatório | Estado atual do Pagamento. | |
"pending" → pagamento pendente de processamento |
||||
"processed" → pagamento processado |
||||
"accepted" → pagamento aceito |
||||
"rejected" → pagamento rejeitado |
"pending" |
|||
"processed" |
||||
"accepted" |
||||
"rejected" |
||||
amount |
🔢 Número | 🟢 Obrigatório | Valor total do Pagamento. | 500.00 |
currencyCode |
📝 Texto | 🟢 Obrigatório | Código de moeda no formato ISO 4217. | |
"CLP" |
||||
"USD" |
||||
"COL" |
||||
"PEN" |
||||
"MXN" |
"CLP" |
|||
"USD" |
||||
"COL" |
||||
"PEN" |
||||
"MXN" |
||||
source |
📝 Objeto → PaymentSource | 🟢 Obrigatório | Informações sobre a origem do registro do Pagamento. | |
paymentDocuments |
🔡 Lista de Objetos → PaymentDocument | 🟢 Obrigatório | Lista com o detalhe dos Documentos financeiros sobre os quais é feito o Pagamento. | |
paymentDetails |
🔡 Lista de Objetos → PaymentDetail | 🟢 Obrigatório | Lista que contém os detalhes de cada forma de pagamento utilizada para realizar o Pagamento. | |
observation |
📝 Texto | ⚪ Opcional | Observações sobre o Pagamento. | "pagado en local 221" |
A estrutura paymentDocuments permite detalhar os documentos fiscais sobre os quais o Pagamento é efetuado, com os valores do Pagamento atribuídos ao Documento.
| --- | --- | --- | --- | --- |
A estrutura paymentDetails permite detalhar cada forma de pagamento utilizada para o Pagamento.
| --- | --- | --- | --- | --- |
A estrutura paymentSource contém informações sobre a origem do registro do Pagamento.
| --- | --- | --- | --- | --- |