Consultar os detalhes de uma cobrança

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%
  • 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.
  • updated_at (datetime): Data da última atualização.
  • paid_at (datetime): Data da confirmação do pagamento, se for 'bolepix' o status será alterado para 'CONFIRMED'.
  • payed_amount (float): Valor total pago.
  • bar_code (string): Código de barras do boleto de pagamento.
  • pix_code (string): Código PIX do pagamento.
  • boleto_details (string): Objeto contendo os detalhes referente ao tipo de pagamento se boleto.
  • pix_details (string): Objeto contendo os detalhes referente ao tipo de pagamento se pix.
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.
Objeto 'boleto_details'
  • transactionId (string): ID da transação.
  • status (string): Status do processamento.
  • bankEmissor (string): Nome do banco emissor do boleto.
  • bankNumber (string): Código de identificação do banco.
  • bankAgency (string): Código da agência do banco.
  • bankAccount (string): Número da conta.
  • barCode (string): Código de barras do boleto.
  • bankLine (string): Linha digitável do boleto.
  • bankAssignor (string): Nome da instituição emissora.
Objeto 'pix_details'
  • transactionId (string): ID da transação.
  • transactionIdentification (string): Identificação da transação.
  • status (string): Status do processamento.
  • key (string): Chave PIX utilizada no pagamento.
  • emv (string): Código de barras/QRCode do PIX.
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>"
  },
  "updated_at": "<dateTime>",
  "paid_at": "<dateTime>",
  "payed_amount": "<number>",
  "bar_code": "<string>",
  "pix_code": "<string>",
  "boleto_details": {
     "transactionId": "<string>",
     "status": "<string>",
     "bankEmissor": "<string>",
     "bankNumber": "<string>",
     "bankAgency": "<string>",
     "bankAccount": "<string>",
     "barCode": "<string>",
     "bankLine": "<string>",
     "bankAssignor": "<string>"
  },
  "pix_details": {
     "transactionId": "<string>",
     "transactionIdentification": "<string>",
     "status": "<string>",
     "key": "<string>",
     "emv": "<string>"
  }
} 

Language
Credentials
Bearer
URL
Click Try It! to start a request and see the response here!