# Obter detalhes sobre uma intenção de pagamento

Obtenha os detalhes sobre uma intenção de pagamento específica.

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

## Path parameters:

  - `id` (string, required)
    O payment-intent.id sobre o qual você deseja obter informações detalhadas.
    Example: "a3b92311-1888-449f-acaa-49ae28d68fcd"

## Response 200 fields (application/json):

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

  - `customer` (string, required)
    ID único da Belvo para o cliente relacionado a esta intenção de pagamento.
    Example: "1c83ead8-6665-429c-a17a-ddc76cb3a95e"

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

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

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

  - `updated_at` (string,null, required)
    O timestamp ISO-8601 de quando a intenção de pagamento foi atualizada pela última vez.
    Example: "2022-02-09T08:45:50.406032Z"

  - `status` (string, required)
    O status atual da intenção de pagamento.
    Enum: "REQUIRES_PAYMENT_METHOD", "REQUIRES_ACTION", "SUCCEEDED", "PROCESSING", "FAILED"

  - `amount` (string, required)
    Valor a ser pago pelo seu cliente.
    Example: "1234.12"

  - `currency` (string, required)
    A moeda do valor pago, por exemplo, BRL (Real Brasileiro).
    Enum: "BRL"

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

  - `statement_description` (string)
    Uma descrição que aparecerá no extrato bancário do cliente (recomendado).

> Nota: Se você não usar o parâmetro statement_description, o valor de description será utilizado como a descrição no extrato.
    Example: "Super Shoe Store - Brown Sneakers"

  - `selected_payment_method_type` (string, required)
    Tipo de método de pagamento selecionado. Para OFPI do 🇧🇷 Brasil, pode ser:

  - open_finance: Para pagamentos regulares.
  - open_finance_biometric_pix: Para pagamentos biométricos usando a rede PIX.
    Enum: "open_finance", "open_finance_biometric_pix"

  - `allowed_payment_method_types` (array, required)
    Uma lista de tipos de métodos de pagamento permitidos nesta intenção de pagamento. Para OFPI, o valor será open_finance.
    Example: ["open_finance"]

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

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

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

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

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

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

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

  - `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).

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

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

⚠️ 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"}

  - `charges` (array)
    Um array de objetos de cobrança relacionados a esta intenção de pagamento. Se nenhuma cobrança estiver associada, retornamos um array vazio.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  - `charges.payment_method_details.open_finance.schedule` (object,null)
    Detalhes sobre o pagamento agendado (opcional). Para mais informações sobre como agendar pagamentos, consulte nosso guia dedicado OFPI Scheduled Payments.

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

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

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

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

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

  - `charges.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/"

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  - `charges.transactions.currency` (string, required)
    A moeda do valor pago, por exemplo, BRL (Real Brasileiro).
    Enum: "BRL"

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

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

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

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

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

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

  - `charges.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).

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

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

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

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

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

Informações sobre o erro que você encontrou na etapa anterior da intenção de pagamento, se aplicável. Este erro pode ocorrer quando algo inesperado acontece durante o processo de intenção de pagamento.

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

Objeto detalhando os próximos passos que você deve seguir para um tipo específico de next_step.

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