# Listar todas as Autorizações de Pagamento

Liste todas as Autorizações de Pagamento associadas à sua conta Belvo.

Endpoint: GET /payments/br/payment-authorizations/
Version: 1.223.0
Security: basicAuth

## Header parameters:

  - `X-Belvo-API-Resource-Version` (string)
    Header indicating which version of the Payment API you want to use. Currently this is only applicable for Bank Accounts, Customers, and Payment Authorizations in Brazil. In the case that you are using our Payment Authorizations product (including Smart Transfers authorizations and their Charges), then you must send through this header set to Payments-BR.V2.
    Enum: "Payments-BR.V2"

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

  - `id__in` (array)
    Retorne informações para esses ids de recurso.
    Example: ["6b3dea0f-be29-49d1-aabe-1a6d588642e6"]

  - `amount` (number)
    Retorne resultados apenas para este valor.
    Example: 1000.02

  - `amount__gt` (number)
    Retorne resultados apenas para valores acima deste montante.
    Example: 1000.02

  - `amount__gte` (number)
    Retorne resultados apenas para e acima deste valor.
    Example: 1000.02

  - `amount__lt` (number)
    Retorne resultados apenas para menos do que este valor.
    Example: 1000.02

  - `amount__lte` (number)
    Retorne resultados apenas para este valor ou menos.
    Example: 1000.02

  - `amount__range` (array)
    Retorne resultados dentro deste intervalo de valores. O primeiro valor indica o início do intervalo e o segundo valor indica o final do intervalo.
    Example: [100,5000]

  - `created_at` (string)
    Retorne itens que foram atualizados pela última vez no banco de dados da Belvo nesta data (no formato YYYY-MM-DD).
    Example: "2022-05-05"

  - `created_at__gt` (string)
    Retorne itens que foram atualizados pela última vez no banco de dados da Belvo após esta data (no formato YYYY-MM-DD).
    Example: "2022-05-05"

  - `created_at__gte` (string)
    Retorne itens que foram atualizados pela última vez no banco de dados da Belvo após ou nesta data (no formato YYYY-MM-DD).
    Example: "2022-05-04"

  - `created_at__lt` (string)
    Retorne itens que foram atualizados pela última vez no banco de dados da Belvo antes desta data (no formato YYYY-MM-DD).
    Example: "2022-04-01"

  - `created_at__lte` (string)
    Retorne itens que foram atualizados pela última vez no banco de dados da Belvo antes ou na data especificada (no formato YYYY-MM-DD).
    Example: "2022-03-30"

  - `created_at__range` (array)
    Retorne contas que foram atualizadas pela última vez no banco de dados do Belvo entre duas datas (no formato YYYY-MM-DD). O primeiro valor indica o início do intervalo e o segundo valor indica o final do intervalo.
    Example: ["2022-01-01","2022-12-31"]

  - `customer` (string)
    O customer.id para o qual você deseja obter resultados.
    Example: "24e5b3a5-19aa-40fe-91e5-4db7f22ecc2d"

  - `customer__in` (array)
    Um ou mais customer.ids para os quais você deseja obter resultados.
    Example: ["cb320adc-9a6b-4224-933a-5b08cf771ac7"]

  - `external_id` (string)
    Retornar objetos com este ID externo.
    Example: "295ebb46-65b8-47de-85cd-34ffbc327c09"

  - `external_id__in` (array)
    Retorne objetos com esses IDs externos.
    Example: ["446bdd9f-5b3e-4c05-9159-7a5c87cfc810"]

  - `search` (string)
    Retorne resultados que correspondam à descrição que você pesquisou.

Nota:

Este filtro suporta consultas de pesquisa completas e parciais, com um mínimo de três caracteres necessários.

Por exemplo, pesquisar por trai pode corresponder aos seguintes valores:

  - Awesome training sneakers 
  - Training equipment

Pesquisar por car pode corresponder aos seguintes valores:

  - Carlos Vives
  - Carmen Domínguez 
  - carlos.vives@musicabrazil.br
    Example: "trai"

  - `updated_at` (string)
    Retorne itens que foram atualizados pela última vez no banco de dados da Belvo nesta data (no formato YYYY-MM-DD).
    Example: "2022-05-05"

  - `updated_at__gt` (string)
    Retorne itens que foram atualizados pela última vez no banco de dados da Belvo após esta data (no formato YYYY-MM-DD).
    Example: "2022-05-05"

  - `updated_at__gte` (string)
    Retorne itens que foram atualizados pela última vez no banco de dados da Belvo após ou nesta data (no formato YYYY-MM-DD).
    Example: "2022-05-04"

  - `updated_at__lt` (string)
    Retorne itens que foram atualizados pela última vez no banco de dados da Belvo antes desta data (no formato YYYY-MM-DD).
    Example: "2022-04-01"

  - `updated_at__lte` (string)
    Retorne itens que foram atualizados pela última vez no banco de dados da Belvo antes ou na data especificada (no formato YYYY-MM-DD).
    Example: "2022-03-30"

  - `updated_at__range` (array)
    Retorne contas que foram atualizadas pela última vez no banco de dados do Belvo entre duas datas (no formato YYYY-MM-DD). O primeiro valor indica o início do intervalo e o segundo valor indica o final do intervalo.
    Example: ["2022-01-01","2022-12-31"]

## 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 autorização de pagamento.

  - `results.id` (string, required)
    O Belvo ID para a Autorização de Pagamento.
    Example: "9fc68b84-f2d6-4142-b2ad-9d2d1ad70432"

  - `results.created_at` (string, required)
    O timestamp ISO-8601 de quando a Autorização de Pagamento foi criada.
    Example: "2025-05-20T09:55:02Z"

  - `results.updated_at` (string, required)
    O carimbo de data e hora ISO-8601 de quando a Autorização de Pagamento foi atualizada pela última vez.
    Example: "2025-05-20T09:55:02Z"

  - `results.status` (string, required)
    The current status of the Payment Authorization. Can be one of:
  - AWAITING_AUTHORIZATION: the authorization was created and is waiting for your user to approve it at their institution (using the payment_method_configuration.authorization_url).
  - PARTIALLY_ACCEPTED: your user approved the authorization, but the account requires approval from additional account holders before it becomes AUTHORIZED.
  - AUTHORIZED: the authorization was approved. For Smart Transfers, you can now create Charges.
  - FAILED: the authorization was rejected by the user or the institution, or could not be created. See status_reason_code for the reason.
  - CONSUMED: the authorization was fully used and cannot be used for further payments. For Smart Transfers, this happens when the total_allowed_amount is used up, or when the authorization expires. Reaching a periodic_limits cap (day, week, month or year) does not consume the authorization: it only blocks new Charges until that window resets.
  - REVOKED: the authorization was revoked by the payer, by the beneficiary, or by you using the Cancel a Payment Authorization endpoint. See status_reason_code for details.
    Enum: "AWAITING_AUTHORIZATION", "PARTIALLY_ACCEPTED", "AUTHORIZED", "FAILED", "CONSUMED", "REVOKED"

  - `results.status_reason_code` (string,null, required)
    A code indicating the reason for the current status, when the status is FAILED or REVOKED. null for other statuses.

For PIX_OF_SMART_TRANSFERS authorizations, the possible codes are:
  - USER_REJECTED: the payer rejected the authorization at their institution.
  - AUTHORIZATION_EXPIRED: the payer did not approve the authorization within the allowed time.
  - BANK_USER_MISMATCH: the user who logged in to the institution is not the payer of the authorization.
  - IDENTIFIER_MISMATCH: the payer's CPF or CNPJ does not match the holder of the account at the institution.
  - FEATURE_NOT_ENABLED_BY_INSTITUTION: the institution does not support Smart Transfers.
  - INSUFFICIENT_PERMISSION: the payer does not have enough permissions on the account to approve the authorization.
  - SAME_ORIGIN_DESTINATION_ACCOUNTS: the payer account and the beneficiary account are the same account.
  - ACCOUNT_NOT_ALLOWED: the payer account does not allow payments.
  - INSUFFICIENT_FUNDS: the institution rejected the authorization because the payer account has insufficient funds.
  - AMOUNT_OVER_LIMIT: the requested limits exceed the limits set by the institution.
  - OPEN_FINANCE_NETWORK_FAILURE: an infrastructure failure in the Open Finance network prevented the authorization.
  - NO_REASON_PROVIDED: the institution rejected or revoked the authorization without giving a reason.
  - REJECTED_UNKNOWN: the institution rejected the authorization for a reason not covered by the other codes.
  - PAYER_REVOKED_AUTHORIZATION: the payer revoked the authorization (status REVOKED).
  - BENEFICIARY_REVOKED_AUTHORIZATION: the beneficiary revoked the authorization (status REVOKED).
  - REVOKED_UNKNOWN: the authorization was revoked for a reason not covered by the other codes (status REVOKED).
  - UNEXPECTED_ERROR: Belvo could not create the authorization at the institution. Contact support with the request ID.

  - `results.status_reason_message` (string,null, required)
    Uma mensagem legível por humanos explicando o motivo do status atual (quando aplicável).

  - `results.status_updated_at` (string, required)
    O carimbo de data e hora ISO-8601 de quando o status foi atualizado pela última vez.
    Example: "2025-05-20T09:55:02Z"

  - `results.authorized_at` (string,null, required)
    O timestamp ISO-8601 de quando a Autorização de Pagamento foi autorizada pelo usuário.
    Example: "2025-05-20T09:55:02Z"

  - `results.external_id` (string,null, required)
    O ID interno do comerciante para a autorização.
    Example: "c169a8a9-e9f5-48db-9f4a-818caef9356b"

  - `results.description` (string, required)
    Uma descrição interna usada apenas pelo comerciante.
    Example: "Internal description used by the merchant only"

  - `results.return_url` (string, required)
    A URL para onde o usuário será redirecionado após a autorização.
    Example: "https://merchant.com/return"

  - `results.expiration_date_time` (string,null)
    The ISO-8601 timestamp after which the authorization can no longer be used. null if no expiration date was set.
    Example: "2027-10-31T23:59:59Z"

  - `results.payment_method` (string, required)
    The payment method that was authorized. Can be one of:
  - PIX_OF_IMMEDIATE: a single Pix payment, made immediately.
  - PIX_OF_SCHEDULED: a single Pix payment, scheduled for a future date.
  - PIX_OF_SMART_TRANSFERS: Smart Transfers, on-demand transfers between accounts held by the same person or business. You create each transfer as a Charge.
    Enum: "PIX_OF_IMMEDIATE", "PIX_OF_SCHEDULED", "PIX_OF_SMART_TRANSFERS"

  - `results.payer` (object, required)
    Detalhes sobre o pagador.

  - `results.payer.customer` (string)
    O ID Belvo para o cliente.
    Example: "533e7a9b-e6c7-4bd4-be79-3a3c3bd78044"

  - `results.payer.institution` (string)
    O ID Belvo da instituição que o pagador usará.
    Example: "770932b4-8f1f-4b0f-8470-1c605903fdb2"

  - `results.payer.representative_identifier` (string,null)
    In the case that the customer is a business, the CPF of the representative authorized to make payments. null for individual customers.
    Example: "12345678901122"

  - `results.payer.bank_account` (object,null)
    The payer's account that the user selected at their institution when approving the authorization, with sensitive values masked. null until the authorization is AUTHORIZED, or if the institution did not return the account.

  - `results.payer.bank_account.holder` (object)
    The holder of the payer's account.

  - `results.payer.bank_account.holder.identifier` (string)
    The CPF or CNPJ of the account holder, masked.
    Example: "***456789**"

  - `results.payer.bank_account.details` (object)
    Details of the payer's account.

  - `results.payer.bank_account.details.account_type` (string)
    The type of the payer's account. Can be one of:
  - CHECKINGS: checking account (Conta Corrente).
  - SAVINGS: savings account (Conta Poupança).
  - SALARY: salary account (Conta Salário).
  - PAYMENTS: prepaid payment account (Conta de Pagamento Pré-Paga).
    Enum: "CHECKINGS", "SAVINGS", "SALARY", "PAYMENTS"

  - `results.payer.bank_account.details.agency` (string)
    The agency (branch) number of the payer's account. All but the last 4 characters are masked.
    Example: "0001"

  - `results.payer.bank_account.details.code` (string)
    The ISPB code of the institution that holds the payer's account.
    Example: "12345678"

  - `results.payer.bank_account.details.number` (string)
    The payer's account number. All but the last 4 characters are masked.
    Example: "***4567"

  - `results.beneficiary` (object, required)
    Detalhes sobre o beneficiário do pagamento.

  - `results.beneficiary.type` (string)
    O tipo de conta do beneficiário.
    Enum: "BANK_ACCOUNT"

  - `results.beneficiary.target` (string)
    O ID Belvo da conta bancária que receberá os fundos.
    Example: "b6278377-f710-4d1a-a026-7bab757256d0"

  - `results.payment_method_configuration` (object, required)
    Detalhes de configuração para o método de pagamento.

  - `results.charges` (array, required)
    Uma lista de IDs de Cobrança associados à Autorização de Pagamento.
    Example: ["7d159b21-9f25-4365-9fa2-734d20797819"]

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

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