# Obter detalhes sobre uma Cobrança 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 Belvo.
{% /admonition %}

Obtenha os detalhes sobre uma Charge específica associada a uma Payment Authorization.

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

## Header parameters:

  - `X-Belvo-API-Resource-Version` (string)
    Cabeçalho indicando qual versão da API de Pagamentos você deseja usar. Atualmente, isso é aplicável apenas para Contas Bancárias, Clientes e Autorizações de Pagamento no Brasil. No caso de você estar usando nosso produto de Autorizações de Pagamento, então você deve enviar este cabeçalho configurado para Payments-BR.V2.

{% admonition type="warning" name="Em Breve" %}
  Esta versão está em breve lançamento. Portanto, pequenas alterações ou bugs podem ocorrer. Se você encontrar algum problema, entre em contato com seu representante da Belvo.
{% /admonition %}
    Enum: "Payments-BR.V2"

## Path parameters:

  - `payment_authorization_id` (string, required)
    O payment-authorization.id ao qual o Charge pertence.
    Example: "a3b92311-1888-449f-acaa-49ae28d68fcd"

  - `charge_id` (string, required)
    O charge.id sobre o qual você deseja obter detalhes.
    Example: "a3b92311-1888-449f-acaa-49ae28d68fcd"

## Response 200 fields (application/json):

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

  - `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"

  - `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"

  - `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"

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

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

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

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

  - `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"

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

  - `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"

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

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

  - `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"

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

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

  - `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"

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

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

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

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

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

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

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

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

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

  - `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"

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

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

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

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

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

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

  - `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"}

  - `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"

  - `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"