Objetos da Simulação de Pagamento



O Dry Run de pagamentos retorna, além do Objeto Pagamento em si, os Objetos Barcode Details e Details.

Como complemento, descrevemos os possíveis resultados para o campo document_payment_type.


Objeto Barcode Details



O Objeto Barcode Details é composto por meio da extração das informações contidas no código de barras informado, dispondo-as nos seguintes campos:


Chave Descrição Tipo
bank_code Código numérico da instituição que emitiu o documento. String
bank_name Nome da instituição que emitiu o documento. String
barcode Código de barras. String
expiration_date Data de vencimento. String
face_value Valor com o qual o documento foi criado e que consta do código de barras. Integer
writable_line Código numérico que acompanha o código de barras. String

Objeto Details



O Objeto Details traz informações do status atual desse documento segundo sua fonte emissora, como juros, multas, horário limite de pagamento, entre outras. Veja todas as informações retornadas abaixo.


Chave Descrição Tipo
bank_name Nome da instituição que emitiu o documento. String
barcode Código de barras. String
discount_value Valor do desconto que está sendo aplicado ao boleto. Caso nenhum desconto esteja sendo aplicado vira null. Integer
document_payment_type Informa o código referente a título. Integer
document_type Informa o tipo de documento. Valores possíveis são: boleto e concessionaria. String
expiration_date Data de vencimento String
face_value Valor com o qual o documento foi criado e que consta do código de barras. Integer
fine_value Valor da multa que está sendo aplicada ao boleto. Caso nenhuma multa esteja sendo aplicada vira null. Integer
interest_value Valor dos juros que estão sendo aplicados ao boleto. Caso não haja juros aplicados vira null. Integer
max_value Valor máximo que será aceito no pagamento deste documento. Integer
min_value Valor mínimo que será aceito no pagamento deste documento. Integer
payer_cpf_cnpj Número do documento do pagador sem pontos. String
payer_legal_name É o nome que identifica o pagador para fins legais, administrativos e outros fins oficiais. String
payer_trade_name Nome fantasia do pagador. String
payment_end_time Horário até o qual o pagamento é possível em um dia útil. Respeita o payment_limit_date. Formato hh:mm:ss. String
payment_limit_date Data limite para pagamento do documento. Formato ISO8601 “YYYY-MM-DD”. String
payment_start_time Horário a partir do qual o pagamento é possível em um dia útil. Respeita o payment_limit_date. Formato hh:mm:ss. String
recipient_cpf_cnpj Número do documento do beneficiário sem pontos. String
recipient_name Nome do beneficiário. String
settlement_date Data em que o dinheiro do pagamento do boleto é depositado na conta do beneficiário. Formato ISO8601 “YYYY-MM-DDThh:mm:ssZ”. Caso o boleto ainda não tenha sido pago voltará null. String
status Status atual do documento na sua instituição emissora. Valores possíveis: payable, paid ou unpayable. String
total_added_value Total que foi adicionado ao valor original do documento decorrente de juros e multas. Integer
total_discounted_value Total que foi abatido do valor originial do documento decorrente de descontos. Integer
updatable_value Indica se é permitido alterar o valor do documento. Só disponível para document_type com valor concessionaria. Boolean
value Valor atualizado já com descontos, multas e juros que se aplicam. Integer
writable_line Código numérico que acompanha o código de barras. String
unpayable_reason_code Código que representa o motivo de estar impagável. String
unpayable_reason_description Descrição do motivo de estar impagável. String
accepts_partial_payment Indica se o boleto aceita pagamento parcial Boolean
number_of_partials Indica quantas vezes o boleto pode ser pago, se o número for 99 significa que o número de vezes é ilimitado Integer

Document_payment_type




Domínio Descrição
1 CH Cheque.
2 DM Duplicata Mercantil.
3 DMI Duplicata Mercantil Indicação.
4 DS Duplicata de Serviço.
5 DSI Duplicata de Serviço Indicação.
6 DR Duplicata Rural.
7 LC Letra de Câmbio.
8 NCC Nota de Crédito Comercial.
9 NCE Nota de Crédito Exportação.
10 NCI Nota de Crédito Industrial.
11 NCR Nota de Crédito Rural.
12 NP Nota Promissória.
13 NPR Nota Promissória Rural.
14 TM Triplicata Mercantil.
15 TS Triplicata de Serviço.
16 NS Nota de Seguro.
17 RC Recibo.
18 FAT Bloqueio.
19 ND Nota de Débito.
20 AP Apólice de Seguro.
21 ME Mensalidade Escolar.
22 PC Parcela de Consórcio.
23 NF Nota Fiscal.
24 DD Documento de Dívida.
25 Cédula de Produto Rural.
26 Warrant.
27 Dívida Ativa de Estado.
28 Dívida Ativa do Município.
29 Dívida Ativa da União.
30 Encargos Condominiais.
31 Cartão de Crédito.
32 Boleto Proposta.
33 Boleto de Depósito e Aporte.
99 Outros.

Última modificação: 26.08.2021