# Concluir uma intenção de pagamento Concluir uma nova intenção de pagamento. Endpoint: PATCH /payments/br/payment-intents/{id}/ Version: 1.223.0 Security: basicAuth ## Path parameters: - `id` (string, required) O payment-intent.id para o qual você deseja concluir o pagamento. Example: "a3b92311-1888-449f-acaa-49ae28d68fcd" ## Request fields (application/json): - `body` (object, required) — one of: - Chave Pix: - `confirm` (boolean, required) Boolean que indica se esta solicitação confirma a intenção de pagamento. Deve ser definido como true para confirmar a intenção de pagamento. Example: true - Conta Bancária: - `payment_method_details` (object, required) Objeto contendo campos adicionais obrigatórios para o fluxo de intenção de pagamento. - `payment_method_details.open_finance` (object, required) - `payment_method_details.open_finance.payer_institution` (string) ID único do Belvo para a instituição do pagador. Example: "db201c6a-e0ee-4caa-92d6-72b480d6d86f" - `payment_method_details.open_finance.beneficiary_bank_account` (string) ID único do Belvo para a conta bancária do beneficiário. Example: "a80d5a9d-20ae-479a-8dd7-ff3443bcbbfc" - `confirm` (boolean) Boolean que indica se esta solicitação confirma a intenção de pagamento. Example: true ## Response 200 fields (application/json): - `body` (object) — one of: - Chave Pix: - `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) — one of: Detalhes sobre o método de pagamento Chave Pix. - INDIVIDUAL: - `open_finance` (object, required) Tipo de método de pagamento selecionado. - `open_finance.pix_key` (string, required) A chave Pix associada ao beneficiário da transação. Pode ser um e-mail, número de telefone (incluindo o código do país, por exemplo, +5511999998888), CPF/CNPJ ou uma chave aleatória. {% admonition type="info" name="Mascaramento de Chave Pix" %} No caso de a Chave Pix fornecida ser um CPF, endereço de e-mail ou número de telefone, o valor em payment_method_details.open_finance.pix_key será mascarado. Se for um CNPJ ou uma chave Pix aleatória UUID, o valor não será mascarado. {% /admonition %} Example: "53497b80-81a2-4ea8-9296-83a909c05bdf" - `open_finance.payer_institution` (string, required) ID único do Belvo para referenciar a instituição do pagador. Example: "600f1b4a-1ef9-4f89-b341-1a35f0c32cc0" - `open_finance.callback_url` (string, required) A URL de callback para a qual seu usuário será redirecionado após confirmar o pagamento em seu aplicativo bancário. Example: "https://www.acmecorp.com/checkout/3487321" - `open_finance.cpf` (string,null) O número de CPF do cliente. Fornecido quando disponível; este valor é ofuscado nas respostas. Example: "23******00" - `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)" - NEGÓCIOS: - `open_finance` (object, required) Tipo de método de pagamento selecionado. - `open_finance.pix_key` (string, required) A chave Pix associada ao beneficiário da transação. Pode ser um e-mail, número de telefone (incluindo o código do país, por exemplo, +5511999998888), CPF/CNPJ ou uma chave aleatória. {% admonition type="info" name="Mascaramento de Chave Pix" %} No caso de a Chave Pix fornecida ser um CPF, endereço de e-mail ou número de telefone, o valor em payment_method_details.open_finance.pix_key será mascarado. Se for um CNPJ ou uma chave Pix aleatória UUID, o valor não será mascarado. {% /admonition %} Example: "53497b80-81a2-4ea8-9296-83a909c05bdf" - `open_finance.payer_institution` (string, required) ID único do Belvo para referenciar a instituição do pagador. Example: "600f1b4a-1ef9-4f89-b341-1a35f0c32cc0" - `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: same as `weekly.day_of_week` in "Semanalmente" (7 values) - `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)" - `open_finance.callback_url` (string, required) A URL de callback para a qual seu usuário será redirecionado após confirmar o pagamento em seu aplicativo bancário. Example: "https://www.acmecorp.com/checkout/3487321" - `open_finance.cpf` (string,null, required) O número de CPF do cliente. Fornecido quando disponível; este valor é ofuscado nas respostas. Example: "23******00" - `payment_method_information` (any, required) — one of: Informações sobre o método de pagamento Chave Pix. No momento da criação da intenção de pagamento, ela incluirá apenas a propriedade open_finance.pix_key_details, que você precisa mostrar ao seu usuário para confirmar que seus dados estão corretos (veja o esquema Inicial). Após a confirmação dos dados pelo usuário em sua aplicação e o envio da solicitação PATCH, este objeto será preenchido com propriedades adicionais (veja o esquema Confirmado). - Inicial: - `open_finance` (object) - `open_finance.pix_key_details` (object) Detalhes sobre a Chave Pix utilizada para o pagamento. Você precisa exibir essas informações para o seu usuário para que ele confirme que os detalhes estão corretos. Após a confirmação, você pode enviar uma solicitação PATCH para confirmar a Intenção de Pagamento. - `open_finance.pix_key_details.identifier` (string) O identificador mascarado do proprietário. Example: "23******00" - `open_finance.pix_key_details.name` (string) O nome do titular da Chave Pix. Example: "João da Silva" - Confirmado: - `open_finance` (object) - `open_finance.provider_request_id` (string,null) ID único para o pagamento, conforme enviado pelo provedor. Example: "978c0c97ea847e78e8849634473c1f1" - `open_finance.redirect_url` (string,null) A URL que redireciona o pagador para o site da sua instituição para autorizar o pagamento. Example: "https://wakandanational.com/" - `open_finance.end_to_end_id` (string,null) Um ID único para a transação no sistema de pagamento PIX do Brasil. Example: "F203262942022211117487a213b1d140" - `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" - `open_finance.pix_key_details` (object) Detalhes sobre a chave Pix utilizada para o pagamento. - `open_finance.pix_key_details.identifier` (string) O identificador mascarado do proprietário. Example: "23******00" - `open_finance.pix_key_details.name` (string) O nome do titular da chave Pix. Example: "João da Silva" - `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: same as `currency` in "Chave Pix" (1 values) - `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,null, required) ID único da Belvo usado para identificar a conta bancária do beneficiário. No caso de o beneficiário ser uma Chave Pix, este campo será null. - `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 Pix. - `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.pix_key` (string) A chave Pix associada ao beneficiário da transação. Pode ser um e-mail, número de telefone, CPF/CNPJ ou uma chave aleatória. Example: "a80d5a9d-20ae-479a-8dd7-ff3443bcbbfc" - `charges.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: same as `weekly.day_of_week` in "Semanalmente" (7 values) - `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)" - `charges.payment_method_information` (object, required) Informações sobre o método de pagamento Chave Pix após a intenção de pagamento ter sido confirmada via uma solicitação PATCH. - `charges.payment_method_information.open_finance` (object) - `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 pagador 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.payment_method_information.open_finance.pix_key_details` (object) Detalhes sobre a chave Pix utilizada para o pagamento. - `charges.payment_method_information.open_finance.pix_key_details.identifier` (string) O identificador mascarado do proprietário. Example: "23******00" - `charges.payment_method_information.open_finance.pix_key_details.name` (string) O nome do titular da chave Pix. Example: "João da Silva" - `charges.payer_information` (object) Informações sobre o ChargePayerInformation.yaml O arquivo ChargePayerInformation.yaml geralmente contém a definição de um esquema de dados que descreve as informações do pagador de uma cobrança. Este arquivo é usado em sistemas que lidam com transações financeiras para garantir que os dados do pagador sejam capturados e processados corretamente. Abaixo estão alguns elementos comuns que podem ser encontrados em um arquivo YAML desse tipo: 1. Estrutura de Dados: O arquivo define a estrutura dos dados do pagador, incluindo campos obrigatórios e opcionais. 2. Campos Comuns: - payerName: Nome completo do pagador. - payerAddress: Endereço do pagador, que pode incluir subcampos como street, city, state, e postalCode. - payerContact: Informações de contato, como email e phoneNumber. - payerID: Identificação única do pagador, que pode ser um número de documento ou um identificador interno. 3. Validações: O arquivo pode incluir regras de validação para garantir que os dados inseridos estejam no formato correto, como expressões regulares para validar e-mails ou números de telefone. 4. Exemplo de YAML: yaml ChargePayerInformation: payerName: "John Doe" payerAddress: street: "123 Main St" city: "Anytown" state: "Anystate" postalCode: "12345" payerContact: email: "johndoe@example.com" phoneNumber: "+1234567890" payerID: "ID123456789" 5. Uso em Aplicações: Este arquivo é utilizado por desenvolvedores para integrar e validar informações de pagadores em sistemas de pagamento, garantindo que todas as transações sejam associadas aos dados corretos do pagador. Essas informações são essenciais para garantir a conformidade com regulamentos financeiros e para facilitar a auditoria e o suporte ao cliente. - `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` (any) Para pagamentos com Chave Pix, este será um array vazio. Example: [] - `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: same as `charges.provider` in "Chave Pix" (1 values) - `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. - `error_code` (string, required) Um código de erro único (payment_error) que permite classificar e lidar com o erro de forma programática. Example: "payment_error" - `error_message` (string, required) Uma breve descrição do erro. Example: "Unexpected error to confirm the payment" - `next_step` (any, required) — one of: 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. - OFPI - Exibir Informações do Método de Pagamento: - `type` (string) O tipo de next_step que você precisa seguir. Enum: "open_finance_display_payment_method_information", "open_finance_display_confirmation_required", "open_finance_display_needs_redirect", "open_finance_display_payment_processing", "open_finance_display_payment_succeeded", "open_finance_display_payment_failed" - `open_finance_display_payment_method_information` (object) Objeto detalhando quais informações do método de pagamento você precisa exibir. - `open_finance_display_payment_method_information.institutions` (array) Um array de objetos institution. - `open_finance_display_payment_method_information.institutions.id` (string, required) Identificador único da Belvo para o item atual. Example: "0d3ffb69-f83b-456e-ad8e-208d0998d71d" - `open_finance_display_payment_method_information.institutions.active` (boolean, required) Indica se esta instituição está disponível para uso ou não. Example: true - `open_finance_display_payment_method_information.institutions.name` (string, required) O nome da instituição, conforme designado pela Belvo. Example: "wakanda_national" - `open_finance_display_payment_method_information.institutions.display_name` (string, required) O nome da instituição voltado para o cliente. Example: "Wakanda National Bank" - `open_finance_display_payment_method_information.institutions.legal_entity_name` (string,null, required) O nome da entidade legal da instituição, conforme registrado na autoridade reguladora relevante. Aplicável apenas para 🇧🇷 Brazil OFPI. Example: "Wakanda Bank, National Association" - `open_finance_display_payment_method_information.institutions.website` (string, required) A URL do site da instituição. Example: "https://www.wakandanational.com" - `open_finance_display_payment_method_information.institutions.logo` (string, required) A URL do logotipo da instituição. Example: "https://belvo-api-media.s3.amazonaws.com/logos/wakandanational_logo.svg" - `open_finance_display_payment_method_information.institutions.icon_logo` (string, required) A URL do logotipo do ícone da instituição. Example: "https://belvo-api-media.s3.amazonaws.com/logos/wakandanational_icon_logo.svg" - `open_finance_display_payment_method_information.institutions.text_logo` (string, required) A URL do logotipo de texto da instituição. Example: "https://belvo-api-media.s3.amazonaws.com/logos/wakandanational_text_logo.svg" - `open_finance_display_payment_method_information.institutions.primary_color` (string, required) A cor primária no site da instituição. Example: "#fdbc24" - `open_finance_display_payment_method_information.institutions.country` (string,null, required) O país de residência do cliente. - BRA (🇧🇷 Brasil) Enum: "BRA", "null" - `open_finance_display_payment_method_information.institutions.form_fields` (array, required) — one of: - InstitutionFormField: - `name` (string) O campo de nome de usuário, senha ou tipo de nome de usuário. Example: "username" - `type` (string) O tipo de entrada para o campo do formulário. Por exemplo, string. Example: "text" - `label` (string) O rótulo do campo do formulário. Por exemplo: - Document - Clave - Token Example: "Document" - `dependency` (string,null) Indica se este parâmetro depende ou não de outro parâmetro ser fornecido. Por exemplo, se este campo dependency = username_type, isso significa que você também deve enviar o parâmetro username_type. Example: "username_type" - `validation` (string) O tipo de validação de entrada usado para o campo. Example: "^.{1,}$" - `placeholder` (string) O texto do espaço reservado no campo do formulário. Example: "Username" - `validation_message` (string) A mensagem exibida quando uma entrada inválida é fornecida no campo do formulário. Example: "Invalid client number" - `values` (array) Array de valores adicionais de campos de formulário. - `values.code` (string) O código do documento. Example: "001" - `values.label` (string) O rótulo para o campo. Por exemplo: - Cédula de Ciudadanía - Cédula de Extranjería - Pasaporte Example: "Cédula de Ciudadanía" - `values.validation` (string) O tipo de validação de entrada usado para o campo. Example: "^.{1,}$" - `values.validation_message` (string) A mensagem exibida quando uma entrada inválida é fornecida no campo do formulário. Example: "Invalid document number" - `values.placeholder` (string) O texto do espaço reservado no campo do formulário. Example: "DEF4444908M22" - `length` (integer) Número de dígitos permitidos quando o tipo é token. Example: 6 - `optional` (boolean) Indica se este campo de formulário é opcional. - InstitutionFormFieldUsernameType: - `name` (string) O campo de nome de usuário, senha ou tipo de nome de usuário. Example: "username" - `type` (string) O tipo de entrada para o campo do formulário. Por exemplo, string. Example: "text" - `placeholder` (string) O texto do espaço reservado no campo do formulário. Example: "Username" - `values` (array) Array de valores adicionais de campos de formulário. - `values.code` (string) O código do documento. Example: "001" - `values.label` (string) O rótulo para o campo. Por exemplo: - Cédula de Ciudadanía - Cédula de Extranjería - Pasaporte Example: "Cédula de Ciudadanía" - `values.validation` (string) O tipo de validação de entrada usado para o campo. Example: "^.{1,}$" - `values.validation_message` (string) A mensagem exibida quando uma entrada inválida é fornecida no campo do formulário. Example: "Invalid document number" - `values.placeholder` (string) O texto do espaço reservado no campo do formulário. Example: "DEF4444908M22" - `preselected` (integer) Indique qual opção do array username_types é automaticamente pré-selecionada para o usuário. Example: 6 - InstitutionFormFieldSaveCredentials: - `name` (string) Se o usuário deseja ou não salvar as credenciais para esta instituição para pagamentos futuros. Example: "save_credentials" - `type` (string) O tipo de entrada para o campo do formulário. Para save_credentials, isso é definido como checkbox. Example: "checkbox" - `label` (string) O rótulo do campo do formulário. Para save_credentials, isso é definido como Recuérdame para futuros pagos`. Example: "Recuérdame para futuros pagos" - `validation` (string,null) O tipo de validação de entrada usado para o campo. Para save_credentials, isso é null. - `open_finance_display_payment_method_information.institutions.sort_priority` (integer, required) Número que representa a ordem em que a instituição deve ser exibida em um aplicativo, com 1 sendo o mais alto. Example: 1 - `open_finance_display_payment_method_information.institutions.description` (string,null, required) Uma breve descrição da instituição. Example: "Simple, transparent and secure: Wakanda Bank is the leading financial technology company in Latin America." - `ready_to_confirm` (boolean) Boolean que indica se a intenção de pagamento está pronta para ser confirmada. Nota: Quando definido como true, você precisa confirmar o pagamento fazendo uma solicitação PATCH enviando confirm: true. - OFPI - Necessita de Redirecionamento: - `type` (string) O tipo de next_step que você precisa seguir. Enum: same as `type` in "OFPI - Exibir Informações do Método de Pagamento" (6 values) - `open_finance_display_needs_redirect` (object) Detalhes sobre a instituição pagadora. - `open_finance_display_needs_redirect.payer_institution` (object) - `open_finance_display_needs_redirect.payer_institution.id` (string, required) Identificador único da Belvo para o item atual. Example: "0d3ffb69-f83b-456e-ad8e-208d0998d71d" - `open_finance_display_needs_redirect.payer_institution.active` (boolean, required) Indica se esta instituição está disponível para uso ou não. Example: true - `open_finance_display_needs_redirect.payer_institution.name` (string, required) O nome da instituição, conforme designado pela Belvo. Example: "wakanda_national" - `open_finance_display_needs_redirect.payer_institution.display_name` (string, required) O nome da instituição voltado para o cliente. Example: "Wakanda National Bank" - `open_finance_display_needs_redirect.payer_institution.legal_entity_name` (string,null, required) O nome da entidade legal da instituição, conforme registrado na autoridade reguladora relevante. Aplicável apenas para 🇧🇷 Brazil OFPI. Example: "Wakanda Bank, National Association" - `open_finance_display_needs_redirect.payer_institution.website` (string, required) A URL do site da instituição. Example: "https://www.wakandanational.com" - `open_finance_display_needs_redirect.payer_institution.logo` (string, required) A URL do logotipo da instituição. Example: "https://belvo-api-media.s3.amazonaws.com/logos/wakandanational_logo.svg" - `open_finance_display_needs_redirect.payer_institution.icon_logo` (string, required) A URL do logotipo do ícone da instituição. Example: "https://belvo-api-media.s3.amazonaws.com/logos/wakandanational_icon_logo.svg" - `open_finance_display_needs_redirect.payer_institution.text_logo` (string, required) A URL do logotipo de texto da instituição. Example: "https://belvo-api-media.s3.amazonaws.com/logos/wakandanational_text_logo.svg" - `open_finance_display_needs_redirect.payer_institution.primary_color` (string, required) A cor primária no site da instituição. Example: "#fdbc24" - `open_finance_display_needs_redirect.payer_institution.country` (string,null, required) O país de residência do cliente. - BRA (🇧🇷 Brasil) Enum: same as `open_finance_display_payment_method_information.institutions.country` in "OFPI - Exibir Informações do Método de Pagamento" (2 values) - `open_finance_display_needs_redirect.payer_institution.form_fields` (array, required) — one of: - InstitutionFormField: - `name` (string) O campo de nome de usuário, senha ou tipo de nome de usuário. Example: "username" - `type` (string) O tipo de entrada para o campo do formulário. Por exemplo, string. Example: "text" - `label` (string) O rótulo do campo do formulário. Por exemplo: - Document - Clave - Token Example: "Document" - `dependency` (string,null) Indica se este parâmetro depende ou não de outro parâmetro ser fornecido. Por exemplo, se este campo dependency = username_type, isso significa que você também deve enviar o parâmetro username_type. Example: "username_type" - `validation` (string) O tipo de validação de entrada usado para o campo. Example: "^.{1,}$" - `placeholder` (string) O texto do espaço reservado no campo do formulário. Example: "Username" - `validation_message` (string) A mensagem exibida quando uma entrada inválida é fornecida no campo do formulário. Example: "Invalid client number" - `values` (array) Array de valores adicionais de campos de formulário. - `values.code` (string) O código do documento. Example: "001" - `values.label` (string) O rótulo para o campo. Por exemplo: - Cédula de Ciudadanía - Cédula de Extranjería - Pasaporte Example: "Cédula de Ciudadanía" - `values.validation` (string) O tipo de validação de entrada usado para o campo. Example: "^.{1,}$" - `values.validation_message` (string) A mensagem exibida quando uma entrada inválida é fornecida no campo do formulário. Example: "Invalid document number" - `values.placeholder` (string) O texto do espaço reservado no campo do formulário. Example: "DEF4444908M22" - `length` (integer) Número de dígitos permitidos quando o tipo é token. Example: 6 - `optional` (boolean) Indica se este campo de formulário é opcional. - InstitutionFormFieldUsernameType: - `name` (string) O campo de nome de usuário, senha ou tipo de nome de usuário. Example: "username" - `type` (string) O tipo de entrada para o campo do formulário. Por exemplo, string. Example: "text" - `placeholder` (string) O texto do espaço reservado no campo do formulário. Example: "Username" - `values` (array) Array de valores adicionais de campos de formulário. - `values.code` (string) O código do documento. Example: "001" - `values.label` (string) O rótulo para o campo. Por exemplo: - Cédula de Ciudadanía - Cédula de Extranjería - Pasaporte Example: "Cédula de Ciudadanía" - `values.validation` (string) O tipo de validação de entrada usado para o campo. Example: "^.{1,}$" - `values.validation_message` (string) A mensagem exibida quando uma entrada inválida é fornecida no campo do formulário. Example: "Invalid document number" - `values.placeholder` (string) O texto do espaço reservado no campo do formulário. Example: "DEF4444908M22" - `preselected` (integer) Indique qual opção do array username_types é automaticamente pré-selecionada para o usuário. Example: 6 - InstitutionFormFieldSaveCredentials: - `name` (string) Se o usuário deseja ou não salvar as credenciais para esta instituição para pagamentos futuros. Example: "save_credentials" - `type` (string) O tipo de entrada para o campo do formulário. Para save_credentials, isso é definido como checkbox. Example: "checkbox" - `label` (string) O rótulo do campo do formulário. Para save_credentials, isso é definido como Recuérdame para futuros pagos`. Example: "Recuérdame para futuros pagos" - `validation` (string,null) O tipo de validação de entrada usado para o campo. Para save_credentials, isso é null. - `open_finance_display_needs_redirect.payer_institution.sort_priority` (integer, required) Número que representa a ordem em que a instituição deve ser exibida em um aplicativo, com 1 sendo o mais alto. Example: 1 - `open_finance_display_needs_redirect.payer_institution.description` (string,null, required) Uma breve descrição da instituição. Example: "Simple, transparent and secure: Wakanda Bank is the leading financial technology company in Latin America." - `ready_to_confirm` (boolean) Boolean que indica se a intenção de pagamento está pronta para ser confirmada. Nota: Quando definido como true, você precisa confirmar o pagamento fazendo uma solicitação PATCH enviando confirm: true. - OFPI - Exibição de Confirmação Necessária: - `type` (string) O tipo de next_step que você precisa seguir. Enum: same as `type` in "OFPI - Exibir Informações do Método de Pagamento" (6 values) - `open_finance_display_confirmation_required` (object) Objeto detalhando os próximos passos que você deve seguir para um tipo específico de next_step. - `open_finance_display_confirmation_required.beneficiary_bank_account` (object) - `open_finance_display_confirmation_required.beneficiary_bank_account.id` (string, required) Identificador único da Belvo para o item atual. Example: "0d3ffb69-f83b-456e-ad8e-208d0998d71d" - `open_finance_display_confirmation_required.beneficiary_bank_account.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" - `open_finance_display_confirmation_required.beneficiary_bank_account.created_by` (string, required) O ID único para o usuário que criou este item. Example: "bcef7f35-67f2-4b19-b009-cb38795faf09" - `open_finance_display_confirmation_required.beneficiary_bank_account.institution` (object, required) - `open_finance_display_confirmation_required.beneficiary_bank_account.institution.id` (string, required) Identificador único da Belvo para o item atual. Example: "0d3ffb69-f83b-456e-ad8e-208d0998d71d" - `open_finance_display_confirmation_required.beneficiary_bank_account.institution.active` (boolean, required) Indica se esta instituição está disponível para uso ou não. Example: true - `open_finance_display_confirmation_required.beneficiary_bank_account.institution.name` (string, required) O nome da instituição, conforme designado pela Belvo. Example: "wakanda_national" - `open_finance_display_confirmation_required.beneficiary_bank_account.institution.display_name` (string, required) O nome da instituição voltado para o cliente. Example: "Wakanda National Bank" - `open_finance_display_confirmation_required.beneficiary_bank_account.institution.legal_entity_name` (string,null, required) O nome da entidade legal da instituição, conforme registrado na autoridade reguladora relevante. Aplicável apenas para 🇧🇷 Brazil OFPI. Example: "Wakanda Bank, National Association" - `open_finance_display_confirmation_required.beneficiary_bank_account.institution.website` (string, required) A URL do site da instituição. Example: "https://www.wakandanational.com" - `open_finance_display_confirmation_required.beneficiary_bank_account.institution.logo` (string, required) A URL do logotipo da instituição. Example: "https://belvo-api-media.s3.amazonaws.com/logos/wakandanational_logo.svg" - `open_finance_display_confirmation_required.beneficiary_bank_account.institution.icon_logo` (string, required) A URL do logotipo do ícone da instituição. Example: "https://belvo-api-media.s3.amazonaws.com/logos/wakandanational_icon_logo.svg" - `open_finance_display_confirmation_required.beneficiary_bank_account.institution.text_logo` (string, required) A URL do logotipo de texto da instituição. Example: "https://belvo-api-media.s3.amazonaws.com/logos/wakandanational_text_logo.svg" - `open_finance_display_confirmation_required.beneficiary_bank_account.institution.primary_color` (string, required) A cor primária no site da instituição. Example: "#fdbc24" - `open_finance_display_confirmation_required.beneficiary_bank_account.institution.country` (string,null, required) O país de residência do cliente. - BRA (🇧🇷 Brasil) Enum: same as `open_finance_display_payment_method_information.institutions.country` in "OFPI - Exibir Informações do Método de Pagamento" (2 values) - `open_finance_display_confirmation_required.beneficiary_bank_account.institution.form_fields` (array, required) — one of: - InstitutionFormField: - `name` (string) O campo de nome de usuário, senha ou tipo de nome de usuário. Example: "username" - `type` (string) O tipo de entrada para o campo do formulário. Por exemplo, string. Example: "text" - `label` (string) O rótulo do campo do formulário. Por exemplo: - Document - Clave - Token Example: "Document" - `dependency` (string,null) Indica se este parâmetro depende ou não de outro parâmetro ser fornecido. Por exemplo, se este campo dependency = username_type, isso significa que você também deve enviar o parâmetro username_type. Example: "username_type" - `validation` (string) O tipo de validação de entrada usado para o campo. Example: "^.{1,}$" - `placeholder` (string) O texto do espaço reservado no campo do formulário. Example: "Username" - `validation_message` (string) A mensagem exibida quando uma entrada inválida é fornecida no campo do formulário. Example: "Invalid client number" - `values` (array) Array de valores adicionais de campos de formulário. - `values.code` (string) O código do documento. Example: "001" - `values.label` (string) O rótulo para o campo. Por exemplo: - Cédula de Ciudadanía - Cédula de Extranjería - Pasaporte Example: "Cédula de Ciudadanía" - `values.validation` (string) O tipo de validação de entrada usado para o campo. Example: "^.{1,}$" - `values.validation_message` (string) A mensagem exibida quando uma entrada inválida é fornecida no campo do formulário. Example: "Invalid document number" - `values.placeholder` (string) O texto do espaço reservado no campo do formulário. Example: "DEF4444908M22" - `length` (integer) Número de dígitos permitidos quando o tipo é token. Example: 6 - `optional` (boolean) Indica se este campo de formulário é opcional. - InstitutionFormFieldUsernameType: - `name` (string) O campo de nome de usuário, senha ou tipo de nome de usuário. Example: "username" - `type` (string) O tipo de entrada para o campo do formulário. Por exemplo, string. Example: "text" - `placeholder` (string) O texto do espaço reservado no campo do formulário. Example: "Username" - `values` (array) Array de valores adicionais de campos de formulário. - `values.code` (string) O código do documento. Example: "001" - `values.label` (string) O rótulo para o campo. Por exemplo: - Cédula de Ciudadanía - Cédula de Extranjería - Pasaporte Example: "Cédula de Ciudadanía" - `values.validation` (string) O tipo de validação de entrada usado para o campo. Example: "^.{1,}$" - `values.validation_message` (string) A mensagem exibida quando uma entrada inválida é fornecida no campo do formulário. Example: "Invalid document number" - `values.placeholder` (string) O texto do espaço reservado no campo do formulário. Example: "DEF4444908M22" - `preselected` (integer) Indique qual opção do array username_types é automaticamente pré-selecionada para o usuário. Example: 6 - InstitutionFormFieldSaveCredentials: - `name` (string) Se o usuário deseja ou não salvar as credenciais para esta instituição para pagamentos futuros. Example: "save_credentials" - `type` (string) O tipo de entrada para o campo do formulário. Para save_credentials, isso é definido como checkbox. Example: "checkbox" - `label` (string) O rótulo do campo do formulário. Para save_credentials, isso é definido como Recuérdame para futuros pagos`. Example: "Recuérdame para futuros pagos" - `validation` (string,null) O tipo de validação de entrada usado para o campo. Para save_credentials, isso é null. - `open_finance_display_confirmation_required.beneficiary_bank_account.institution.sort_priority` (integer, required) Número que representa a ordem em que a instituição deve ser exibida em um aplicativo, com 1 sendo o mais alto. Example: 1 - `open_finance_display_confirmation_required.beneficiary_bank_account.institution.description` (string,null, required) Uma breve descrição da instituição. Example: "Simple, transparent and secure: Wakanda Bank is the leading financial technology company in Latin America." - `open_finance_display_confirmation_required.beneficiary_bank_account.details` (any) — one of: - Informações da Conta PIX (OFPI): - `country` (string,null, required) O país de residência do cliente. - BRA (🇧🇷 Brasil) Enum: same as `open_finance_display_payment_method_information.institutions.country` in "OFPI - Exibir Informações do Método de Pagamento" (2 values) - `account_type` (string, required) O tipo de conta bancária. Pode ser: - CHECKINGS (também conhecida como Conta Corrente no Brasil) - SAVINGS (também conhecida como Conta Poupança no Brasil) - SALARY (também conhecida como Conta Salário no Brasil) - PAYMENTS (também conhecida como Conta de Pagamento Instantâneo ou Conta de Pagamento no Brasil) Enum: "CHECKINGS", "SAVINGS", "SALARY", "PAYMENTS" - `agency` (string, required) A agência (número da filial) da instituição onde a conta foi criada. Example: "0444" - `number` (string, required) O número da conta bancária. Example: "45722-0" - OFPI (Chaves PIX): - `country` (string,null, required) O país de residência do cliente. - BRA (🇧🇷 Brasil) Enum: same as `open_finance_display_payment_method_information.institutions.country` in "OFPI - Exibir Informações do Método de Pagamento" (2 values) - `pix_key` (string, required) O identificador da chave PIX da conta bancária. Example: "RANDOM://6c1c236c-a035-4b80-ab12-e38f88ce82ab" - `open_finance_display_confirmation_required.beneficiary_bank_account.holder` (object, required) Detalhes sobre o titular da conta bancária. - `open_finance_display_confirmation_required.beneficiary_bank_account.holder.type` (string, required) O tipo de conta bancária. Pode ser INDIVIDUAL ou BUSINESS. Enum: "INDIVIDUAL", "BUSINESS" - `open_finance_display_confirmation_required.beneficiary_bank_account.holder.information` (any, required) — one of: - NEGÓCIOS: - `name` (string, required) O primeiro nome do titular da conta bancária. Example: "Gustavo Veloso Entertainment Universe" - `identifier_type` (string, required) O tipo de documento de identificação do cliente. Para empresas no Brasil, isso deve ser definido como CNPJ. Enum: "CNPJ" - `identifier` (string, required) O número do documento CNPJ. Example: 191 - INDIVIDUAL: - `first_name` (string, required) O primeiro nome do titular da conta bancária. Example: "Dom" - `last_name` (string, required) O sobrenome do titular da conta bancária. Example: "Mesa" - `identifier_type` (string, required) O tipo de documento de identificação do cliente. Para indivíduos no Brasil, isso deve ser definido como CPF. Enum: "CPF" - `identifier` (string, required) O número do documento da identidade do cliente. Example: 191 - `open_finance_display_confirmation_required.payer_name` (string) O nome do pagador. Example: "Gustavo Veloso" - `open_finance_display_confirmation_required.payer_identifier` (string) O ID do pagador. Example: "LV890273900-23" - `open_finance_display_confirmation_required.payer_institution` (object) - `ready_to_confirm` (boolean) Boolean que indica se a intenção de pagamento está pronta para ser confirmada. Nota: Quando definido como true, você precisa confirmar o pagamento fazendo uma solicitação PATCH enviando confirm: true. Example: true - OFPI - Processamento de Pagamentos: - `type` (string) O tipo de next_step que você precisa seguir. Enum: same as `type` in "OFPI - Exibir Informações do Método de Pagamento" (6 values) - `open_finance_display_payment_processing` (object) Detalhes sobre a instituição pagadora. - `open_finance_display_payment_processing.payer_institution` (object) - `open_finance_display_payment_processing.payer_institution.id` (string, required) Identificador único da Belvo para o item atual. Example: "0d3ffb69-f83b-456e-ad8e-208d0998d71d" - `open_finance_display_payment_processing.payer_institution.active` (boolean, required) Indica se esta instituição está disponível para uso ou não. Example: true - `open_finance_display_payment_processing.payer_institution.name` (string, required) O nome da instituição, conforme designado pela Belvo. Example: "wakanda_national" - `open_finance_display_payment_processing.payer_institution.display_name` (string, required) O nome da instituição voltado para o cliente. Example: "Wakanda National Bank" - `open_finance_display_payment_processing.payer_institution.legal_entity_name` (string,null, required) O nome da entidade legal da instituição, conforme registrado na autoridade reguladora relevante. Aplicável apenas para 🇧🇷 Brazil OFPI. Example: "Wakanda Bank, National Association" - `open_finance_display_payment_processing.payer_institution.website` (string, required) A URL do site da instituição. Example: "https://www.wakandanational.com" - `open_finance_display_payment_processing.payer_institution.logo` (string, required) A URL do logotipo da instituição. Example: "https://belvo-api-media.s3.amazonaws.com/logos/wakandanational_logo.svg" - `open_finance_display_payment_processing.payer_institution.icon_logo` (string, required) A URL do logotipo do ícone da instituição. Example: "https://belvo-api-media.s3.amazonaws.com/logos/wakandanational_icon_logo.svg" - `open_finance_display_payment_processing.payer_institution.text_logo` (string, required) A URL do logotipo de texto da instituição. Example: "https://belvo-api-media.s3.amazonaws.com/logos/wakandanational_text_logo.svg" - `open_finance_display_payment_processing.payer_institution.primary_color` (string, required) A cor primária no site da instituição. Example: "#fdbc24" - `open_finance_display_payment_processing.payer_institution.country` (string,null, required) O país de residência do cliente. - BRA (🇧🇷 Brasil) Enum: same as `open_finance_display_payment_method_information.institutions.country` in "OFPI - Exibir Informações do Método de Pagamento" (2 values) - `open_finance_display_payment_processing.payer_institution.form_fields` (array, required) — one of: - InstitutionFormField: - `name` (string) O campo de nome de usuário, senha ou tipo de nome de usuário. Example: "username" - `type` (string) O tipo de entrada para o campo do formulário. Por exemplo, string. Example: "text" - `label` (string) O rótulo do campo do formulário. Por exemplo: - Document - Clave - Token Example: "Document" - `dependency` (string,null) Indica se este parâmetro depende ou não de outro parâmetro ser fornecido. Por exemplo, se este campo dependency = username_type, isso significa que você também deve enviar o parâmetro username_type. Example: "username_type" - `validation` (string) O tipo de validação de entrada usado para o campo. Example: "^.{1,}$" - `placeholder` (string) O texto do espaço reservado no campo do formulário. Example: "Username" - `validation_message` (string) A mensagem exibida quando uma entrada inválida é fornecida no campo do formulário. Example: "Invalid client number" - `values` (array) Array de valores adicionais de campos de formulário. - `values.code` (string) O código do documento. Example: "001" - `values.label` (string) O rótulo para o campo. Por exemplo: - Cédula de Ciudadanía - Cédula de Extranjería - Pasaporte Example: "Cédula de Ciudadanía" - `values.validation` (string) O tipo de validação de entrada usado para o campo. Example: "^.{1,}$" - `values.validation_message` (string) A mensagem exibida quando uma entrada inválida é fornecida no campo do formulário. Example: "Invalid document number" - `values.placeholder` (string) O texto do espaço reservado no campo do formulário. Example: "DEF4444908M22" - `length` (integer) Número de dígitos permitidos quando o tipo é token. Example: 6 - `optional` (boolean) Indica se este campo de formulário é opcional. - InstitutionFormFieldUsernameType: - `name` (string) O campo de nome de usuário, senha ou tipo de nome de usuário. Example: "username" - `type` (string) O tipo de entrada para o campo do formulário. Por exemplo, string. Example: "text" - `placeholder` (string) O texto do espaço reservado no campo do formulário. Example: "Username" - `values` (array) Array de valores adicionais de campos de formulário. - `values.code` (string) O código do documento. Example: "001" - `values.label` (string) O rótulo para o campo. Por exemplo: - Cédula de Ciudadanía - Cédula de Extranjería - Pasaporte Example: "Cédula de Ciudadanía" - `values.validation` (string) O tipo de validação de entrada usado para o campo. Example: "^.{1,}$" - `values.validation_message` (string) A mensagem exibida quando uma entrada inválida é fornecida no campo do formulário. Example: "Invalid document number" - `values.placeholder` (string) O texto do espaço reservado no campo do formulário. Example: "DEF4444908M22" - `preselected` (integer) Indique qual opção do array username_types é automaticamente pré-selecionada para o usuário. Example: 6 - InstitutionFormFieldSaveCredentials: - `name` (string) Se o usuário deseja ou não salvar as credenciais para esta instituição para pagamentos futuros. Example: "save_credentials" - `type` (string) O tipo de entrada para o campo do formulário. Para save_credentials, isso é definido como checkbox. Example: "checkbox" - `label` (string) O rótulo do campo do formulário. Para save_credentials, isso é definido como Recuérdame para futuros pagos`. Example: "Recuérdame para futuros pagos" - `validation` (string,null) O tipo de validação de entrada usado para o campo. Para save_credentials, isso é null. - `open_finance_display_payment_processing.payer_institution.sort_priority` (integer, required) Número que representa a ordem em que a instituição deve ser exibida em um aplicativo, com 1 sendo o mais alto. Example: 1 - `open_finance_display_payment_processing.payer_institution.description` (string,null, required) Uma breve descrição da instituição. Example: "Simple, transparent and secure: Wakanda Bank is the leading financial technology company in Latin America." - `ready_to_confirm` (boolean) Boolean que indica se a intenção de pagamento está pronta para ser confirmada. Nota: Quando definido como true, você precisa confirmar o pagamento fazendo uma solicitação PATCH enviando confirm: true. - OFPI - Pagamento Concluído com Sucesso: - `type` (string) O tipo de next_step que você precisa seguir. Enum: same as `type` in "OFPI - Exibir Informações do Método de Pagamento" (6 values) - `open_finance_display_payment_succeeded` (object) Detalhes sobre a instituição pagadora. - `open_finance_display_payment_succeeded.payer_institution` (object) - `open_finance_display_payment_succeeded.payer_institution.id` (string, required) Identificador único da Belvo para o item atual. Example: "0d3ffb69-f83b-456e-ad8e-208d0998d71d" - `open_finance_display_payment_succeeded.payer_institution.active` (boolean, required) Indica se esta instituição está disponível para uso ou não. Example: true - `open_finance_display_payment_succeeded.payer_institution.name` (string, required) O nome da instituição, conforme designado pela Belvo. Example: "wakanda_national" - `open_finance_display_payment_succeeded.payer_institution.display_name` (string, required) O nome da instituição voltado para o cliente. Example: "Wakanda National Bank" - `open_finance_display_payment_succeeded.payer_institution.legal_entity_name` (string,null, required) O nome da entidade legal da instituição, conforme registrado na autoridade reguladora relevante. Aplicável apenas para 🇧🇷 Brazil OFPI. Example: "Wakanda Bank, National Association" - `open_finance_display_payment_succeeded.payer_institution.website` (string, required) A URL do site da instituição. Example: "https://www.wakandanational.com" - `open_finance_display_payment_succeeded.payer_institution.logo` (string, required) A URL do logotipo da instituição. Example: "https://belvo-api-media.s3.amazonaws.com/logos/wakandanational_logo.svg" - `open_finance_display_payment_succeeded.payer_institution.icon_logo` (string, required) A URL do logotipo do ícone da instituição. Example: "https://belvo-api-media.s3.amazonaws.com/logos/wakandanational_icon_logo.svg" - `open_finance_display_payment_succeeded.payer_institution.text_logo` (string, required) A URL do logotipo de texto da instituição. Example: "https://belvo-api-media.s3.amazonaws.com/logos/wakandanational_text_logo.svg" - `open_finance_display_payment_succeeded.payer_institution.primary_color` (string, required) A cor primária no site da instituição. Example: "#fdbc24" - `open_finance_display_payment_succeeded.payer_institution.country` (string,null, required) O país de residência do cliente. - BRA (🇧🇷 Brasil) Enum: same as `open_finance_display_payment_method_information.institutions.country` in "OFPI - Exibir Informações do Método de Pagamento" (2 values) - `open_finance_display_payment_succeeded.payer_institution.form_fields` (array, required) — one of: - InstitutionFormField: - `name` (string) O campo de nome de usuário, senha ou tipo de nome de usuário. Example: "username" - `type` (string) O tipo de entrada para o campo do formulário. Por exemplo, string. Example: "text" - `label` (string) O rótulo do campo do formulário. Por exemplo: - Document - Clave - Token Example: "Document" - `dependency` (string,null) Indica se este parâmetro depende ou não de outro parâmetro ser fornecido. Por exemplo, se este campo dependency = username_type, isso significa que você também deve enviar o parâmetro username_type. Example: "username_type" - `validation` (string) O tipo de validação de entrada usado para o campo. Example: "^.{1,}$" - `placeholder` (string) O texto do espaço reservado no campo do formulário. Example: "Username" - `validation_message` (string) A mensagem exibida quando uma entrada inválida é fornecida no campo do formulário. Example: "Invalid client number" - `values` (array) Array de valores adicionais de campos de formulário. - `values.code` (string) O código do documento. Example: "001" - `values.label` (string) O rótulo para o campo. Por exemplo: - Cédula de Ciudadanía - Cédula de Extranjería - Pasaporte Example: "Cédula de Ciudadanía" - `values.validation` (string) O tipo de validação de entrada usado para o campo. Example: "^.{1,}$" - `values.validation_message` (string) A mensagem exibida quando uma entrada inválida é fornecida no campo do formulário. Example: "Invalid document number" - `values.placeholder` (string) O texto do espaço reservado no campo do formulário. Example: "DEF4444908M22" - `length` (integer) Número de dígitos permitidos quando o tipo é token. Example: 6 - `optional` (boolean) Indica se este campo de formulário é opcional. - InstitutionFormFieldUsernameType: - `name` (string) O campo de nome de usuário, senha ou tipo de nome de usuário. Example: "username" - `type` (string) O tipo de entrada para o campo do formulário. Por exemplo, string. Example: "text" - `placeholder` (string) O texto do espaço reservado no campo do formulário. Example: "Username" - `values` (array) Array de valores adicionais de campos de formulário. - `values.code` (string) O código do documento. Example: "001" - `values.label` (string) O rótulo para o campo. Por exemplo: - Cédula de Ciudadanía - Cédula de Extranjería - Pasaporte Example: "Cédula de Ciudadanía" - `values.validation` (string) O tipo de validação de entrada usado para o campo. Example: "^.{1,}$" - `values.validation_message` (string) A mensagem exibida quando uma entrada inválida é fornecida no campo do formulário. Example: "Invalid document number" - `values.placeholder` (string) O texto do espaço reservado no campo do formulário. Example: "DEF4444908M22" - `preselected` (integer) Indique qual opção do array username_types é automaticamente pré-selecionada para o usuário. Example: 6 - InstitutionFormFieldSaveCredentials: - `name` (string) Se o usuário deseja ou não salvar as credenciais para esta instituição para pagamentos futuros. Example: "save_credentials" - `type` (string) O tipo de entrada para o campo do formulário. Para save_credentials, isso é definido como checkbox. Example: "checkbox" - `label` (string) O rótulo do campo do formulário. Para save_credentials, isso é definido como Recuérdame para futuros pagos`. Example: "Recuérdame para futuros pagos" - `validation` (string,null) O tipo de validação de entrada usado para o campo. Para save_credentials, isso é null. - `open_finance_display_payment_succeeded.payer_institution.sort_priority` (integer, required) Número que representa a ordem em que a instituição deve ser exibida em um aplicativo, com 1 sendo o mais alto. Example: 1 - `open_finance_display_payment_succeeded.payer_institution.description` (string,null, required) Uma breve descrição da instituição. Example: "Simple, transparent and secure: Wakanda Bank is the leading financial technology company in Latin America." - `ready_to_confirm` (boolean) Boolean que indica se a intenção de pagamento está pronta para ser confirmada. Nota: Quando definido como true, você precisa confirmar o pagamento fazendo uma solicitação PATCH enviando confirm: true. - OFPI - Pagamento Falhou: - `type` (string) O tipo de next_step que você precisa seguir. Enum: same as `type` in "OFPI - Exibir Informações do Método de Pagamento" (6 values) - `open_finance_display_payment_failed` (object) Detalhes sobre a instituição pagadora. - `open_finance_display_payment_failed.payer_institution` (object) - `open_finance_display_payment_failed.payer_institution.id` (string, required) Identificador único da Belvo para o item atual. Example: "0d3ffb69-f83b-456e-ad8e-208d0998d71d" - `open_finance_display_payment_failed.payer_institution.active` (boolean, required) Indica se esta instituição está disponível para uso ou não. Example: true - `open_finance_display_payment_failed.payer_institution.name` (string, required) O nome da instituição, conforme designado pela Belvo. Example: "wakanda_national" - `open_finance_display_payment_failed.payer_institution.display_name` (string, required) O nome da instituição voltado para o cliente. Example: "Wakanda National Bank" - `open_finance_display_payment_failed.payer_institution.legal_entity_name` (string,null, required) O nome da entidade legal da instituição, conforme registrado na autoridade reguladora relevante. Aplicável apenas para 🇧🇷 Brazil OFPI. Example: "Wakanda Bank, National Association" - `open_finance_display_payment_failed.payer_institution.website` (string, required) A URL do site da instituição. Example: "https://www.wakandanational.com" - `open_finance_display_payment_failed.payer_institution.logo` (string, required) A URL do logotipo da instituição. Example: "https://belvo-api-media.s3.amazonaws.com/logos/wakandanational_logo.svg" - `open_finance_display_payment_failed.payer_institution.icon_logo` (string, required) A URL do logotipo do ícone da instituição. Example: "https://belvo-api-media.s3.amazonaws.com/logos/wakandanational_icon_logo.svg" - `open_finance_display_payment_failed.payer_institution.text_logo` (string, required) A URL do logotipo de texto da instituição. Example: "https://belvo-api-media.s3.amazonaws.com/logos/wakandanational_text_logo.svg" - `open_finance_display_payment_failed.payer_institution.primary_color` (string, required) A cor primária no site da instituição. Example: "#fdbc24" - `open_finance_display_payment_failed.payer_institution.country` (string,null, required) O país de residência do cliente. - BRA (🇧🇷 Brasil) Enum: same as `open_finance_display_payment_method_information.institutions.country` in "OFPI - Exibir Informações do Método de Pagamento" (2 values) - `open_finance_display_payment_failed.payer_institution.form_fields` (array, required) — one of: - InstitutionFormField: - `name` (string) O campo de nome de usuário, senha ou tipo de nome de usuário. Example: "username" - `type` (string) O tipo de entrada para o campo do formulário. Por exemplo, string. Example: "text" - `label` (string) O rótulo do campo do formulário. Por exemplo: - Document - Clave - Token Example: "Document" - `dependency` (string,null) Indica se este parâmetro depende ou não de outro parâmetro ser fornecido. Por exemplo, se este campo dependency = username_type, isso significa que você também deve enviar o parâmetro username_type. Example: "username_type" - `validation` (string) O tipo de validação de entrada usado para o campo. Example: "^.{1,}$" - `placeholder` (string) O texto do espaço reservado no campo do formulário. Example: "Username" - `validation_message` (string) A mensagem exibida quando uma entrada inválida é fornecida no campo do formulário. Example: "Invalid client number" - `values` (array) Array de valores adicionais de campos de formulário. - `values.code` (string) O código do documento. Example: "001" - `values.label` (string) O rótulo para o campo. Por exemplo: - Cédula de Ciudadanía - Cédula de Extranjería - Pasaporte Example: "Cédula de Ciudadanía" - `values.validation` (string) O tipo de validação de entrada usado para o campo. Example: "^.{1,}$" - `values.validation_message` (string) A mensagem exibida quando uma entrada inválida é fornecida no campo do formulário. Example: "Invalid document number" - `values.placeholder` (string) O texto do espaço reservado no campo do formulário. Example: "DEF4444908M22" - `length` (integer) Número de dígitos permitidos quando o tipo é token. Example: 6 - `optional` (boolean) Indica se este campo de formulário é opcional. - InstitutionFormFieldUsernameType: - `name` (string) O campo de nome de usuário, senha ou tipo de nome de usuário. Example: "username" - `type` (string) O tipo de entrada para o campo do formulário. Por exemplo, string. Example: "text" - `placeholder` (string) O texto do espaço reservado no campo do formulário. Example: "Username" - `values` (array) Array de valores adicionais de campos de formulário. - `values.code` (string) O código do documento. Example: "001" - `values.label` (string) O rótulo para o campo. Por exemplo: - Cédula de Ciudadanía - Cédula de Extranjería - Pasaporte Example: "Cédula de Ciudadanía" - `values.validation` (string) O tipo de validação de entrada usado para o campo. Example: "^.{1,}$" - `values.validation_message` (string) A mensagem exibida quando uma entrada inválida é fornecida no campo do formulário. Example: "Invalid document number" - `values.placeholder` (string) O texto do espaço reservado no campo do formulário. Example: "DEF4444908M22" - `preselected` (integer) Indique qual opção do array username_types é automaticamente pré-selecionada para o usuário. Example: 6 - InstitutionFormFieldSaveCredentials: - `name` (string) Se o usuário deseja ou não salvar as credenciais para esta instituição para pagamentos futuros. Example: "save_credentials" - `type` (string) O tipo de entrada para o campo do formulário. Para save_credentials, isso é definido como checkbox. Example: "checkbox" - `label` (string) O rótulo do campo do formulário. Para save_credentials, isso é definido como Recuérdame para futuros pagos`. Example: "Recuérdame para futuros pagos" - `validation` (string,null) O tipo de validação de entrada usado para o campo. Para save_credentials, isso é null. - `open_finance_display_payment_failed.payer_institution.sort_priority` (integer, required) Número que representa a ordem em que a instituição deve ser exibida em um aplicativo, com 1 sendo o mais alto. Example: 1 - `open_finance_display_payment_failed.payer_institution.description` (string,null, required) Uma breve descrição da instituição. Example: "Simple, transparent and secure: Wakanda Bank is the leading financial technology company in Latin America." - `ready_to_confirm` (boolean) Boolean que indica se a intenção de pagamento está pronta para ser confirmada. Nota: Quando definido como true, você precisa confirmar o pagamento fazendo uma solicitação PATCH enviando confirm: true. - Conta Bancária: - `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: same as `status` in "Chave Pix" (5 values) - `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: same as `currency` in "Chave Pix" (1 values) - `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: same as `selected_payment_method_type` in "Chave Pix" (2 values) - `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) — one of: Detalhes sobre o método de pagamento OFPI. - INDIVIDUAL: - `open_finance` (object, required) Tipo de método de pagamento selecionado. - `open_finance.beneficiary_bank_account` (string, required) ID único da Belvo usado para identificar a conta bancária do beneficiário. Example: "a80d5a9d-20ae-479a-8dd7-ff3443bcbbfc" - `open_finance.payer_institution` (string, required) ID único do Belvo para referenciar a instituição do pagador. Example: "600f1b4a-1ef9-4f89-b341-1a35f0c32cc0" - `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: same as `weekly.day_of_week` in "Semanalmente" (7 values) - `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)" - `open_finance.callback_url` (string, required) A URL de callback para a qual seu usuário será redirecionado após confirmar o pagamento em seu aplicativo bancário. Example: "https://www.acmecorp.com/checkout/3487321" - `open_finance.cpf` (string,null) O número de CPF do cliente. Fornecido quando disponível; este valor é ofuscado nas respostas. Example: "23******00" - NEGÓCIOS: - `open_finance` (object, required) Tipo de método de pagamento selecionado. - `open_finance.beneficiary_bank_account` (string, required) ID único da Belvo usado para identificar a conta bancária do beneficiário. Example: "a80d5a9d-20ae-479a-8dd7-ff3443bcbbfc" - `open_finance.payer_institution` (string, required) ID único do Belvo para referenciar a instituição do pagador. Example: "600f1b4a-1ef9-4f89-b341-1a35f0c32cc0" - `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: same as `weekly.day_of_week` in "Semanalmente" (7 values) - `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)" - `open_finance.callback_url` (string, required) A URL de callback para a qual seu usuário será redirecionado após confirmar o pagamento em seu aplicativo bancário. Example: "https://www.acmecorp.com/checkout/3487321" - `open_finance.cpf` (string,null, required) O número de CPF do cliente. Fornecido quando disponível; este valor é ofuscado nas respostas. Example: "23******00" - `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: same as `charges.status` in "Chave Pix" (6 values) - `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: same as `currency` in "Chave Pix" (1 values) - `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: same as `charges.payment_method_type` in "Chave Pix" (1 values) - `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) — 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: same as `weekly.day_of_week` in "Semanalmente" (7 values) - `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)" - `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.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: same as `currency` in "Chave Pix" (1 values) - `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: same as `charges.provider` in "Chave Pix" (1 values) - `provider` (string, required) Nota: Este campo foi descontinuado e será removido da API no futuro. O provedor usado para o link de pagamento. Enum: same as `charges.provider` in "Chave Pix" (1 values) - `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. - `error_code` (string, required) Um código de erro único (payment_error) que permite classificar e lidar com o erro de forma programática. Example: "payment_error" - `error_message` (string, required) Uma breve descrição do erro. Example: "Unexpected error to confirm the payment" - `next_step` (any, required) — one of: 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. - OFPI - Exibir Informações do Método de Pagamento: - `type` (string) O tipo de next_step que você precisa seguir. Enum: same as `type` in "OFPI - Exibir Informações do Método de Pagamento" (6 values) - `open_finance_display_payment_method_information` (object) Objeto detalhando quais informações do método de pagamento você precisa exibir. - `open_finance_display_payment_method_information.institutions` (array) Um array de objetos institution. - `open_finance_display_payment_method_information.institutions.id` (string, required) Identificador único da Belvo para o item atual. Example: "0d3ffb69-f83b-456e-ad8e-208d0998d71d" - `open_finance_display_payment_method_information.institutions.active` (boolean, required) Indica se esta instituição está disponível para uso ou não. Example: true - `open_finance_display_payment_method_information.institutions.name` (string, required) O nome da instituição, conforme designado pela Belvo. Example: "wakanda_national" - `open_finance_display_payment_method_information.institutions.display_name` (string, required) O nome da instituição voltado para o cliente. Example: "Wakanda National Bank" - `open_finance_display_payment_method_information.institutions.legal_entity_name` (string,null, required) O nome da entidade legal da instituição, conforme registrado na autoridade reguladora relevante. Aplicável apenas para 🇧🇷 Brazil OFPI. Example: "Wakanda Bank, National Association" - `open_finance_display_payment_method_information.institutions.website` (string, required) A URL do site da instituição. Example: "https://www.wakandanational.com" - `open_finance_display_payment_method_information.institutions.logo` (string, required) A URL do logotipo da instituição. Example: "https://belvo-api-media.s3.amazonaws.com/logos/wakandanational_logo.svg" - `open_finance_display_payment_method_information.institutions.icon_logo` (string, required) A URL do logotipo do ícone da instituição. Example: "https://belvo-api-media.s3.amazonaws.com/logos/wakandanational_icon_logo.svg" - `open_finance_display_payment_method_information.institutions.text_logo` (string, required) A URL do logotipo de texto da instituição. Example: "https://belvo-api-media.s3.amazonaws.com/logos/wakandanational_text_logo.svg" - `open_finance_display_payment_method_information.institutions.primary_color` (string, required) A cor primária no site da instituição. Example: "#fdbc24" - `open_finance_display_payment_method_information.institutions.country` (string,null, required) O país de residência do cliente. - BRA (🇧🇷 Brasil) Enum: same as `open_finance_display_payment_method_information.institutions.country` in "OFPI - Exibir Informações do Método de Pagamento" (2 values) - `open_finance_display_payment_method_information.institutions.form_fields` (array, required) — one of: - InstitutionFormField: - `name` (string) O campo de nome de usuário, senha ou tipo de nome de usuário. Example: "username" - `type` (string) O tipo de entrada para o campo do formulário. Por exemplo, string. Example: "text" - `label` (string) O rótulo do campo do formulário. Por exemplo: - Document - Clave - Token Example: "Document" - `dependency` (string,null) Indica se este parâmetro depende ou não de outro parâmetro ser fornecido. Por exemplo, se este campo dependency = username_type, isso significa que você também deve enviar o parâmetro username_type. Example: "username_type" - `validation` (string) O tipo de validação de entrada usado para o campo. Example: "^.{1,}$" - `placeholder` (string) O texto do espaço reservado no campo do formulário. Example: "Username" - `validation_message` (string) A mensagem exibida quando uma entrada inválida é fornecida no campo do formulário. Example: "Invalid client number" - `values` (array) Array de valores adicionais de campos de formulário. - `values.code` (string) O código do documento. Example: "001" - `values.label` (string) O rótulo para o campo. Por exemplo: - Cédula de Ciudadanía - Cédula de Extranjería - Pasaporte Example: "Cédula de Ciudadanía" - `values.validation` (string) O tipo de validação de entrada usado para o campo. Example: "^.{1,}$" - `values.validation_message` (string) A mensagem exibida quando uma entrada inválida é fornecida no campo do formulário. Example: "Invalid document number" - `values.placeholder` (string) O texto do espaço reservado no campo do formulário. Example: "DEF4444908M22" - `length` (integer) Número de dígitos permitidos quando o tipo é token. Example: 6 - `optional` (boolean) Indica se este campo de formulário é opcional. - InstitutionFormFieldUsernameType: - `name` (string) O campo de nome de usuário, senha ou tipo de nome de usuário. Example: "username" - `type` (string) O tipo de entrada para o campo do formulário. Por exemplo, string. Example: "text" - `placeholder` (string) O texto do espaço reservado no campo do formulário. Example: "Username" - `values` (array) Array de valores adicionais de campos de formulário. - `values.code` (string) O código do documento. Example: "001" - `values.label` (string) O rótulo para o campo. Por exemplo: - Cédula de Ciudadanía - Cédula de Extranjería - Pasaporte Example: "Cédula de Ciudadanía" - `values.validation` (string) O tipo de validação de entrada usado para o campo. Example: "^.{1,}$" - `values.validation_message` (string) A mensagem exibida quando uma entrada inválida é fornecida no campo do formulário. Example: "Invalid document number" - `values.placeholder` (string) O texto do espaço reservado no campo do formulário. Example: "DEF4444908M22" - `preselected` (integer) Indique qual opção do array username_types é automaticamente pré-selecionada para o usuário. Example: 6 - InstitutionFormFieldSaveCredentials: - `name` (string) Se o usuário deseja ou não salvar as credenciais para esta instituição para pagamentos futuros. Example: "save_credentials" - `type` (string) O tipo de entrada para o campo do formulário. Para save_credentials, isso é definido como checkbox. Example: "checkbox" - `label` (string) O rótulo do campo do formulário. Para save_credentials, isso é definido como Recuérdame para futuros pagos`. Example: "Recuérdame para futuros pagos" - `validation` (string,null) O tipo de validação de entrada usado para o campo. Para save_credentials, isso é null. - `open_finance_display_payment_method_information.institutions.sort_priority` (integer, required) Número que representa a ordem em que a instituição deve ser exibida em um aplicativo, com 1 sendo o mais alto. Example: 1 - `open_finance_display_payment_method_information.institutions.description` (string,null, required) Uma breve descrição da instituição. Example: "Simple, transparent and secure: Wakanda Bank is the leading financial technology company in Latin America." - `ready_to_confirm` (boolean) Boolean que indica se a intenção de pagamento está pronta para ser confirmada. Nota: Quando definido como true, você precisa confirmar o pagamento fazendo uma solicitação PATCH enviando confirm: true. - OFPI - Necessita de Redirecionamento: - `type` (string) O tipo de next_step que você precisa seguir. Enum: same as `type` in "OFPI - Exibir Informações do Método de Pagamento" (6 values) - `open_finance_display_needs_redirect` (object) Detalhes sobre a instituição pagadora. - `open_finance_display_needs_redirect.payer_institution` (object) - `open_finance_display_needs_redirect.payer_institution.id` (string, required) Identificador único da Belvo para o item atual. Example: "0d3ffb69-f83b-456e-ad8e-208d0998d71d" - `open_finance_display_needs_redirect.payer_institution.active` (boolean, required) Indica se esta instituição está disponível para uso ou não. Example: true - `open_finance_display_needs_redirect.payer_institution.name` (string, required) O nome da instituição, conforme designado pela Belvo. Example: "wakanda_national" - `open_finance_display_needs_redirect.payer_institution.display_name` (string, required) O nome da instituição voltado para o cliente. Example: "Wakanda National Bank" - `open_finance_display_needs_redirect.payer_institution.legal_entity_name` (string,null, required) O nome da entidade legal da instituição, conforme registrado na autoridade reguladora relevante. Aplicável apenas para 🇧🇷 Brazil OFPI. Example: "Wakanda Bank, National Association" - `open_finance_display_needs_redirect.payer_institution.website` (string, required) A URL do site da instituição. Example: "https://www.wakandanational.com" - `open_finance_display_needs_redirect.payer_institution.logo` (string, required) A URL do logotipo da instituição. Example: "https://belvo-api-media.s3.amazonaws.com/logos/wakandanational_logo.svg" - `open_finance_display_needs_redirect.payer_institution.icon_logo` (string, required) A URL do logotipo do ícone da instituição. Example: "https://belvo-api-media.s3.amazonaws.com/logos/wakandanational_icon_logo.svg" - `open_finance_display_needs_redirect.payer_institution.text_logo` (string, required) A URL do logotipo de texto da instituição. Example: "https://belvo-api-media.s3.amazonaws.com/logos/wakandanational_text_logo.svg" - `open_finance_display_needs_redirect.payer_institution.primary_color` (string, required) A cor primária no site da instituição. Example: "#fdbc24" - `open_finance_display_needs_redirect.payer_institution.country` (string,null, required) O país de residência do cliente. - BRA (🇧🇷 Brasil) Enum: same as `open_finance_display_payment_method_information.institutions.country` in "OFPI - Exibir Informações do Método de Pagamento" (2 values) - `open_finance_display_needs_redirect.payer_institution.form_fields` (array, required) — one of: - InstitutionFormField: - `name` (string) O campo de nome de usuário, senha ou tipo de nome de usuário. Example: "username" - `type` (string) O tipo de entrada para o campo do formulário. Por exemplo, string. Example: "text" - `label` (string) O rótulo do campo do formulário. Por exemplo: - Document - Clave - Token Example: "Document" - `dependency` (string,null) Indica se este parâmetro depende ou não de outro parâmetro ser fornecido. Por exemplo, se este campo dependency = username_type, isso significa que você também deve enviar o parâmetro username_type. Example: "username_type" - `validation` (string) O tipo de validação de entrada usado para o campo. Example: "^.{1,}$" - `placeholder` (string) O texto do espaço reservado no campo do formulário. Example: "Username" - `validation_message` (string) A mensagem exibida quando uma entrada inválida é fornecida no campo do formulário. Example: "Invalid client number" - `values` (array) Array de valores adicionais de campos de formulário. - `values.code` (string) O código do documento. Example: "001" - `values.label` (string) O rótulo para o campo. Por exemplo: - Cédula de Ciudadanía - Cédula de Extranjería - Pasaporte Example: "Cédula de Ciudadanía" - `values.validation` (string) O tipo de validação de entrada usado para o campo. Example: "^.{1,}$" - `values.validation_message` (string) A mensagem exibida quando uma entrada inválida é fornecida no campo do formulário. Example: "Invalid document number" - `values.placeholder` (string) O texto do espaço reservado no campo do formulário. Example: "DEF4444908M22" - `length` (integer) Número de dígitos permitidos quando o tipo é token. Example: 6 - `optional` (boolean) Indica se este campo de formulário é opcional. - InstitutionFormFieldUsernameType: - `name` (string) O campo de nome de usuário, senha ou tipo de nome de usuário. Example: "username" - `type` (string) O tipo de entrada para o campo do formulário. Por exemplo, string. Example: "text" - `placeholder` (string) O texto do espaço reservado no campo do formulário. Example: "Username" - `values` (array) Array de valores adicionais de campos de formulário. - `values.code` (string) O código do documento. Example: "001" - `values.label` (string) O rótulo para o campo. Por exemplo: - Cédula de Ciudadanía - Cédula de Extranjería - Pasaporte Example: "Cédula de Ciudadanía" - `values.validation` (string) O tipo de validação de entrada usado para o campo. Example: "^.{1,}$" - `values.validation_message` (string) A mensagem exibida quando uma entrada inválida é fornecida no campo do formulário. Example: "Invalid document number" - `values.placeholder` (string) O texto do espaço reservado no campo do formulário. Example: "DEF4444908M22" - `preselected` (integer) Indique qual opção do array username_types é automaticamente pré-selecionada para o usuário. Example: 6 - InstitutionFormFieldSaveCredentials: - `name` (string) Se o usuário deseja ou não salvar as credenciais para esta instituição para pagamentos futuros. Example: "save_credentials" - `type` (string) O tipo de entrada para o campo do formulário. Para save_credentials, isso é definido como checkbox. Example: "checkbox" - `label` (string) O rótulo do campo do formulário. Para save_credentials, isso é definido como Recuérdame para futuros pagos`. Example: "Recuérdame para futuros pagos" - `validation` (string,null) O tipo de validação de entrada usado para o campo. Para save_credentials, isso é null. - `open_finance_display_needs_redirect.payer_institution.sort_priority` (integer, required) Número que representa a ordem em que a instituição deve ser exibida em um aplicativo, com 1 sendo o mais alto. Example: 1 - `open_finance_display_needs_redirect.payer_institution.description` (string,null, required) Uma breve descrição da instituição. Example: "Simple, transparent and secure: Wakanda Bank is the leading financial technology company in Latin America." - `ready_to_confirm` (boolean) Boolean que indica se a intenção de pagamento está pronta para ser confirmada. Nota: Quando definido como true, você precisa confirmar o pagamento fazendo uma solicitação PATCH enviando confirm: true. - OFPI - Exibição de Confirmação Necessária: - `type` (string) O tipo de next_step que você precisa seguir. Enum: same as `type` in "OFPI - Exibir Informações do Método de Pagamento" (6 values) - `open_finance_display_confirmation_required` (object) Objeto detalhando os próximos passos que você deve seguir para um tipo específico de next_step. - `open_finance_display_confirmation_required.beneficiary_bank_account` (object) - `open_finance_display_confirmation_required.beneficiary_bank_account.id` (string, required) Identificador único da Belvo para o item atual. Example: "0d3ffb69-f83b-456e-ad8e-208d0998d71d" - `open_finance_display_confirmation_required.beneficiary_bank_account.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" - `open_finance_display_confirmation_required.beneficiary_bank_account.created_by` (string, required) O ID único para o usuário que criou este item. Example: "bcef7f35-67f2-4b19-b009-cb38795faf09" - `open_finance_display_confirmation_required.beneficiary_bank_account.institution` (object, required) - `open_finance_display_confirmation_required.beneficiary_bank_account.institution.id` (string, required) Identificador único da Belvo para o item atual. Example: "0d3ffb69-f83b-456e-ad8e-208d0998d71d" - `open_finance_display_confirmation_required.beneficiary_bank_account.institution.active` (boolean, required) Indica se esta instituição está disponível para uso ou não. Example: true - `open_finance_display_confirmation_required.beneficiary_bank_account.institution.name` (string, required) O nome da instituição, conforme designado pela Belvo. Example: "wakanda_national" - `open_finance_display_confirmation_required.beneficiary_bank_account.institution.display_name` (string, required) O nome da instituição voltado para o cliente. Example: "Wakanda National Bank" - `open_finance_display_confirmation_required.beneficiary_bank_account.institution.legal_entity_name` (string,null, required) O nome da entidade legal da instituição, conforme registrado na autoridade reguladora relevante. Aplicável apenas para 🇧🇷 Brazil OFPI. Example: "Wakanda Bank, National Association" - `open_finance_display_confirmation_required.beneficiary_bank_account.institution.website` (string, required) A URL do site da instituição. Example: "https://www.wakandanational.com" - `open_finance_display_confirmation_required.beneficiary_bank_account.institution.logo` (string, required) A URL do logotipo da instituição. Example: "https://belvo-api-media.s3.amazonaws.com/logos/wakandanational_logo.svg" - `open_finance_display_confirmation_required.beneficiary_bank_account.institution.icon_logo` (string, required) A URL do logotipo do ícone da instituição. Example: "https://belvo-api-media.s3.amazonaws.com/logos/wakandanational_icon_logo.svg" - `open_finance_display_confirmation_required.beneficiary_bank_account.institution.text_logo` (string, required) A URL do logotipo de texto da instituição. Example: "https://belvo-api-media.s3.amazonaws.com/logos/wakandanational_text_logo.svg" - `open_finance_display_confirmation_required.beneficiary_bank_account.institution.primary_color` (string, required) A cor primária no site da instituição. Example: "#fdbc24" - `open_finance_display_confirmation_required.beneficiary_bank_account.institution.country` (string,null, required) O país de residência do cliente. - BRA (🇧🇷 Brasil) Enum: same as `open_finance_display_payment_method_information.institutions.country` in "OFPI - Exibir Informações do Método de Pagamento" (2 values) - `open_finance_display_confirmation_required.beneficiary_bank_account.institution.form_fields` (array, required) — one of: - InstitutionFormField: - `name` (string) O campo de nome de usuário, senha ou tipo de nome de usuário. Example: "username" - `type` (string) O tipo de entrada para o campo do formulário. Por exemplo, string. Example: "text" - `label` (string) O rótulo do campo do formulário. Por exemplo: - Document - Clave - Token Example: "Document" - `dependency` (string,null) Indica se este parâmetro depende ou não de outro parâmetro ser fornecido. Por exemplo, se este campo dependency = username_type, isso significa que você também deve enviar o parâmetro username_type. Example: "username_type" - `validation` (string) O tipo de validação de entrada usado para o campo. Example: "^.{1,}$" - `placeholder` (string) O texto do espaço reservado no campo do formulário. Example: "Username" - `validation_message` (string) A mensagem exibida quando uma entrada inválida é fornecida no campo do formulário. Example: "Invalid client number" - `values` (array) Array de valores adicionais de campos de formulário. - `values.code` (string) O código do documento. Example: "001" - `values.label` (string) O rótulo para o campo. Por exemplo: - Cédula de Ciudadanía - Cédula de Extranjería - Pasaporte Example: "Cédula de Ciudadanía" - `values.validation` (string) O tipo de validação de entrada usado para o campo. Example: "^.{1,}$" - `values.validation_message` (string) A mensagem exibida quando uma entrada inválida é fornecida no campo do formulário. Example: "Invalid document number" - `values.placeholder` (string) O texto do espaço reservado no campo do formulário. Example: "DEF4444908M22" - `length` (integer) Número de dígitos permitidos quando o tipo é token. Example: 6 - `optional` (boolean) Indica se este campo de formulário é opcional. - InstitutionFormFieldUsernameType: - `name` (string) O campo de nome de usuário, senha ou tipo de nome de usuário. Example: "username" - `type` (string) O tipo de entrada para o campo do formulário. Por exemplo, string. Example: "text" - `placeholder` (string) O texto do espaço reservado no campo do formulário. Example: "Username" - `values` (array) Array de valores adicionais de campos de formulário. - `values.code` (string) O código do documento. Example: "001" - `values.label` (string) O rótulo para o campo. Por exemplo: - Cédula de Ciudadanía - Cédula de Extranjería - Pasaporte Example: "Cédula de Ciudadanía" - `values.validation` (string) O tipo de validação de entrada usado para o campo. Example: "^.{1,}$" - `values.validation_message` (string) A mensagem exibida quando uma entrada inválida é fornecida no campo do formulário. Example: "Invalid document number" - `values.placeholder` (string) O texto do espaço reservado no campo do formulário. Example: "DEF4444908M22" - `preselected` (integer) Indique qual opção do array username_types é automaticamente pré-selecionada para o usuário. Example: 6 - InstitutionFormFieldSaveCredentials: - `name` (string) Se o usuário deseja ou não salvar as credenciais para esta instituição para pagamentos futuros. Example: "save_credentials" - `type` (string) O tipo de entrada para o campo do formulário. Para save_credentials, isso é definido como checkbox. Example: "checkbox" - `label` (string) O rótulo do campo do formulário. Para save_credentials, isso é definido como Recuérdame para futuros pagos`. Example: "Recuérdame para futuros pagos" - `validation` (string,null) O tipo de validação de entrada usado para o campo. Para save_credentials, isso é null. - `open_finance_display_confirmation_required.beneficiary_bank_account.institution.sort_priority` (integer, required) Número que representa a ordem em que a instituição deve ser exibida em um aplicativo, com 1 sendo o mais alto. Example: 1 - `open_finance_display_confirmation_required.beneficiary_bank_account.institution.description` (string,null, required) Uma breve descrição da instituição. Example: "Simple, transparent and secure: Wakanda Bank is the leading financial technology company in Latin America." - `open_finance_display_confirmation_required.beneficiary_bank_account.details` (any) — one of: - Informações da Conta PIX (OFPI): - `country` (string,null, required) O país de residência do cliente. - BRA (🇧🇷 Brasil) Enum: same as `open_finance_display_payment_method_information.institutions.country` in "OFPI - Exibir Informações do Método de Pagamento" (2 values) - `account_type` (string, required) O tipo de conta bancária. Pode ser: - CHECKINGS (também conhecida como Conta Corrente no Brasil) - SAVINGS (também conhecida como Conta Poupança no Brasil) - SALARY (também conhecida como Conta Salário no Brasil) - PAYMENTS (também conhecida como Conta de Pagamento Instantâneo ou Conta de Pagamento no Brasil) Enum: same as `account_type` in "Informações da Conta PIX (OFPI)" (4 values) - `agency` (string, required) A agência (número da filial) da instituição onde a conta foi criada. Example: "0444" - `number` (string, required) O número da conta bancária. Example: "45722-0" - OFPI (Chaves PIX): - `country` (string,null, required) O país de residência do cliente. - BRA (🇧🇷 Brasil) Enum: same as `open_finance_display_payment_method_information.institutions.country` in "OFPI - Exibir Informações do Método de Pagamento" (2 values) - `pix_key` (string, required) O identificador da chave PIX da conta bancária. Example: "RANDOM://6c1c236c-a035-4b80-ab12-e38f88ce82ab" - `open_finance_display_confirmation_required.beneficiary_bank_account.holder` (object, required) Detalhes sobre o titular da conta bancária. - `open_finance_display_confirmation_required.beneficiary_bank_account.holder.type` (string, required) O tipo de conta bancária. Pode ser INDIVIDUAL ou BUSINESS. Enum: same as `open_finance_display_confirmation_required.beneficiary_bank_account.holder.type` in "OFPI - Exibição de Confirmação Necessária" (2 values) - `open_finance_display_confirmation_required.beneficiary_bank_account.holder.information` (any, required) — one of: - NEGÓCIOS: - `name` (string, required) O primeiro nome do titular da conta bancária. Example: "Gustavo Veloso Entertainment Universe" - `identifier_type` (string, required) O tipo de documento de identificação do cliente. Para empresas no Brasil, isso deve ser definido como CNPJ. Enum: same as `identifier_type` in "NEGÓCIOS" (1 values) - `identifier` (string, required) O número do documento CNPJ. Example: 191 - INDIVIDUAL: - `first_name` (string, required) O primeiro nome do titular da conta bancária. Example: "Dom" - `last_name` (string, required) O sobrenome do titular da conta bancária. Example: "Mesa" - `identifier_type` (string, required) O tipo de documento de identificação do cliente. Para indivíduos no Brasil, isso deve ser definido como CPF. Enum: same as `identifier_type` in "INDIVIDUAL" (1 values) - `identifier` (string, required) O número do documento da identidade do cliente. Example: 191 - `open_finance_display_confirmation_required.payer_name` (string) O nome do pagador. Example: "Gustavo Veloso" - `open_finance_display_confirmation_required.payer_identifier` (string) O ID do pagador. Example: "LV890273900-23" - `open_finance_display_confirmation_required.payer_institution` (object) - `ready_to_confirm` (boolean) Boolean que indica se a intenção de pagamento está pronta para ser confirmada. Nota: Quando definido como true, você precisa confirmar o pagamento fazendo uma solicitação PATCH enviando confirm: true. Example: true - OFPI - Processamento de Pagamentos: - `type` (string) O tipo de next_step que você precisa seguir. Enum: same as `type` in "OFPI - Exibir Informações do Método de Pagamento" (6 values) - `open_finance_display_payment_processing` (object) Detalhes sobre a instituição pagadora. - `open_finance_display_payment_processing.payer_institution` (object) - `open_finance_display_payment_processing.payer_institution.id` (string, required) Identificador único da Belvo para o item atual. Example: "0d3ffb69-f83b-456e-ad8e-208d0998d71d" - `open_finance_display_payment_processing.payer_institution.active` (boolean, required) Indica se esta instituição está disponível para uso ou não. Example: true - `open_finance_display_payment_processing.payer_institution.name` (string, required) O nome da instituição, conforme designado pela Belvo. Example: "wakanda_national" - `open_finance_display_payment_processing.payer_institution.display_name` (string, required) O nome da instituição voltado para o cliente. Example: "Wakanda National Bank" - `open_finance_display_payment_processing.payer_institution.legal_entity_name` (string,null, required) O nome da entidade legal da instituição, conforme registrado na autoridade reguladora relevante. Aplicável apenas para 🇧🇷 Brazil OFPI. Example: "Wakanda Bank, National Association" - `open_finance_display_payment_processing.payer_institution.website` (string, required) A URL do site da instituição. Example: "https://www.wakandanational.com" - `open_finance_display_payment_processing.payer_institution.logo` (string, required) A URL do logotipo da instituição. Example: "https://belvo-api-media.s3.amazonaws.com/logos/wakandanational_logo.svg" - `open_finance_display_payment_processing.payer_institution.icon_logo` (string, required) A URL do logotipo do ícone da instituição. Example: "https://belvo-api-media.s3.amazonaws.com/logos/wakandanational_icon_logo.svg" - `open_finance_display_payment_processing.payer_institution.text_logo` (string, required) A URL do logotipo de texto da instituição. Example: "https://belvo-api-media.s3.amazonaws.com/logos/wakandanational_text_logo.svg" - `open_finance_display_payment_processing.payer_institution.primary_color` (string, required) A cor primária no site da instituição. Example: "#fdbc24" - `open_finance_display_payment_processing.payer_institution.country` (string,null, required) O país de residência do cliente. - BRA (🇧🇷 Brasil) Enum: same as `open_finance_display_payment_method_information.institutions.country` in "OFPI - Exibir Informações do Método de Pagamento" (2 values) - `open_finance_display_payment_processing.payer_institution.form_fields` (array, required) — one of: - InstitutionFormField: - `name` (string) O campo de nome de usuário, senha ou tipo de nome de usuário. Example: "username" - `type` (string) O tipo de entrada para o campo do formulário. Por exemplo, string. Example: "text" - `label` (string) O rótulo do campo do formulário. Por exemplo: - Document - Clave - Token Example: "Document" - `dependency` (string,null) Indica se este parâmetro depende ou não de outro parâmetro ser fornecido. Por exemplo, se este campo dependency = username_type, isso significa que você também deve enviar o parâmetro username_type. Example: "username_type" - `validation` (string) O tipo de validação de entrada usado para o campo. Example: "^.{1,}$" - `placeholder` (string) O texto do espaço reservado no campo do formulário. Example: "Username" - `validation_message` (string) A mensagem exibida quando uma entrada inválida é fornecida no campo do formulário. Example: "Invalid client number" - `values` (array) Array de valores adicionais de campos de formulário. - `values.code` (string) O código do documento. Example: "001" - `values.label` (string) O rótulo para o campo. Por exemplo: - Cédula de Ciudadanía - Cédula de Extranjería - Pasaporte Example: "Cédula de Ciudadanía" - `values.validation` (string) O tipo de validação de entrada usado para o campo. Example: "^.{1,}$" - `values.validation_message` (string) A mensagem exibida quando uma entrada inválida é fornecida no campo do formulário. Example: "Invalid document number" - `values.placeholder` (string) O texto do espaço reservado no campo do formulário. Example: "DEF4444908M22" - `length` (integer) Número de dígitos permitidos quando o tipo é token. Example: 6 - `optional` (boolean) Indica se este campo de formulário é opcional. - InstitutionFormFieldUsernameType: - `name` (string) O campo de nome de usuário, senha ou tipo de nome de usuário. Example: "username" - `type` (string) O tipo de entrada para o campo do formulário. Por exemplo, string. Example: "text" - `placeholder` (string) O texto do espaço reservado no campo do formulário. Example: "Username" - `values` (array) Array de valores adicionais de campos de formulário. - `values.code` (string) O código do documento. Example: "001" - `values.label` (string) O rótulo para o campo. Por exemplo: - Cédula de Ciudadanía - Cédula de Extranjería - Pasaporte Example: "Cédula de Ciudadanía" - `values.validation` (string) O tipo de validação de entrada usado para o campo. Example: "^.{1,}$" - `values.validation_message` (string) A mensagem exibida quando uma entrada inválida é fornecida no campo do formulário. Example: "Invalid document number" - `values.placeholder` (string) O texto do espaço reservado no campo do formulário. Example: "DEF4444908M22" - `preselected` (integer) Indique qual opção do array username_types é automaticamente pré-selecionada para o usuário. Example: 6 - InstitutionFormFieldSaveCredentials: - `name` (string) Se o usuário deseja ou não salvar as credenciais para esta instituição para pagamentos futuros. Example: "save_credentials" - `type` (string) O tipo de entrada para o campo do formulário. Para save_credentials, isso é definido como checkbox. Example: "checkbox" - `label` (string) O rótulo do campo do formulário. Para save_credentials, isso é definido como Recuérdame para futuros pagos`. Example: "Recuérdame para futuros pagos" - `validation` (string,null) O tipo de validação de entrada usado para o campo. Para save_credentials, isso é null. - `open_finance_display_payment_processing.payer_institution.sort_priority` (integer, required) Número que representa a ordem em que a instituição deve ser exibida em um aplicativo, com 1 sendo o mais alto. Example: 1 - `open_finance_display_payment_processing.payer_institution.description` (string,null, required) Uma breve descrição da instituição. Example: "Simple, transparent and secure: Wakanda Bank is the leading financial technology company in Latin America." - `ready_to_confirm` (boolean) Boolean que indica se a intenção de pagamento está pronta para ser confirmada. Nota: Quando definido como true, você precisa confirmar o pagamento fazendo uma solicitação PATCH enviando confirm: true. - OFPI - Pagamento Concluído com Sucesso: - `type` (string) O tipo de next_step que você precisa seguir. Enum: same as `type` in "OFPI - Exibir Informações do Método de Pagamento" (6 values) - `open_finance_display_payment_succeeded` (object) Detalhes sobre a instituição pagadora. - `open_finance_display_payment_succeeded.payer_institution` (object) - `open_finance_display_payment_succeeded.payer_institution.id` (string, required) Identificador único da Belvo para o item atual. Example: "0d3ffb69-f83b-456e-ad8e-208d0998d71d" - `open_finance_display_payment_succeeded.payer_institution.active` (boolean, required) Indica se esta instituição está disponível para uso ou não. Example: true - `open_finance_display_payment_succeeded.payer_institution.name` (string, required) O nome da instituição, conforme designado pela Belvo. Example: "wakanda_national" - `open_finance_display_payment_succeeded.payer_institution.display_name` (string, required) O nome da instituição voltado para o cliente. Example: "Wakanda National Bank" - `open_finance_display_payment_succeeded.payer_institution.legal_entity_name` (string,null, required) O nome da entidade legal da instituição, conforme registrado na autoridade reguladora relevante. Aplicável apenas para 🇧🇷 Brazil OFPI. Example: "Wakanda Bank, National Association" - `open_finance_display_payment_succeeded.payer_institution.website` (string, required) A URL do site da instituição. Example: "https://www.wakandanational.com" - `open_finance_display_payment_succeeded.payer_institution.logo` (string, required) A URL do logotipo da instituição. Example: "https://belvo-api-media.s3.amazonaws.com/logos/wakandanational_logo.svg" - `open_finance_display_payment_succeeded.payer_institution.icon_logo` (string, required) A URL do logotipo do ícone da instituição. Example: "https://belvo-api-media.s3.amazonaws.com/logos/wakandanational_icon_logo.svg" - `open_finance_display_payment_succeeded.payer_institution.text_logo` (string, required) A URL do logotipo de texto da instituição. Example: "https://belvo-api-media.s3.amazonaws.com/logos/wakandanational_text_logo.svg" - `open_finance_display_payment_succeeded.payer_institution.primary_color` (string, required) A cor primária no site da instituição. Example: "#fdbc24" - `open_finance_display_payment_succeeded.payer_institution.country` (string,null, required) O país de residência do cliente. - BRA (🇧🇷 Brasil) Enum: same as `open_finance_display_payment_method_information.institutions.country` in "OFPI - Exibir Informações do Método de Pagamento" (2 values) - `open_finance_display_payment_succeeded.payer_institution.form_fields` (array, required) — one of: - InstitutionFormField: - `name` (string) O campo de nome de usuário, senha ou tipo de nome de usuário. Example: "username" - `type` (string) O tipo de entrada para o campo do formulário. Por exemplo, string. Example: "text" - `label` (string) O rótulo do campo do formulário. Por exemplo: - Document - Clave - Token Example: "Document" - `dependency` (string,null) Indica se este parâmetro depende ou não de outro parâmetro ser fornecido. Por exemplo, se este campo dependency = username_type, isso significa que você também deve enviar o parâmetro username_type. Example: "username_type" - `validation` (string) O tipo de validação de entrada usado para o campo. Example: "^.{1,}$" - `placeholder` (string) O texto do espaço reservado no campo do formulário. Example: "Username" - `validation_message` (string) A mensagem exibida quando uma entrada inválida é fornecida no campo do formulário. Example: "Invalid client number" - `values` (array) Array de valores adicionais de campos de formulário. - `values.code` (string) O código do documento. Example: "001" - `values.label` (string) O rótulo para o campo. Por exemplo: - Cédula de Ciudadanía - Cédula de Extranjería - Pasaporte Example: "Cédula de Ciudadanía" - `values.validation` (string) O tipo de validação de entrada usado para o campo. Example: "^.{1,}$" - `values.validation_message` (string) A mensagem exibida quando uma entrada inválida é fornecida no campo do formulário. Example: "Invalid document number" - `values.placeholder` (string) O texto do espaço reservado no campo do formulário. Example: "DEF4444908M22" - `length` (integer) Número de dígitos permitidos quando o tipo é token. Example: 6 - `optional` (boolean) Indica se este campo de formulário é opcional. - InstitutionFormFieldUsernameType: - `name` (string) O campo de nome de usuário, senha ou tipo de nome de usuário. Example: "username" - `type` (string) O tipo de entrada para o campo do formulário. Por exemplo, string. Example: "text" - `placeholder` (string) O texto do espaço reservado no campo do formulário. Example: "Username" - `values` (array) Array de valores adicionais de campos de formulário. - `values.code` (string) O código do documento. Example: "001" - `values.label` (string) O rótulo para o campo. Por exemplo: - Cédula de Ciudadanía - Cédula de Extranjería - Pasaporte Example: "Cédula de Ciudadanía" - `values.validation` (string) O tipo de validação de entrada usado para o campo. Example: "^.{1,}$" - `values.validation_message` (string) A mensagem exibida quando uma entrada inválida é fornecida no campo do formulário. Example: "Invalid document number" - `values.placeholder` (string) O texto do espaço reservado no campo do formulário. Example: "DEF4444908M22" - `preselected` (integer) Indique qual opção do array username_types é automaticamente pré-selecionada para o usuário. Example: 6 - InstitutionFormFieldSaveCredentials: - `name` (string) Se o usuário deseja ou não salvar as credenciais para esta instituição para pagamentos futuros. Example: "save_credentials" - `type` (string) O tipo de entrada para o campo do formulário. Para save_credentials, isso é definido como checkbox. Example: "checkbox" - `label` (string) O rótulo do campo do formulário. Para save_credentials, isso é definido como Recuérdame para futuros pagos`. Example: "Recuérdame para futuros pagos" - `validation` (string,null) O tipo de validação de entrada usado para o campo. Para save_credentials, isso é null. - `open_finance_display_payment_succeeded.payer_institution.sort_priority` (integer, required) Número que representa a ordem em que a instituição deve ser exibida em um aplicativo, com 1 sendo o mais alto. Example: 1 - `open_finance_display_payment_succeeded.payer_institution.description` (string,null, required) Uma breve descrição da instituição. Example: "Simple, transparent and secure: Wakanda Bank is the leading financial technology company in Latin America." - `ready_to_confirm` (boolean) Boolean que indica se a intenção de pagamento está pronta para ser confirmada. Nota: Quando definido como true, você precisa confirmar o pagamento fazendo uma solicitação PATCH enviando confirm: true. - OFPI - Pagamento Falhou: - `type` (string) O tipo de next_step que você precisa seguir. Enum: same as `type` in "OFPI - Exibir Informações do Método de Pagamento" (6 values) - `open_finance_display_payment_failed` (object) Detalhes sobre a instituição pagadora. - `open_finance_display_payment_failed.payer_institution` (object) - `open_finance_display_payment_failed.payer_institution.id` (string, required) Identificador único da Belvo para o item atual. Example: "0d3ffb69-f83b-456e-ad8e-208d0998d71d" - `open_finance_display_payment_failed.payer_institution.active` (boolean, required) Indica se esta instituição está disponível para uso ou não. Example: true - `open_finance_display_payment_failed.payer_institution.name` (string, required) O nome da instituição, conforme designado pela Belvo. Example: "wakanda_national" - `open_finance_display_payment_failed.payer_institution.display_name` (string, required) O nome da instituição voltado para o cliente. Example: "Wakanda National Bank" - `open_finance_display_payment_failed.payer_institution.legal_entity_name` (string,null, required) O nome da entidade legal da instituição, conforme registrado na autoridade reguladora relevante. Aplicável apenas para 🇧🇷 Brazil OFPI. Example: "Wakanda Bank, National Association" - `open_finance_display_payment_failed.payer_institution.website` (string, required) A URL do site da instituição. Example: "https://www.wakandanational.com" - `open_finance_display_payment_failed.payer_institution.logo` (string, required) A URL do logotipo da instituição. Example: "https://belvo-api-media.s3.amazonaws.com/logos/wakandanational_logo.svg" - `open_finance_display_payment_failed.payer_institution.icon_logo` (string, required) A URL do logotipo do ícone da instituição. Example: "https://belvo-api-media.s3.amazonaws.com/logos/wakandanational_icon_logo.svg" - `open_finance_display_payment_failed.payer_institution.text_logo` (string, required) A URL do logotipo de texto da instituição. Example: "https://belvo-api-media.s3.amazonaws.com/logos/wakandanational_text_logo.svg" - `open_finance_display_payment_failed.payer_institution.primary_color` (string, required) A cor primária no site da instituição. Example: "#fdbc24" - `open_finance_display_payment_failed.payer_institution.country` (string,null, required) O país de residência do cliente. - BRA (🇧🇷 Brasil) Enum: same as `open_finance_display_payment_method_information.institutions.country` in "OFPI - Exibir Informações do Método de Pagamento" (2 values) - `open_finance_display_payment_failed.payer_institution.form_fields` (array, required) — one of: - InstitutionFormField: - `name` (string) O campo de nome de usuário, senha ou tipo de nome de usuário. Example: "username" - `type` (string) O tipo de entrada para o campo do formulário. Por exemplo, string. Example: "text" - `label` (string) O rótulo do campo do formulário. Por exemplo: - Document - Clave - Token Example: "Document" - `dependency` (string,null) Indica se este parâmetro depende ou não de outro parâmetro ser fornecido. Por exemplo, se este campo dependency = username_type, isso significa que você também deve enviar o parâmetro username_type. Example: "username_type" - `validation` (string) O tipo de validação de entrada usado para o campo. Example: "^.{1,}$" - `placeholder` (string) O texto do espaço reservado no campo do formulário. Example: "Username" - `validation_message` (string) A mensagem exibida quando uma entrada inválida é fornecida no campo do formulário. Example: "Invalid client number" - `values` (array) Array de valores adicionais de campos de formulário. - `values.code` (string) O código do documento. Example: "001" - `values.label` (string) O rótulo para o campo. Por exemplo: - Cédula de Ciudadanía - Cédula de Extranjería - Pasaporte Example: "Cédula de Ciudadanía" - `values.validation` (string) O tipo de validação de entrada usado para o campo. Example: "^.{1,}$" - `values.validation_message` (string) A mensagem exibida quando uma entrada inválida é fornecida no campo do formulário. Example: "Invalid document number" - `values.placeholder` (string) O texto do espaço reservado no campo do formulário. Example: "DEF4444908M22" - `length` (integer) Número de dígitos permitidos quando o tipo é token. Example: 6 - `optional` (boolean) Indica se este campo de formulário é opcional. - InstitutionFormFieldUsernameType: - `name` (string) O campo de nome de usuário, senha ou tipo de nome de usuário. Example: "username" - `type` (string) O tipo de entrada para o campo do formulário. Por exemplo, string. Example: "text" - `placeholder` (string) O texto do espaço reservado no campo do formulário. Example: "Username" - `values` (array) Array de valores adicionais de campos de formulário. - `values.code` (string) O código do documento. Example: "001" - `values.label` (string) O rótulo para o campo. Por exemplo: - Cédula de Ciudadanía - Cédula de Extranjería - Pasaporte Example: "Cédula de Ciudadanía" - `values.validation` (string) O tipo de validação de entrada usado para o campo. Example: "^.{1,}$" - `values.validation_message` (string) A mensagem exibida quando uma entrada inválida é fornecida no campo do formulário. Example: "Invalid document number" - `values.placeholder` (string) O texto do espaço reservado no campo do formulário. Example: "DEF4444908M22" - `preselected` (integer) Indique qual opção do array username_types é automaticamente pré-selecionada para o usuário. Example: 6 - InstitutionFormFieldSaveCredentials: - `name` (string) Se o usuário deseja ou não salvar as credenciais para esta instituição para pagamentos futuros. Example: "save_credentials" - `type` (string) O tipo de entrada para o campo do formulário. Para save_credentials, isso é definido como checkbox. Example: "checkbox" - `label` (string) O rótulo do campo do formulário. Para save_credentials, isso é definido como Recuérdame para futuros pagos`. Example: "Recuérdame para futuros pagos" - `validation` (string,null) O tipo de validação de entrada usado para o campo. Para save_credentials, isso é null. - `open_finance_display_payment_failed.payer_institution.sort_priority` (integer, required) Número que representa a ordem em que a instituição deve ser exibida em um aplicativo, com 1 sendo o mais alto. Example: 1 - `open_finance_display_payment_failed.payer_institution.description` (string,null, required) Uma breve descrição da instituição. Example: "Simple, transparent and secure: Wakanda Bank is the leading financial technology company in Latin America." - `ready_to_confirm` (boolean) Boolean que indica se a intenção de pagamento está pronta para ser confirmada. Nota: Quando definido como true, você precisa confirmar o pagamento fazendo uma solicitação PATCH enviando confirm: true. ## Response 400 fields (application/json): - `code` (string, required) Um código de erro único (null, does_not_exist, required, already_registered, invalid_choice, max_length, min_length, blank, null, cancellation_error, idempotency_key_invalid) que permite classificar e tratar o erro de forma programática. Example: "required" - `message` (string, required) Uma breve descrição do erro. A descrição pode ser (entre outras): - Este campo é obrigatório. - Objeto com nome=narnia não existe. - Este campo não pode ser nulo. - Este campo não pode estar em branco. - Este cliente já está registrado. - Certifique-se de que este campo tenha pelo menos 2 caracteres. - Certifique-se de que este campo não tenha mais de 4 caracteres. - O valor inserido não é válido. - Você deve definir todos os campos obrigatórios: username, password, username_type. - Payment Intent não pode ser cancelado porque não está SCHEDULED. - Payment Intent não pode ser cancelado pois o horário limite (23:59:00) já passou. - A chave de idempotência fornecida é inválida. Example: "This field is required." - `request_id` (string, required) 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" - `field` (string,null) Nome do campo onde o erro foi encontrado. > Nota: Este campo só está presente quando o erro está relacionado a um campo específico. Example: "institution" ## 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"