Baixa de documento - Histórico de revisão

Felipe: Criou página com 'O objetivo desta serviço é executar a baixa de um documento financeiro por motivo de '''Pagamento'''. Abaixo, segue exemplo do json de envio: Pagamento com dinheiro:
2021-06-04T11:58:35Z

Criou página com 'O objetivo desta serviço é executar a baixa de um documento financeiro por motivo de '''Pagamento'''. Abaixo, segue exemplo do json de envio: Pagamento com dinheiro: <synta...'

Página nova
O objetivo desta serviço é executar a baixa de um documento financeiro por motivo de '''Pagamento'''. Abaixo, segue exemplo do json de envio:

Pagamento com dinheiro:
<syntaxhighlight lang="json" line="1">
{
"document_payment":
{
"payment_type": "money",
"document_id": 22563,
"document_historic_id": 65874,
"payment_account_id": 1,
"payment_historic_id": 20,
"payment_date": "2019-07-18",
"payment_credit_date": "2019-07-18",
"payment_discount_type": "V",
"payment_discount_amount": 10.5,
"payment_interest_type": "P",
"payment_interest_amount": 0,
"payment_fine_type": "P",
"payment_fine_amount": 0,
"rate_amount": 1.25,
"rate_historic_id": 13,
"rate_currency_id": 1,
"payment_comment": "baixa avulsa",
"unblock_customer": true
}
}
</syntaxhighlight>

Pagamento com cartão de crédito (máquina) em 3 parcelas:
<syntaxhighlight lang="json" line="1">
{
"document_payment":
{
"payment_type": "credit_card_machine",
"document_id": 22563,
"document_historic_id": 65874,
"payment_date": "2019-07-18",
"payment_discount_type": "V",
"payment_discount_amount": 10.5,
"payment_interest_type": "P",
"payment_interest_amount": 0,
"payment_fine_type": "P",
"payment_fine_amount": 0,
"payment_comment": "baixa com cartão de crédito",
"unblock_customer": true,
"payment_installments": 3,
"card_brand": "visa",
"payment_receipt":
{
"document_number": 123456,
"authorization_number": "ABCDE123"
}
}
}
</syntaxhighlight>

Pagamento com cartão de débito (máquina):
<syntaxhighlight lang="json" line="1">
{
"document_payment":
{
"payment_type": "debit_card_machine",
"document_id": 22563,
"document_historic_id": 65874,
"payment_date": "2019-07-18",
"payment_discount_type": "V",
"payment_discount_amount": 10.5,
"payment_interest_type": "P",
"payment_interest_amount": 0,
"payment_fine_type": "P",
"payment_fine_amount": 0,
"payment_comment": "baixa com cartão de débito",
"unblock_customer": true,
"card_brand": "master",
"payment_receipt":
{
"document_number": 123456,
"authorization_number": "ABCDE123"
}
}
}
</syntaxhighlight>

'''Detalhamento dos campos'''
<table style="border-collapse: collapse; width: 100%;" border="1">
<tr style="height: 18px;">
<td style="width: 2.56232%; height: 18px;"><strong>ID</strong></td>
<td style="width: 4.11634%; height: 18px;"><strong>Campo</strong></td>
<td style="width: 0.696864%; height: 18px;"><strong>Obrigatório</strong></td>
<td style="width: 0.696864%; height: 18px;"><strong>Pai</strong></td>
<td style="width: 3.16901%; height: 18px;"><strong>Tipo</strong></td>
<td style="width: 27.3043%; height: 18px;"><strong>Observações</strong></td>
</tr>
<tr style="height: 18px;">
<td style="width: 2.56232%; height: 18px;">A01</td>
<td style="width: 4.11634%; height: 18px;">Dados da autenticação</td>
<td style="width: 0.696864%; height: 18px;">Sim</td>
<td style="width: 0.696864%; height: 18px;">Raiz</td>
<td style="width: 3.16901%; height: 18px;">-</td>
<td style="width: 27.3043%; height: 18px;"> </td>
</tr>
<tr style="height: 18px;">
<td style="width: 2.56232%; height: 18px;">A02</td>
<td style="width: 4.11634%; height: 18px;">document_id</td>
<td style="width: 0.696864%; height: 18px;">Sim</td>
<td style="width: 0.696864%; height: 18px;">A01</td>
<td style="width: 3.16901%; height: 18px;">Número</td>
<td style="width: 27.3043%; height: 18px;">
<p>Código interno do documento no sistema (sequência).</p>
</td>
</tr>
<tr style="height: 18px;">
<td style="width: 2.56232%; height: 18px;">A03</td>
<td style="width: 4.11634%; height: 18px;">document_historic_id</td>
<td style="width: 0.696864%; height: 18px;">Sim</td>
<td style="width: 0.696864%; height: 18px;">A01</td>
<td style="width: 3.16901%; height: 18px;">Número</td>
<td style="width: 27.3043%; height: 18px;">
<p>Número do histórico de baixa.</p>
</td>
</tr>
<tr style="height: 18px;">
<td style="width: 2.56232%; height: 18px;">A04</td>
<td style="width: 4.11634%; height: 18px;">payment_account_id</td>
<td style="width: 0.696864%; height: 18px;">Sim</td>
<td style="width: 0.696864%; height: 18px;">A01</td>
<td style="width: 3.16901%; height: 18px;">Número</td>
<td style="width: 27.3043%; height: 18px;">
<p>Número da conta corrente da contrapartida do pagamento.</p>
<p>Este campo não deve ser informado para os tipos de pagamento "<strong>credit_card_machine</strong>" e "<strong>debit_card_machine</strong>".</p>
</td>
</tr>
<tr style="height: 18px;">
<td style="width: 2.56232%; height: 18px;">A05</td>
<td style="width: 4.11634%; height: 18px;">payment_historic_id</td>
<td style="width: 0.696864%; height: 18px;">Sim</td>
<td style="width: 0.696864%; height: 18px;">A01</td>
<td style="width: 3.16901%; height: 18px;">Número</td>
<td style="width: 27.3043%; height: 18px;">
<p>Número do histórico da contrapartida do pagamento.</p>
<p>Este campo não deve ser informado para os tipos de pagamento "<strong>credit_card_machine</strong>" e "<strong>debit_card_machine</strong>".</p>
</td>
</tr>
<tr style="height: 18px;">
<td style="width: 2.56232%; height: 18px;">A06</td>
<td style="width: 4.11634%; height: 18px;">payment_date</td>
<td style="width: 0.696864%; height: 18px;">Sim</td>
<td style="width: 0.696864%; height: 18px;">A01</td>
<td style="width: 3.16901%; height: 18px;">Data</td>
<td style="width: 27.3043%; height: 18px;">
<p>Data de baixa no formato AAAA-MM-DD.</p>
</td>
</tr>
<tr style="height: 18px;">
<td style="width: 2.56232%; height: 18px;">A07</td>
<td style="width: 4.11634%; height: 18px;">payment_credit_date</td>
<td style="width: 0.696864%; height: 18px;">Não</td>
<td style="width: 0.696864%; height: 18px;">A01</td>
<td style="width: 3.16901%; height: 18px;">Data</td>
<td style="width: 27.3043%; height: 18px;">
<p>Data do crédito em conta no formato AAAA-MM-DD. Caso seja igual à data de baixa, informar conteúdo nulo.</p>
<p>Este campo não deve ser informado para os tipos de pagamento "<strong>credit_card_machine</strong>" e "<strong>debit_card_machine</strong>".</p>
</td>
</tr>
<tr style="height: 18px;">
<td style="width: 2.56232%; height: 18px;">A08</td>
<td style="width: 4.11634%; height: 18px;">payment_discount_type</td>
<td style="width: 0.696864%; height: 18px;">Sim</td>
<td style="width: 0.696864%; height: 18px;">A01</td>
<td style="width: 3.16901%; height: 18px;">Lista</td>
<td style="width: 27.3043%; height: 18px;">
<p>Tipo de desconto a ser concedido na baixa. Valores possíveis:</p>
<ul>
<li><strong>P</strong>: desconto em percentual</li>
<li><strong>V</strong>: desconto em valor</li>
</ul>
</td>
</tr>
<tr style="height: 18px;">
<td style="width: 2.56232%; height: 18px;">A09</td>
<td style="width: 4.11634%; height: 18px;">payment_discount_amount</td>
<td style="width: 0.696864%; height: 18px;">Não</td>
<td style="width: 0.696864%; height: 18px;">A01</td>
<td style="width: 3.16901%; height: 18px;">Decimal (15.2)</td>
<td style="width: 27.3043%; height: 18px;">
<p>Valor ou percentual do desconto conforme parametrizado no campo A08.</p>
</td>
</tr>
<tr style="height: 18px;">
<td style="width: 2.56232%; height: 18px;">A10</td>
<td style="width: 4.11634%; height: 18px;">payment_interest_type</td>
<td style="width: 0.696864%; height: 18px;">Sim</td>
<td style="width: 0.696864%; height: 18px;">A01</td>
<td style="width: 3.16901%; height: 18px;">Lista</td>
<td style="width: 27.3043%; height: 18px;">
<p>Tipo de juros a ser concedido na baixa. Valores possíveis:</p>
<ul>
<li><strong>P</strong>: juros em percentual</li>
<li><strong>V</strong>: juros em valor</li>
</ul>
</td>
</tr>
<tr style="height: 18px;">
<td style="width: 2.56232%; height: 18px;">A11</td>
<td style="width: 4.11634%; height: 18px;">payment_interest_amount</td>
<td style="width: 0.696864%; height: 18px;">Não</td>
<td style="width: 0.696864%; height: 18px;">A01</td>
<td style="width: 3.16901%; height: 18px;">Decimal (15.2)</td>
<td style="width: 27.3043%; height: 18px;">
<p>Valor ou percentual dos juros conforme parametrizado no campo A10.</p>
</td>
</tr>
<tr style="height: 18px;">
<td style="width: 2.56232%; height: 18px;">A12</td>
<td style="width: 4.11634%; height: 18px;">payment_fine_type</td>
<td style="width: 0.696864%; height: 18px;">Sim</td>
<td style="width: 0.696864%; height: 18px;">A01</td>
<td style="width: 3.16901%; height: 18px;">Lista</td>
<td style="width: 27.3043%; height: 18px;">
<p>Tipo de multa a ser concedida na baixa. Valores possíveis:</p>
<ul>
<li><strong>P</strong>: multa em percentual</li>
<li><strong>V</strong>: multa em valor</li>
</ul>
</td>
</tr>
<tr style="height: 18px;">
<td style="width: 2.56232%; height: 18px;">A13</td>
<td style="width: 4.11634%; height: 18px;">payment_fine_amount</td>
<td style="width: 0.696864%; height: 18px;">Não</td>
<td style="width: 0.696864%; height: 18px;">A01</td>
<td style="width: 3.16901%; height: 18px;">Decimal (15.2)</td>
<td style="width: 27.3043%; height: 18px;">
<p>Valor ou percentual dos juros conforme parametrizado no campo A12.</p>
</td>
</tr>
<tr style="height: 18px;">
<td style="width: 2.56232%; height: 18px;">A14</td>
<td style="width: 4.11634%; height: 18px;">rate_amount</td>
<td style="width: 0.696864%; height: 18px;">Não</td>
<td style="width: 0.696864%; height: 18px;">A01</td>
<td style="width: 3.16901%; height: 18px;">Decimal (15.2)</td>
<td style="width: 27.3043%; height: 18px;">
<p>Valor da tarifa cobrada na baixa.</p>
</td>
</tr>
<tr style="height: 18px;">
<td style="width: 2.56232%; height: 18px;">A15</td>
<td style="width: 4.11634%; height: 18px;">rate_historic_id</td>
<td style="width: 0.696864%; height: 18px;">Não</td>
<td style="width: 0.696864%; height: 18px;">A01</td>
<td style="width: 3.16901%; height: 18px;">Número</td>
<td style="width: 27.3043%; height: 18px;">
<p>Número do histórico de tarifas. Este campo sempre deverá ser informado quando o campo A14 for informado.</p>
</td>
</tr>
<tr style="height: 18px;">
<td style="width: 2.56232%; height: 18px;">A16</td>
<td style="width: 4.11634%; height: 18px;">rate_currency_id</td>
<td style="width: 0.696864%; height: 18px;">Não</td>
<td style="width: 0.696864%; height: 18px;">A01</td>
<td style="width: 3.16901%; height: 18px;">Número</td>
<td style="width: 27.3043%; height: 18px;">
<p>Código da moeda para contabilização da tarifa. Este campo sempre deverá ser informado quando o campo A14 for informado.</p>
</td>
</tr>
<tr style="height: 18px;">
<td style="width: 2.56232%; height: 18px;">A17</td>
<td style="width: 4.11634%; height: 18px;">payment_comment</td>
<td style="width: 0.696864%; height: 18px;">Não</td>
<td style="width: 0.696864%; height: 18px;">A01</td>
<td style="width: 3.16901%; height: 18px;">Texto</td>
<td style="width: 27.3043%; height: 18px;">
<p>Texto livre para complemento da baixa.</p>
</td>
</tr>
<tr style="height: 18px;">
<td style="width: 2.56232%; height: 18px;">A18</td>
<td style="width: 4.11634%; height: 18px;">unblock_customer</td>
<td style="width: 0.696864%; height: 18px;">Sim</td>
<td style="width: 0.696864%; height: 18px;">A01</td>
<td style="width: 3.16901%; height: 18px;">Booleano</td>
<td style="width: 27.3043%; height: 18px;">
<p>Campo para indicar se o cliente deverá ser desbloqueado na baixa (caso o documento que esteja sendo baixado tenha sido o responsável pelo bloqueio do cliente).</p>
<ul>
<li><strong>true</strong>: desbloquear o cliente</li>
<li><strong>false</strong>: não desbloquear o cliente</li>
</ul>
</td>
</tr>
<tr style="height: 18px;">
<td style="width: 2.56232%; height: 18px;">A19</td>
<td style="width: 4.11634%; height: 18px;">payment_type</td>
<td style="width: 0.696864%; height: 18px;">Não</td>
<td style="width: 0.696864%; height: 18px;">A01</td>
<td style="width: 3.16901%; height: 18px;">Lista</td>
<td style="width: 27.3043%; height: 18px;">
<p>Tipo de pagamento. Valores permitidos:</p>
<ul>
<li><strong>money</strong>: é o tipo de pagamento padrão. Deve ser utilizado para pagamento em espécie.</li>
<li><strong>credit_card_machine</strong>: pagamento com cartão de crédito via máquina (não on-line).</li>
<li><strong>debit_card_machine</strong>: pagamento com cartão de débito via máquina (não on-line).</li>
</ul>
<p>Quando não informado, este campo assume o valor "<strong>money</strong>".</p>
<p>Para os tipos "<strong>credit_card_machine</strong>" e "<strong>debit_card_machine</strong>" é necessário existir um convênio de cartão ativo cadastrado no sistema.</p>
</td>
</tr>
<tr style="height: 18px;">
<td style="width: 2.56232%; height: 18px;">A20</td>
<td style="width: 4.11634%; height: 18px;">payment_installments</td>
<td style="width: 0.696864%; height: 18px;">Não</td>
<td style="width: 0.696864%; height: 18px;">A01</td>
<td style="width: 3.16901%; height: 18px;">Número</td>
<td style="width: 27.3043%; height: 18px;">
<p>Neste campo deve ser informada a quantidade de parcelas para pagamentos com cartão de crédito (payment type = <strong>credit_card_machine</strong>). São aceitos valores inteiros positivos maiores do que zero.</p>
<p>Para pagamentos do tipo "<strong>money</strong>", este campo não precisa ser informado.</p>
<p>Para pagamentos do tipo "<strong>debit_card_machine</strong>", este campo não precisa ser informado. Se for informado, o seu valor deve ser igual a 1.</p>
</td>
</tr>
<tr style="height: 18px;">
<td style="width: 2.56232%; height: 18px;">A21</td>
<td style="width: 4.11634%; height: 18px;">card_brand</td>
<td style="width: 0.696864%; height: 18px;">Não</td>
<td style="width: 0.696864%; height: 18px;">A01</td>
<td style="width: 3.16901%; height: 18px;">Lista</td>
<td style="width: 27.3043%; height: 18px;">
<p>Bandeira do cartão utilizada para pagamento dos tipos "<strong>credit_card_machine</strong>" e "<strong>debit_card_machine</strong>". Bandeiras aceitas atualmente:</p>
<ul>
<li><strong>amex</strong></li>
<li><strong>aura</strong></li>
<li><strong>diners</strong></li>
<li><strong>discover</strong></li>
<li><strong>elo</strong></li>
<li><strong>hipercard</strong></li>
<li><strong>jcb</strong></li>
<li><strong>master</strong></li>
<li><strong>visa</strong></li>
</ul>
<p>É necessário que a bandeira esteja cadastrada no convênio de cartão para que a mesma seja permitida.</p>
</td>
</tr>
<tr style="height: 18px;">
<td style="width: 2.56232%; height: 18px;">A22</td>
<td style="width: 4.11634%; height: 18px;">payment_receipt</td>
<td style="width: 0.696864%; height: 18px;">Não</td>
<td style="width: 0.696864%; height: 18px;">A01</td>
<td style="width: 3.16901%; height: 18px;">-</td>
<td style="width: 27.3043%; height: 18px;">Campo que contém campos para indicar informações do recibo de pagamento gerado nos pagamentos dos tipos "<strong>credit_card_machine</strong>" e "<strong>debit_card_machine</strong>".</td>
</tr>
<tr style="height: 18px;">
<td style="width: 2.56232%; height: 18px;">B01</td>
<td style="width: 4.11634%; height: 18px;">document_number</td>
<td style="width: 0.696864%; height: 18px;">Não</td>
<td style="width: 0.696864%; height: 18px;">A22</td>
<td style="width: 3.16901%; height: 18px;">Número</td>
<td style="width: 27.3043%; height: 18px;">Número do documento do recibo. Aceita valores inteiros positivos.</td>
</tr>
<tr style="height: 18px;">
<td style="width: 2.56232%; height: 18px;">B02</td>
<td style="width: 4.11634%; height: 18px;">authorization_number</td>
<td style="width: 0.696864%; height: 18px;">Não</td>
<td style="width: 0.696864%; height: 18px;">A22</td>
<td style="width: 3.16901%; height: 18px;">Texto</td>
<td style="width: 27.3043%; height: 18px;">Código de autorização do recibo.</td>
</tr>
</table>
<p> </p>
'''Mensagem de retorno'''

Em caso de sucesso, será retornado um json conforme o exemplo abaixo:

<syntaxhighlight lang="json" line="1">
{
"status": 1,
"error_code": 0,
"error_description": "",
"result":
{
"receipt_id": 145887
}
}
</syntaxhighlight>

Em caso de falha, será retornado um json conforme o exemplo abaixo:

<syntaxhighlight lang="json" line="1">
{
"status": 0,
"error_code": 12,
"error_description": "Internal Server Error!",
"result": ""
}
</syntaxhighlight>