get https://sandbox.auth.flowfinance.com.br/escrow/api/v1/wallets//charges/
Esse endpoint permite que seja realizada uma consulta detalhada de uma cobrança que foi realizada na carteira.
Parâmetros da URL
wallet_id
(string/uuid v4): ID de cadastro da wallet.
charge_id
(string/uuid v4): ID de cadastro da cobrança.
Parâmetros da Requisição
Não é necessário o envio de nenhum dado no corpo da requisição.
Resposta
Se a requisição for processada com sucesso será retornado um código 200 e um JSON no seguinte formato:
id
(string): ID de cadastro da cobrança.
charge_code
(string): Código de identificação para cobrança.
discount_limit_date
(datetime): Data máxima para aplicação do desconto, ex: vencimento da cobrança dia 25 e desconto até o dia 20.
created_at
(datetime): Data da criação da cobrança.
days_to_expire_after_payment
(integer): Quantidade de dias após o vencimento que a cobraça pode ser paga.
fine
(float): Percentual de multa a ser aplicada em caso de atraso no pagamento.
discount_modality
(string): Modalidade de desconto. Possíveis valores:- FIXED: Para aplicar um desconto em valor ex: R$ 2,50
- PERCENT: Para aplicar um desconto em porcentagem ex: 10.00%
- FIXED: Para aplicar um desconto em valor ex: R$ 2,50
discount_value
(float): Valor de desconto a ser aplicado.
interest
(float): Taxa de juros em caso de atraso no pagamento.
charge_receiver
(object): Objeto contedo os dados do recebedor.
charge_debtor
(object): Objeto contendo os dados do devedor.
Objeto 'charge_receiver'
account
(string): Número da conta.
document
(string): Número do documento de identificação do recebedor.
Objeto 'charge_debtor'
name
(string): Nome do pagador.
document
(string): CPF do pagador.
email
(string): E-mail de contato.
publicArea
(string): Nome da rua.
number
(string): Número do endereço informado.
postalCode
(string): Código de CEP para o endereço.
neighborhood
(string): Campo para informar o bairro.
city
(string): Nome da cidade.
state
(string): Código da UF para o estado do endereço.
complement
(string): Complemento do endereço.
Exemplo de JSON:
{
"id": "<uuid>",
"fine": "<number>",
"charge_code": "<number>",
"due_date": "<dateTime>",
"amount": "<number>",
"discount_limit_date": "<dateTime>",
"days_to_expire_after_payment": "<number>",
"discount_modality": "FIXED",
"discount_value": "<number>",
"interest": "<number>",
"charge_debtor": {
"number": "<string>",
"neighborhood": "<string>",
"name": "<string>",
"document": "<string>",
"city": "<string>",
"public_area": "<string>",
"state": "<string>",
"postal_code": "<string>"
},
"charge_receiver": {
"account": "<string>",
"document": "<string>"
}
}