# Liste todas as cobranças para uma intenção de pagamento

Liste todas as cobranças associadas a uma intenção de pagamento.

Endpoint: GET /payments/br/payment-intents/{payment_intent_id}/charges/
Version: 1.223.0
Security: basicAuth

## Path parameters:

  - `payment_intent_id` (string, required)
    O payment-intent.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-34d1044cb908page=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, required)
    Identificador único da Belvo para o item atual.
    Example: "0d3ffb69-f83b-456e-ad8e-208d0998d71d"

  - `results.created_at` (string, required)
    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.updated_at` (string,null, required)
    O carimbo de data e hora ISO-8601 de quando o status da cobrança foi atualizado pela última vez.
    Example: "2022-02-09T08:45:50.406032Z"

  - `results.created_by` (string)
    O ID único para o usuário que criou este item.
    Example: "bcef7f35-67f2-4b19-b009-cb38795faf09"

  - `results.customer` (string)
    ID único da Belvo para o cliente para o qual a cobrança foi criada.
    Example: "531aa631-70a0-4eeb-ab97-51dea3e90c89"

  - `results.payment_intent` (string)
    O payment_intent.id associado a esta cobrança.
    Example: "50c04229-7b1d-4a53-951c-8ad53e10c6ca"

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

  - CANCELED
  - PENDING
  - SCHEDULED
  - SUCCEEDED
  - FAILED
  - PARTIAL
    Enum: "CANCELED", "PENDING", "SCHEDULED", "SUCCEEDED", "FAILED", "PARTIAL"

  - `results.amount` (string,null, required)
    O valor da cobrança.
    Example: "100.12"

  - `results.currency` (string)
    A moeda do valor pago. Para 🇧🇷 Brasil, o valor deve ser BRL (Real Brasileiro).
    Enum: "BRL"

  - `results.description` (string)
    A descrição do pagamento.
    Example: "Training shoes"

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

  - `results.beneficiary` (string, required)
    ID único do Belvo usado para identificar a conta bancária do beneficiário.
    Example: "58524ccc-89ac-4ab6-b62b-c3da3f19a722"

  - `results.payment_method_type` (string)
    Método de pagamento selecionado. Para OFPI do 🇧🇷 Brasil, o valor deve ser open_finance.
    Enum: "open_finance"

  - `results.payment_method_details` (object, required)
    Detalhes sobre o método de pagamento.

  - `results.payment_method_details.open_finance` (object)
    Informações sobre o pagador de um pagamento OFPI.

  - `results.payment_method_details.open_finance.schedule` (object,null) — one of:
    Detalhes sobre o pagamento agendado (opcional). Para mais informações sobre como agendar pagamentos, consulte nosso guia dedicado OFPI Scheduled Payments.
    - Único:
      - `single` (object,null)
        Detalhes sobre o pagamento agendado (único).
      - `single.date` (string)
        A data em que o pagamento agendado único deve ser feito, no formato YYYY-MM-DD.
        Example: "2024-10-22"
    - Diário:
      - `daily` (object)
        Detalhes sobre o pagamento recorrente diário.
      - `daily.start_date` (string)
        A data em que o pagamento diário recorrente deve começar, no formato YYYY-MM-DD.

>Nota: A start_date deve ser pelo menos 1 dia no futuro.
        Example: "2024-10-22"
      - `daily.occurrences` (integer)
        O número de vezes que o pagamento deve se repetir.

>Nota: Você deve agendar pelo menos 2 ocorrências e no máximo 60.
        Example: 10
    - Semanalmente:
      - `weekly` (object)
        Detalhes sobre o pagamento recorrente semanal.
      - `weekly.start_date` (string)
        A data em que o pagamento semanal recorrente deve começar, no formato YYYY-MM-DD.

>Nota: A start_date deve corresponder ao primeiro day_of_week especificado e ser pelo menos 1 dia no futuro.
        Example: "2024-10-22"
      - `weekly.day_of_week` (string)
        O dia da semana em que o pagamento deve ser feito. Pode ser um dos seguintes valores:

  - MONDAY
  - TUESDAY
  - WEDNESDAY
  - THURSDAY
  - FRIDAY
  - SATURDAY
  - SUNDAY
        Enum: "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY"
      - `weekly.occurrences` (integer)
        O número de vezes que o pagamento deve se repetir.

>Nota: Você deve agendar pelo menos 2 ocorrências e no máximo 60.
        Example: 10
    - Mensalmente:
      - `monthly` (object)
        Detalhes sobre o pagamento recorrente mensal.
      - `monthly.start_date` (string)
        A data em que o pagamento mensal recorrente deve começar, no formato YYYY-MM-DD.

>Nota: O start_date deve corresponder ao primeiro day_of_month especificado e ser pelo menos 1 dia no futuro.
        Example: "2024-10-26"
      - `monthly.day_of_month` (integer)
        O dia do mês em que o pagamento deve ser feito. Pode ser qualquer número inteiro entre 1 e 31.
        Example: 26
      - `monthly.occurrences` (integer)
        O número de vezes que o pagamento deve se repetir.

>Nota: Você deve agendar pelo menos 2 ocorrências e no máximo 24.
        Example: 12
    - Personalizado:
      - `custom` (object)
        Detalhes sobre o pagamento recorrente personalizado.
      - `custom.dates` (array)
        As datas únicas em que o pagamento recorrente deve ser feito, no formato YYYY-MM-DD.

>Nota: As datas devem ser pelo menos 1 dia no futuro e não mais do que 720 dias no futuro.
        Example: ["2024-10-22","2024-10-26"]
      - `custom.description` (string)
        Uma descrição do pagamento recorrente personalizado que será exibida ao seu usuário quando ele for redirecionado para o banco para aceitar o pagamento.

> Nota: Recomendamos fortemente que esta mensagem esteja em português brasileiro e que explique claramente o propósito e a natureza recorrente do pagamento.
        Example: "Os pagamentos ocorrerão a cada três dias até a data final (30.09.2024)"

  - `results.payment_method_details.open_finance.payer_institution` (string)
    Identificador único para a instituição do pagador.
    Example: "db201c6a-e0ee-4caa-92d6-72b480d6d86f"

  - `results.payment_method_details.open_finance.beneficiary_bank_account` (string)
    ID único da Belvo usado para identificar a conta bancária do beneficiário.
    Example: "a80d5a9d-20ae-479a-8dd7-ff3443bcbbfc"

  - `results.payment_method_information` (object, required)
    Informações sobre o método de pagamento selecionado.

  - `results.payment_method_information.open_finance` (object)
    Tipo de método de pagamento selecionado.

  - `results.payment_method_information.open_finance.provider_request_id` (string,null)
    ID único para o pagamento, conforme enviado pelo provedor.
    Example: "978c0c97ea847e78e8849634473c1f1"

  - `results.payment_method_information.open_finance.redirect_url` (string,null)
    A URL que redireciona o usuário para o site da sua instituição para autorizar o pagamento.
    Example: "https://wakandanational.com/"

  - `results.payment_method_information.open_finance.end_to_end_id` (string,null)
    Um ID único para a transação no sistema de pagamento PIX do Brasil.
    Example: "F203262942022211117487a213b1d140"

  - `results.payment_method_information.open_finance.settlement_date` (string)
    O campo settlement_date indica a data em que um pagamento agendado (cobrança) está planejado para ser liquidado. Este campo é relevante em vários estados do ciclo de vida da cobrança:

  - Cobranças Agendadas: Quando uma cobrança tem o status SCHEDULED, este campo representa a data planejada para liquidação.
  - Cobranças Concluídas: Quando uma cobrança tem o status SUCCEEDED, este campo reflete a data em que o pagamento foi realizado.
  - Cobranças Falhas ou Canceladas: Quando uma cobrança tem o status CANCELED ou FAILED, este campo ainda conterá a data de liquidação originalmente calculada, indicando quando a cobrança estava prevista para ser liquidada.

> Nota: O settlement_date não muda com base no sucesso ou falha da cobrança. Ele reflete consistentemente a data de liquidação planejada originalmente.
    Example: "2024-10-22"

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

> Nota: Este objeto só é retornado quando o status da cobrança é SUCCEEDED.

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

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

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

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

  - `results.payer_information.bank_account.institution_id` (string)
    O ID da instituição Belvo da conta bancária do pagador.
    Example: "528228e2-d40d-4cec-948d-ec5edd7d081c"

  - `results.transactions` (array)
    Um array de objetos Transaction relacionados à cobrança.

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

  - `results.transactions.created_at` (string, required)
    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.transactions.created_by` (string, required)
    O ID único para o usuário que criou este item.
    Example: "bcef7f35-67f2-4b19-b009-cb38795faf09"

  - `results.transactions.amount` (string, required)
    O valor da transação.

Nota: O valor exibido é sempre positivo, pois indicamos a direção da transação no parâmetro transaction_type.
    Example: "1020.00"

  - `results.transactions.currency` (string, required)
    A moeda do valor pago, por exemplo, BRL (Real Brasileiro).
    Enum: same as `results.currency` (1 values)

  - `results.transactions.description` (string, required)
    A descrição do pagamento.
    Example: "Training shoes"

  - `results.transactions.transaction_type` (string, required)
    A direção da transação.

  - INFLOW indica dinheiro entrando na conta.
  - OUTFLOW indica dinheiro saindo da conta.
    Enum: "INFLOW", "OUTFLOW"

  - `results.transactions.beneficiary` (string, required)
    ID único da Belvo usado para identificar a conta bancária do beneficiário.
    Example: "a80d5a9d-20ae-479a-8dd7-ff3443bcbbfc"

  - `results.transactions.payer` (any, required)
    Nota: Para OFPI, isso retornará um objeto vazio {}.

  - `results.transactions.payment_intent` (string)
    O ID único da intenção de pagamento associado à transação.
    Example: "004a28bb-fac2-4172-884b-5b6ea15314ad"

  - `results.transactions.customer` (string)
    ID único da Belvo para o cliente associado a esta transação.
    Example: "9eebd63b-3339-44a9-8a5a-72bb6cb2f310"

  - `results.failure_code` (string,null, required)
    Código de erro que explica o motivo pelo qual um pagamento não foi bem-sucedido (se aplicável).

  - `results.failure_message` (string,null, required)
    Mais informações sobre o failure_code.

  - `results.metadata` (object, required)
    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.

⚠️ Nota: Você pode fornecer até 50 chaves (as chaves podem ter até 50 caracteres cada e cada valor pode ter até 500 caracteres). Não oferecemos suporte a objetos aninhados, apenas valores ASCII.
    Example: {"internal_reference_id":"GGq73487w2"}

  - `results.provider` (string, required)
    Nota: Este campo foi descontinuado e será removido da API no futuro.

O provedor usado para o link de pagamento.
    Enum: "belvo"

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