Pagamentos

Nessa sessão, disponibilizamos as operações para realizar e acompanhar um pagamento.

Efetua pagamento pelo código de barra ou pela linha digitável

Nessa funcionalidade, recebemos o código de barras ou a linha digitável e processamos o pagamento de títulos e boletos.

Solicitamos os campos:

Campo	Descrição	Formato	Obrigatório
codigoIdentificacao	Código de barra ou linha digitável do pagamento	string	Sim
valor	Valor do pagamento	number `<double>`	Sim
efetuarEm	Data em que o pagamento deverá ocorrer	date-time	Não
vencimentoEm	Data do vencimento do documento que será pago	date-time	Não

Resposta:

Campo	Descrição	Formato	Nullable
solicitacaoId	Identificador da solicitação de pagamento	string	Não
aprovado	Informa se o pagamento foi aprovado ou rejeitado	boolean	Não
mensagem	Mensagem de retorno da solicitação, em caso de falha	string	Sim

Nessa funcionalidade, é possível acompanhar o status da solicitação de pagamento.

Solicitamos os campos:

Campo	Descrição	Formato	Obrigatório
solicitacaoId	Código identificador do pagamento	string	Sim

Resposta:

Campo	Descrição	Formato	Nullable
id	Código identificador do pagamento	string	Não
situacao	Descrição da situação do pagamento conforme tabela [Status do pagamento]	string	Sim
status	Apresenta o código do status do pagamento conforme tabela [Status do pagamento]	integer	Não
observacao	Observação com o motivo da falha, caso ocorra	string	Sim

Disponibilizamos a consulta dos dados de um boleto ou título de arrecadação de qualquer instituição financeira.

Solicitamos os campos:

Campo	Descrição	Formato	Obrigatório
codigoIdentificacao	Código identificador do pagamento	string	Sim

Resposta:

Campo	Descrição	Formato	nullable
dataVencimento	Data de vencimento do documento	date-time	Sim
banco	Código e nome do banco emissor do documento (válido apenas para boleto)	object	Não
beneficiario	Nome e número do CPF/CNPJ do beneficiário do pagamento	object	Sim
valores	Detalhamento dos valores pagos (valor original, valor cobrado, descontos, mora, outras deduções e acréscimos)	object	Não
descricaoPagamento	Apresenta a descrição do pagamento	string	Sim
nomePagador	Nome do pagador do documento	string	Sim
codigoBarras	Código de barras do documento	string	Sim
linhaDigitavel	Linha digitável do documento	string	Sim
cedente	Cedente do pagamento	string	Sim

Os status mapeados para a status do pagamento são: