# Listar todas as Cobranças para uma Autorização de Pagamento

{% admonition type="warning" name="Em Breve" %}
  Este endpoint está atualmente em desenvolvimento. Portanto, pequenas alterações ou bugs podem ocorrer. Se você encontrar algum problema, entre em contato com seu representante da Belvo.
{% /admonition %}

Liste todas as Cobranças associadas a uma Autorização de Pagamento.

Endpoint: GET /payments/br/payment-authorizations/{payment_authorization_id}/charges/
Version: 1.223.0
Security: basicAuth

## Path parameters:

  - `payment_authorization_id` (string, required)
    O payment-authorization.id ao qual as cobranças pertencem.
    Example: "a3b92311-1888-449f-acaa-49ae28d68fcd"

## Query parameters:

  - `page` (integer)
    Um número de página dentro do conjunto de resultados paginados.
    Example: 1

  - `page_size` (integer)
    Indica quantos resultados retornar por página. Por padrão, retornamos 100 resultados por página.

ℹ️ O número mínimo de resultados retornados por página é 1 e o máximo é 1000. Se você inserir um valor maior que 1000, nossa API usará o valor máximo por padrão (1000).
    Example: 100

  - `status` (string)
    Retorne resultados apenas para este valor.
    Example: "SUCCEEDED"

  - `status__in` (string)
    Retornar resultados para o status listado.
    Example: "PENDING,SUCCEEDED"

## Response 200 fields (application/json):

  - `count` (integer)
    O número total de resultados na sua conta Belvo.
    Example: 130

  - `next` (string,null)
    A URL para a próxima página de resultados. Cada página consiste em até 100 itens. Se não houver resultados suficientes para uma página adicional, o valor será null.

Em nosso exemplo de documentação, usamos {endpoint} como um valor de espaço reservado. Em produção, esse valor será substituído pelo endpoint real que você está usando atualmente (por exemplo, accounts ou owners).
    Example: "https://sandbox.belvo.com/api/{endpoint}/?link=1bd948f7-245d-4313-b604-34d1044cb908&page=2"

  - `previous` (string,null)
    A URL para a página anterior de resultados. Se não houver uma página anterior, o valor será null.

  - `results` (array)
    Array de objetos de charge.

  - `results.id` (string)
    Identificador único da Belvo para o item atual.
    Example: "0d3ffb69-f83b-456e-ad8e-208d0998d71d"

  - `results.created_at` (string)
    O carimbo de data e hora ISO-8601 de quando o ponto de dados foi criado no banco de dados da Belvo.
    Example: "2022-02-09T08:45:50.406032Z"

  - `results.status_updated_at` (string,null)
    O carimbo de data e hora ISO-8601 de quando o status da Cobrança foi atualizado pela última vez.
    Example: "2025-06-09T08:45:50.406032Z"

  - `results.status` (string)
    O status atual da Cobrança. Pode ser um dos seguintes valores:

  - PENDING
  - SCHEDULED
  - SETTLED
  - CANCELED
  - FAILED
    Enum: "PENDING", "SCHEDULED", "SETTLED", "CANCELED", "FAILED"

  - `results.status_reason_code` (string,null)
    O código de motivo para o status atual da Cobrança, se aplicável.

  - `results.status_reason_message` (string,null)
    Mais informações sobre o status_reason_code.

  - `results.amount` (string,null)
    O valor da Charge.
    Example: "100.12"

  - `results.date` (string,null)
    A data original da Cobrança.
    Example: "2025-06-09"

  - `results.end_to_end_id` (string,null)
    O ID de ponta a ponta da Cobrança. Este é um identificador único para a transação que pode ser usado para rastreá-la em diferentes sistemas.
    Example: "1234567890abcdef"

  - `results.statement_description` (string)
    A descrição que aparecerá no extrato bancário do cliente (se fornecida).
    Example: "Super Shoe Store - Brown Sneakers"

  - `results.external_id` (string)
    Um identificador exclusivo adicional para o recurso para fins internos.

{% admonition type="success" name="Altamente Recomendado" %}
  Recomendamos usar este campo para armazenar seu próprio identificador exclusivo para cada recurso (cliente, conta bancária, intenção de pagamento ou inscrição). Isso pode ser útil para rastrear o recurso em seu sistema e para fins de depuração.
{% /admonition %}
    Example: "4b8a81a0-e33c-45a6-8567-479efb105f73"

  - `results.beneficiary` (object)
    Informações sobre o beneficiário da Cobrança.

  - `results.beneficiary.bank_account` (object)
    Informações sobre a conta bancária do beneficiário.

  - `results.beneficiary.bank_account.id` (string)
    ID único da Belvo usado para identificar a conta bancária do beneficiário.
    Example: "088bc38f-1430-40c5-a5d2-80bd67189d11"

  - `results.beneficiary.bank_account.holder` (object)
    Informações sobre o titular da conta bancária do beneficiário.

  - `results.beneficiary.bank_account.holder.name` (string)
    O nome completo do titular da conta bancária do beneficiário.
    Example: "Jane Smith"

  - `results.beneficiary.bank_account.holder.identifier` (string)
    O identificador do titular da conta bancária do beneficiário. Pode ser um CPF (11 caracteres) ou CNPJ (14 caracteres).
    Example: "12345678901"

  - `results.beneficiary.bank_account.details` (object)
    Detalhes da conta bancária do beneficiário.

  - `results.beneficiary.bank_account.details.institution` (string)
    ID único do Belvo usado para identificar o banco do beneficiário.
    Example: "f47ac10b-58cc-4372-a567-0e02b2c3d479"

  - `results.beneficiary.bank_account.details.agency` (string)
    O número da agência da conta bancária do beneficiário.
    Example: "5678"

  - `results.beneficiary.bank_account.details.number` (string)
    O número da conta do banco do beneficiário.
    Example: "987654321"

  - `results.beneficiary.bank_account.details.account_type` (string)
    O tipo da conta bancária do beneficiário. Pode ser CHECKINGS, SAVINGS ou PAYMENTS.
    Example: "SAVINGS"

  - `results.beneficiary.bank_account.details.code` (string)
    O código ISPB do banco do beneficiário.
    Example: "678901"

  - `results.payer` (object)
    Informações sobre o pagador da Cobrança.

  - `results.payer.bank_account` (object)
    Informações sobre a conta bancária do pagador.

  - `results.payer.bank_account.holder` (object)
    Informações sobre o titular da conta bancária do pagador.

  - `results.payer.bank_account.holder.identifier` (string)
    O identificador do titular da conta bancária do pagador. Pode ser um CPF (11 caracteres) ou CNPJ (14 caracteres).
    Example: "12345678902"

  - `results.payer.bank_account.details` (object)
    Detalhes da conta bancária do pagador.

  - `results.payer.bank_account.details.institution` (string)
    ID único do Belvo usado para identificar o banco do pagador.

  - `results.payer.bank_account.details.code` (string)
    O código ISPB do banco do pagador.
    Example: "123345"

  - `results.payer.bank_account.details.account_type` (string)
    O tipo da conta bancária do pagador. Pode ser CHECKINGS, SAVINGS ou PAYMENTS.
    Example: "CHECKINGS"

  - `results.payer.bank_account.details.agency` (string)
    O número da agência da conta bancária do pagador.
    Example: "1234"

  - `results.payer.bank_account.details.number` (string)
    O número da conta bancária do pagador.
    Example: "123456789"

  - `results.metadata` (object)
    Objeto opcional e personalizável onde você pode fornecer quaisquer pares de chave-valor adicionais para seus propósitos internos. Por exemplo, um número de referência interno para a intenção de pagamento.

{% admonition type="info" name="Limitações de Metadata" %}
  Você pode fornecer até 50 chaves (as chaves podem ter até 50 caracteres cada e cada valor pode ter até 500 caracteres). Não suportamos objetos aninhados, apenas valores ASCII.
{% /admonition %}
    Example: {"internal_reference_id":"GGq73487w2"}

  - `results.next` (string,null)
    O ID Belvo da próxima Cobrança na sequência (aplicável apenas se a Cobrança foi tentada novamente). Se for null, isso indica que não há mais Cobranças na sequência.
    Example: "7d159b21-9f25-4365-9fa2-734d20797819"

  - `results.previous` (string,null)
    O ID Belvo da Cobrança anterior na sequência (aplicável apenas se a Cobrança foi tentada novamente). Se for null, indica que não há Cobranças anteriores na sequência.
    Example: "7d159b21-9f25-4365-9fa2-734d20797818"

## Response 403 fields (application/json):

  - `code` (string)
    Um código de erro único (access_to_resource_denied) que permite classificar e tratar o erro programaticamente.

ℹ️ Consulte nosso DevPortal para mais informações sobre como lidar com 403 access_to_resource_denied.
    Example: "access_to_resource_denied"

  - `message` (string)
    Uma breve descrição do erro.

Para erros access_to_resource_denied, a descrição é:

  - You don't have access to this resource..
    Example: "You don't have access to this resource."

  - `request_id` (string)
    Um ID único de 32 caracteres da solicitação (correspondente a um padrão regex de: [a-f0-9]{32}). Forneça este ID ao entrar em contato com a equipe de suporte da Belvo para acelerar as investigações.
    Example: "9e7b283c6efa449c9c028a16b5c249fb"

## Response 404 fields (application/json):

  - `code` (string)
    Um código de erro único (not_found) que permite classificar e lidar com o erro programaticamente.
    Example: "not_found"

  - `message` (string)
    Uma breve descrição do erro.

Para erros not_found, a descrição é:

  - Not found
    Example: "Not found"

  - `request_id` (string)
    Um ID único de 32 caracteres da solicitação (correspondente a um padrão regex de: [a-f0-9]{32}). Forneça este ID ao entrar em contato com a equipe de suporte da Belvo para acelerar as investigações.
    Example: "9e7b283c6efa449c9c028a16b5c249fb"

## Response 408 fields (application/json):

  - `code` (string)
    Um código de erro único (request_timeout) que permite classificar e lidar com o erro programaticamente.

ℹ️ Consulte nosso DevPortal para mais informações sobre como lidar com erros 408 request_timeout.
    Example: "request_timeout"

  - `message` (string)
    Uma breve descrição do erro.

Para erros de request_timeout, a descrição é:

  - The request timed out, you can retry asking for less data by changing your query parameters.
    Example: "The request timed out, you can retry asking for less data by changing your query parameters"

  - `request_id` (string)
    Um ID único de 32 caracteres da solicitação (correspondente a um padrão regex de: [a-f0-9]{32}). Forneça este ID ao entrar em contato com a equipe de suporte da Belvo para acelerar as investigações.
    Example: "9e7b283c6efa449c9c028a16b5c249fb"

## Response 500 fields (application/json):

  - `code` (string)
    Um código de erro único (unexpected_error) que permite classificar e tratar o erro de forma programática.

ℹ️ Consulte nosso DevPortal para mais informações sobre como lidar com erros 500 unexpected_error.
    Example: "unexpected_error"

  - `message` (string)
    Uma breve descrição do erro.

Para erros unexpected_error, a descrição é:

  - Belvo não consegue processar a solicitação devido a um problema interno do sistema ou a uma resposta não suportada de uma instituição.
    Example: "Belvo is unable to process the request due to an internal system issue or to an unsupported response from an institution"

  - `request_id` (string)
    Um ID único de 32 caracteres da solicitação (correspondente a um padrão regex de: [a-f0-9]{32}). Forneça este ID ao entrar em contato com a equipe de suporte da Belvo para acelerar as investigações.
    Example: "9e7b283c6efa449c9c028a16b5c249fb"