bb_payments 0.1.1

data/docs/RootTypeForBatchTransferGETResponseObject.md

@@ -0,0 +1,9 @@
+# BancoBrasilPayments::RootTypeForBatchTransferGETResponseObject
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**index** | **Integer** | Posição do índice. Cada resposta tem um limite de 300 ocorrências na lista paymentsList, iniciada a partir do valor do índice fornecido. Para todas as ocorrências, itere sobre esse recurso usando o valor do campo nextIndex da resposta. | [optional] 
+**payments_quantity** | **Integer** | Quantidade de pagamentos | [optional] 
+**payments_list** | [**Array<RootTypeForBatchTransferPaymentsListGET>**](RootTypeForBatchTransferPaymentsListGET.md) | List of payments to be processed in batch. Not allowed more than 500 records.  pt-BR: Lista de pagamentos a serem processados em lote. Não permitido mais de 500 registros. | [optional] 
+

data/docs/RootTypeForBatchTransferPaymentsListGET.md

@@ -0,0 +1,21 @@
+# BancoBrasilPayments::RootTypeForBatchTransferPaymentsListGET
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**sequential_request_id** | **Integer** | ID sequencial da requisição | [optional] 
+**request_payment_message** | **String** | Texto de uso livre do cliente. | [optional] 
+**request_status** | **Integer** | Código do estado da requisição a ser pesquisada: 1 - Requisição com todos os lançamentos com dados consistentes;  2 - Requisição com ao menos um dos lançamentos com dados inconsistentes; 3 - Requisição com todos os lançamentos com dados inconsistentes;  4 - Requisição pendente de ação pelo Conveniado - falta autorizar o pagamento;  5 - Requisição em processamento pelo Banco;  6 - Requisição Processada;  7 - Requisição Rejeitada,  8 - Preparando remessa não liberada,  9 - Requisição liberada via API,  10 -  Preparando remessa liberada.   As situações 1, 2 e 8 são transitórias e não requerem qualquer ação do Cliente Conveniado. situação 3 sempre será migrada para situação 7.  A situação 4 Significa que, ao menos um lançamento, depende de ação do Cliente Conveniado, seja liberando ou cancelando os pagamentos.  As situações 5, 6, 7, 9 e 10 não requerem qualquer ação do Cliente Conveniado. A situação 5 significa que, ao menos um lançamento, está agendado.  As situações 6 e 7 são definitivas não havendo alteração posterior da situação da requisição.  | [optional] 
+**debit_branch_office** | **Integer** | Código da agência para débito. | [optional] 
+**debit_current_account** | **Integer** | Conta corrente de débito.  | [optional] 
+**check_digits_debit_current_account** | **String** | Dígito do verificador da conta corrente para débito. | [optional] 
+**request_date** | **Integer** | Data em que o cliente enviou ao banco a requisição de pagamento (formato ddmmaaaa). Solicitações de pagamentos para dias não úteis ou após o horário limite de processamento serão pagas no próximo dia útil, com exceção de transferências entre contas do Banco do Brasil | [optional] 
+**request_sent_hour** | **Integer** | Hora do envio da requisição do envio do lote | [optional] 
+**payment_type** | **Integer** | Modalidade que representa o tipo de pagamento, sendo: 126 pagamento de fornecedores; 127 pagamento de salário e 128 pagamentos diversos | [optional] 
+**user_id** | **String** | Identificação do usuário que enviou a requisição | [optional] 
+**user_name** | **String** | Nome do responsável pelo envio do lote. (para casos de login e explícito) | [optional] 
+**bankpayment_quantity** | **Integer** | Quantidade total de boletos | [optional] 
+**bankpayment_amount** | **Float** | Valor do pagamento em reais (formato 0.00) | [optional] 
+**valid_bankpayment_quantity** | **Integer** | Quantidade total de todos os pagamentos pretendidos válidos a serem processados em lote | [optional] 
+**valid_bankpayment_amount** | **Float** | Valor total de todos os pagamentos pretendidos válidos a serem processados em lote (formato 0.00) | [optional] 
+

data/docs/RootTypeForBatchTransfersCancelPaymentsListObject.md

@@ -0,0 +1,10 @@
+# BancoBrasilPayments::RootTypeForBatchTransfersCancelPaymentsListObject
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**payment_id** | **String** | Identificação do pagamento. Representa o número do protocolo por meio do qual o beneficiário pode verificar a situação do crédito, se necessário. | [optional] 
+**cancel_indicator** | **String** | Indica se o pagamento foi cancelado ou não | [optional] 
+**payment_status** | **String** | Descrição da situação do pagamento: Domínios: - Consistente (pagamento recebido pelo banco, cumprem as regras de preenchimento dos campos mas ainda irá para validação e processamento) - Inconsistente (pagamento não aceito pelo banco por dados de entrada inconsistentes - não cumpre as regras de preenchimento dos campos) - Pago (pagamento efetuado ao favorecido) - Pendente (pagamento validado - pendência de autorização do pagamento por parte do pagador) - Aguardando saldo (débito não efetivado e em verificação de saldo até o horário limite da teimosinha). - Agendado (pagamento autorizado, porém aguardando a data de efetivação do pagamento ou horário de processamento) - Rejeitado (dados do pagamento não passaram na validações físicas e/ou lógicas, precisam ser corrigidos e reenviados. Ex: agência e conta não existem, conta não pertence ao CPF informado) - Cancelado (pagamento cancelado pelo pagador antes da data de efetivação do crédito) - Bloqueado (Débito na conta do pagador não efetivado por ocorrência no convênio, inconsistência de data/float ou falta de saldo) - Devolvido (pagamento efetuado e posteriormente devolvido pelo favorecido ou instituição recebedora. O valor é devolvido para a conta corrente onde ocorreu o débito da requisição)\" - Debitado (pagamento debitado na conta do pagador e pendente de crédito ao favorecido) | [optional] 
+**processing_message** | **String** | Descrição do estado da requisição de cancelamento da transferência | [optional] 
+

data/docs/RootTypeForBatchTransfersCancelRequestObject.md

@@ -0,0 +1,12 @@
+# BancoBrasilPayments::RootTypeForBatchTransfersCancelRequestObject
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**debit_branch_office** | [**BigDecimal**](BigDecimal.md) | Código da agência para débito. Não é necessário quando a solicitação é acessada pelo código de autorização no fluxo do OAuth. | [optional] 
+**debit_current_account** | [**BigDecimal**](BigDecimal.md) | Current account for debit;  Conta Corrente para débito. | [optional] 
+**check_digit_debit_current_account** | **String** | Check digits of current account for debit;  Dígito verificador da conta para débito. | [optional] 
+**payment_contract** | **Integer** | pt-BR: Contract of payment between the third party and Banco do Brasil. Optionally when not informed it will be considered the contract bound to internal identification of the customer.  pt-BR: Contrato de pagamento entre o terceiro e o Banco do Brasil. Opcionalmente, quando não informado, será considerado o contrato vinculado à identificação interna do cliente. | 
+**payments_quantity** | **Integer** | en-US: Quantity of intended payments to be processed in batch.  pt-BR: Quantidade de pagamentos pretendidos a serem processados​em lote. | 
+**payment_ids** | [**Array<BatchtransferscancelPaymentIds>**](BatchtransferscancelPaymentIds.md) | Lista de cancelamentos a serem processados em lote. (Atenção!! As transferências poderão ser canceladas até que a remessa de solicitação do pagamento esteja PROCESSADA. Após o processamento, cancelamentos não serão possíveis) | 
+

data/docs/RootTypeForBatchTransfersCancelResponseObject.md

@@ -0,0 +1,7 @@
+# BancoBrasilPayments::RootTypeForBatchTransfersCancelResponseObject
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**payments_list** | [**Array<RootTypeForBatchTransfersCancelPaymentsListObject>**](RootTypeForBatchTransfersCancelPaymentsListObject.md) | Lista de cancelamentos a serem processados em lote | [optional] 
+

data/docs/RootTypeForReturnedPaymentsDetails.md

@@ -0,0 +1,33 @@
+# BancoBrasilPayments::RootTypeForReturnedPaymentsDetails
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**payment_id** | **String** | Código identificador do pagamento. | [optional] 
+**payment_type** | **Integer** | Modalidade que representa o tipo de pagamento, sendo: 126 pagamento de fornecedores; 127 pagamento de salário e 128 pagamentos diversos | [optional] 
+**credit_type** | **Integer** | A modalidade que representa a maneira como o crédito foi dado, descrito a seguir: 1 significa Crédito em Conta Corrente; 3 significa DOC ou TED; 5 significa Crédito em Conta Poupança; 13 significa Liquidação de Guia com Código de Barra; 21 significa Liquidação de Guia sem Código de Barra; 30 significa Liquidação de Boleto Bancário; 31 significa Liquidação de Papéis Diversos; 71 significa Depósito Judicial. | [optional] 
+**payment_date** | **Integer** | Data do pagamento (formato ddmmaaaa). Solicitações de pagamentos para dias não úteis ou após o horário limite de processamento serão pagas no próximo dia útil, com exceção de transferências entre contas do Banco do Brasil | [optional] 
+**clearinghouse_code** | **Integer** | Código de identificação da instituição para crédito na câmara de compensação (no Brasil, identificado pela sigla COMPE). Por exemplo, valor 1 para o Banco do Brasil e valor 104 para a Caixa Econômica Federal. Se o valor 0 for informado, o campo ispbCode será considerado. | [optional] 
+**ispb_code** | **Integer** | Código identificador do Sistema de Pagamento Brasileiro (Identificado pelo acrônimo ISPB) para crédito. Por exemplo, valor 0 para o Banco do Brasil e valor 360305 para a Caixa Econômica Federal. Não considerado quando o campo clearinghouse é informado. | [optional] 
+**credit_branch_office** | **Integer** | Código da agência para crédito. | [optional] 
+**credit_current_account** | **Integer** | Conta corrente para crédito. Não informado quando se trata de depósito judicial. | [optional] 
+**check_digits_credit_current_account** | **String** | Dígito verificador da conta corrente para crédito. Não informado quando se trata de depósito judicial.  | [optional] 
+**payment_current_account** | **String** | Conta corrente para pagamento. | [optional] 
+**payer_taxpayer_type** | **Integer** | Identifica o tipo de beneficiário, como: 1 - Pessoa física 2 - Pessoa Jurídica. | [optional] 
+**payer_taxpayer_registration** | **Integer** | CPF ou CNPJ do pagador. | [optional] 
+**beneficiary_name** | **String** | Nome da pessoa ou empresa beneficiária no pagamento  | [optional] 
+**paid_value** | **Float** | Valor pago em reais (formato 0.00) | [optional] 
+**numeric_bar_code** | **String** | Define o código de barras numérico do pagamento. | [optional] 
+**payment_value** | **Float** | Valor do pagamento em reais (formato 0.00) | [optional] 
+**request_identification** | **Integer** | Identificação da solicitação de pagamento. É um número único, não sequencial, controlado pelo cliente, cujo valor vai de 1 a 999999. | [optional] 
+**debit_branch_office** | **Integer** | Código da agência para débito. | [optional] 
+**debit_current_account** | **Integer** | Conta corrente de débito. | [optional] 
+**check_digits_debit_current_account** | **String** | Dígito do verificador da conta corrente para débito. | [optional] 
+**credit_card_first_four_digits_start** | **Integer** | Quatro primeiros números do cartão de crédito utilizado para pagamento (pagamento devolvido) | [optional] 
+**credit_card_last_four_digits_end** | **Integer** | Quatro últimos números do cartão de crédito utilizado para pagamento (pagamento devolvido) | [optional] 
+**debit_document** | **Integer** | Documento de débito. | [optional] 
+**returned_date** | **Integer** | Data da devolução do pagamento pelo Beneficiário (formato ddmmaaaa) | [optional] 
+**returned_value** | **Integer** | Valor da devolução do pagamento pelo Beneficiário (formato 0.00) | [optional] 
+**returned_code** | **Integer** | Código que representa o motivo da devolução do pagamento  Domínios(Tipo de pagamento - Código - Mensagem):  Transferência - 01 - CONTA DESTINATÁRIA DO CRÉDITO ENCERRADA; Transferência - 02 - AGÊNCIA OU CONTA DESTINATÁRIA DO CRÉDITO INVÁLIDA; Transferência - 03 - AUSÊNCIA OU DIVERGÊNCIA NA INDICAÇÃO DO CPF/CNPJ ; Transferência - 04 - MENSAGEM INVÁLIDA PARA O TIPO DE TRANSAÇÃO/FINALIDADE; Transferência - 05 - DIVERGÊNCIA NA TITULARIDADE; Transferência - 06 - TRANSFERÊNCIA INSUFICIENTE PARA A FINALIDADE INDICADA; Transferência - 57 - AG/CTA OU CPF/CNPJ DESTINATÁRIO INVÁLIDO OU TRANSF. ENTRE CONTAS CONJUNTAS; Transferência - 58 - TRANSFERÊNCIA DE UMA CONTA CORRENTE PARA UMA CONTA DE POUPANÇA; Transferência - 62 - DIVERGÊNCIA CPF/CNPJ DE UM DOS TITULARES; Transferência - 66 - TRANSFERÊNCIA DE CONTA CONJUNTA PARA CONTA INDIVIDUAL OU VICE VERSA; Transferência - 67 - SEM INDICAÇÃO DO TIPO DE CONTA; Boleto - 01 - DATA DE RECEBIMENTO NÃO NUMÉRICA; Boleto - 02 - AGÊNCIA INVÁLIDA; Boleto - 03 - VALOR RECEBIDO NÃO NUMÉRICO OU IGUAL A ZERO; Boleto - 04 - LOTE NÃO NUMÉRCIO; Boleto - 05 - BANCO INVÁLIDO; Boleto - 06 - CÓDIGO MOEDA NÃO NUMÉRICO; Boleto - 07 - DV CÓDIGO DE BARRAS NÃO NUMÉRICO; Boleto - 08 - FATOR VENCIMENTO NÃO NUMÉRICO; Boleto - 09 - VALOR TÍTULO NÃO NUMÉRICO; Boleto - 10 - CAMPO LIVRE NÃO NUMÉRICO; Boleto - 11 - DV CÓDIGO DE BARRAS NÃO CONFERE; Boleto - 12 - DATA DE RECEBIMENTO INVÁLIDA; Boleto - 13 - VALOR RECEBIMENTO ACIMA DO LIMITE; | [optional] 
+**returned_sequence** | **Integer** | Em caso de devolução parcial dos pagamentos, este campo indicará a sequência de devolução | [optional] 
+

data/docs/RootTypeForReturnedPaymentsResponseObject.md

@@ -0,0 +1,10 @@
+# BancoBrasilPayments::RootTypeForReturnedPaymentsResponseObject
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**index** | **Integer** | Posição do índice. Cada resposta tem um limite de 300 ocorrências na lista paymentList, iniciada a partir do valor do índice fornecido. Para todas as ocorrências, itere sobre esse recurso usando o valor do campo nextIndex da resposta. | [optional] 
+**list_payments** | [**Array<RootTypeForReturnedPaymentsDetails>**](RootTypeForReturnedPaymentsDetails.md) | Lista de detalhes dos pagamentos | [optional] 
+**total_list_quantity** | **Integer** | Quantidade total de pagamentos na tabela | [optional] 
+**current_list_quantity** | **Integer** | Quantidade total de pagamentos | [optional] 
+

data/docs/RootTypeForSlipsDetailsObject.md

@@ -0,0 +1,23 @@
+# BancoBrasilPayments::RootTypeForSlipsDetailsObject
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**slip_id** | **String** | Código identificador do pagamento. | [optional] 
+**payment_date** | **Integer** | Data em que deverá ser efetivado o pagamento do boleto (formato: ddmmaaaa). Campo Obrigatório. Agendamentos poderão ser afetuados para até 180 dias | 
+**payment_value** | **Float** | Valor do pagamento do boleto (formato 0.00). Campo Obrigatório | 
+**numeric_bar_code** | **String** | Código de barras numérico do boleto. Campo obrigatório | 
+**due_date** | **Integer** | Data de vencimento do boleto (formato: ddmmaaaa). Campo Obrigatório | 
+**bank_slip_value** | **Float** | Valor de registro do boleto, sem descontos ou multas (formato 0.00). Campo Obrigatório | 
+**discount_value** | **Float** | Valor do desconto ou do abatimento do boleto ou do desconto + abatimento (formato 0.00) | [optional] 
+**late_payment_value** | **Float** | Valor do juros ou de mora ou multa ou juros + mora+ multa, adicionado valor do boleto (formato 0.00) | [optional] 
+**our_number** | **String** | Número indicado no boleto no campo Nosso Número, no formato STRING, com 20 dígitos. Ex:  31285570000088000 | [optional] 
+**your_number** | **String** | Nº de uso livre pelo cliente conveniado. Equivalente ao Seu Número (Limitado a 20 caracteres). | [optional] 
+**payer_taxpayer_type** | **Integer** | Identifica o tipo de pessoa, como: 1 - Pessoa física 2 - Pessoa Jurídica. | [optional] 
+**payer_taxpayer_registration** | **Integer** | CPF ou CNPJ do pagador. | [optional] 
+**beneficiary_taxpayer_type** | **Integer** | Identifica o tipo de pessoa, como: 1 - Pessoa física 2 - Pessoa Jurídica. | 
+**beneficiary_taxpayer_registration** | **Integer** | CPF ou CNPJ do beneficiário no pagamento. | 
+**guarantor_taxpayer_type** | **Integer** | Identifica o tipo de pessoa, como: 1 - Pessoa física 2 - Pessoa Jurídica. | [optional] 
+**guarantor_taxpayer_registration** | **Integer** | CPF ou CNPJ do avalista. | [optional] 
+**client_description** | **String** | Descrição do pagamento de Boletos. Pode ser preenchido livremente pelo cliente como forma de identificação para o pagamento. | 
+

data/docs/TransfersApi.md

@@ -0,0 +1,309 @@
+# BancoBrasilPayments::TransfersApi
+
+All URIs are relative to *https://api.desenv.bb.com.br/payments-vpn/v3*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**consula_pagamento_transferencias_lote**](TransfersApi.md#consula_pagamento_transferencias_lote) | **GET** /batch-transfers/payments/{id} | Retrieval of detailed infomation of a specific payment
+[**consulta_transferencia_lote**](TransfersApi.md#consulta_transferencia_lote) | **GET** /batch-transfers/{id} | Retrieval from transfers in batch
+[**envia_transferencias_lote**](TransfersApi.md#envia_transferencias_lote) | **POST** /batch-transfers | Request for transfers in batch
+[**lista_transferencias_lote**](TransfersApi.md#lista_transferencias_lote) | **GET** /batch-transfers | List of transfers in batch
+[**sondagem_transferencia_lote**](TransfersApi.md#sondagem_transferencia_lote) | **GET** /batch-transfers/{id}/check | Checks a transfers in batch request
+
+# **consula_pagamento_transferencias_lote**
+> InlineResponse2001 consula_pagamento_transferencias_lote(id, gw_dev_app_key, authorization)
+
+Retrieval of detailed infomation of a specific payment
+
+Recupera detalhes de uma transferência específica enviada enviada pela solicitação ao recurso /batch-transfers (POST)
+
+### Example
+
+```ruby
+# load the gem
+require 'bb_payments'
+# setup authorization
+BancoBrasilPayments.configure do |config|
+    # Configure OAuth2 access token for authorization: OAuth2-CC
+    config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = BancoBrasilPayments::BatchPaymentsApi.new
+id = 'id_example' # String | Identificação de um pagamento específico para um beneficiário. NÃO é o valor do campo requestIdentification do recurso \"Solicitação para transferências em lote\", mas o campo paymentId na matriz paymentsList do recurso \"Recuperação de transferências em lote\".
+gw_dev_app_key = 'gw_dev_app_key_example' # String | Chave de acesso do aplicativo do desenvolvedor. Esta chave é única e obtida no Portal “BB for Developers” e usada para identificar as requisições da aplicação do desenvolvedor.
+authorization = 'authorization_example' # String | É um “token” de acesso fornecido pelo OAuth 2.0.
+
+begin
+    #Retrieval of detailed infomation of a specific payment
+    result = api_instance.consulta_pagamento_transferencias_lote(id, gw_dev_app_key, authorization)
+    p result
+rescue BancoBrasilPayments::ApiError => e
+    puts "Exception when calling BatchPaymentsApi->consula_pagamento_transferencias_lote: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**| Identificação de um pagamento específico para um beneficiário. NÃO é o valor do campo requestIdentification do recurso \"Solicitação para transferências em lote\", mas o campo paymentId na matriz paymentsList do recurso \"Recuperação de transferências em lote\". | 
+ **gw_dev_app_key** | **String**| Chave de acesso do aplicativo do desenvolvedor. Esta chave é única e obtida no Portal “BB for Developers” e usada para identificar as requisições da aplicação do desenvolvedor. | 
+ **authorization** | **String**| É um “token” de acesso fornecido pelo OAuth 2.0. | 
+
+### Return type
+
+[**InlineResponse2001**](InlineResponse2001.md)
+
+### Authorization
+
+[OAuth2-CC](../README.md#OAuth2-CC)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **consulta_transferencia_lote**
+> InlineResponse200 consulta_transferencia_lote(id, gw_dev_app_key, authorization, opts)
+
+Retrieval from transfers in batch
+
+Recupera as informações da solicitação, incluindo a situação da solicitação, e a lista de pagamentos com a situação de cada pagamento da solicitação de transferências em lote. Este recurso tem um limite de 300 ocorrências por resposta.
+
+### Example
+
+```ruby
+# load the gem
+require 'bb_payments'
+# setup authorization
+BancoBrasilPayments.configure do |config|
+    # Configure OAuth2 access token for authorization: OAuth2-CC
+    config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = BancoBrasilPayments::BatchPaymentsApi.new
+id = 'id_example' # String | Identificador da requisição de pagamento. Número único, não sequencial, com domínio entre 1 e 999999999.
+gw_dev_app_key = 'gw_dev_app_key_example' # String | Chave de acesso do aplicativo do desenvolvedor. Esta chave é única e obtida no Portal “BB for Developers” e usada para identificar as requisições da aplicação do desenvolvedor.
+authorization = 'authorization_example' # String | É um “token” de acesso fornecido pelo OAuth 2.0.
+opts = {
+    index: BancoBrasilPayments::BigDecimal.new # BigDecimal | Posição do índice. Cada resposta tem um limite de 300 ocorrências na lista paymentList, iniciada a partir do valor do índice fornecido. Para todas as ocorrências, itere sobre esse recurso usando o valor do campo nextIndex da resposta.
+}
+
+begin
+    #Retrieval from transfers in batch
+    result = api_instance.consulta_transferencia_lote(id, gw_dev_app_key, authorization, opts)
+    p result
+rescue BancoBrasilPayments::ApiError => e
+    puts "Exception when calling BatchPaymentsApi->consulta_transferencia_lote: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**| Identificador da requisição de pagamento. Número único, não sequencial, com domínio entre 1 e 999999999. | 
+ **gw_dev_app_key** | **String**| Chave de acesso do aplicativo do desenvolvedor. Esta chave é única e obtida no Portal “BB for Developers” e usada para identificar as requisições da aplicação do desenvolvedor. | 
+ **authorization** | **String**| É um “token” de acesso fornecido pelo OAuth 2.0. | 
+ **index** | **BigDecimal**| Posição do índice. Cada resposta tem um limite de 300 ocorrências na lista paymentList, iniciada a partir do valor do índice fornecido. Para todas as ocorrências, itere sobre esse recurso usando o valor do campo nextIndex da resposta. | [optional] 
+
+### Return type
+
+[**InlineResponse200**](InlineResponse200.md)
+
+### Authorization
+
+[OAuth2-CC](../README.md#OAuth2-CC)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **envia_transferencias_lote**
+> InlineResponse201 envia_transferencias_lote(bodyauthorizationgw_dev_app_key)
+
+Request for transfers in batch
+
+Pedido de transferências em lote de pagamento de qualquer tipo (fornecedores, salário ou diversos), por transferência bancária (incluindo outros bancos) ou por depósito judicial.  A solicitação será submetida a uma validação prévia das informações do pagador e das entradas inseridas na lista de pagamentos. Após 10 minutos, a rotina de lote será executada, para que as entradas passem por uma validação mais completa.  Além disso, com a intenção de saber definitivamente se tudo correu bem, recomenda-se que o pagador utilize o recurso /batch-transfers/ (GET)
+
+### Example
+
+```ruby
+# load the gem
+require 'bb_payments'
+# setup authorization
+BancoBrasilPayments.configure do |config|
+    # Configure OAuth2 access token for authorization: OAuth2-CC
+    config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = BancoBrasilPayments::BatchPaymentsApi.new
+body = BancoBrasilPayments::Body.new # Body | 
+authorization = 'authorization_example' # String | É um \"token\" de acesso fornecido pelo OAuth 2.0.
+gw_dev_app_key = 'gw_dev_app_key_example' # String | Chave de acesso do aplicativo do desenvolvedor. Esta chave é única e obtida no Portal “BB for Developers” e usada para identificar as requisições da aplicação do desenvolvedor.
+
+begin
+    #Request for transfers in batch
+    result = api_instance.envia_transferencias_lote(bodyauthorizationgw_dev_app_key)
+    p result
+rescue BancoBrasilPayments::ApiError => e
+    puts "Exception when calling BatchPaymentsApi->envia_transferencias_lote: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**Body**](Body.md)|  | 
+ **authorization** | **String**| É um \"token\" de acesso fornecido pelo OAuth 2.0. | 
+ **gw_dev_app_key** | **String**| Chave de acesso do aplicativo do desenvolvedor. Esta chave é única e obtida no Portal “BB for Developers” e usada para identificar as requisições da aplicação do desenvolvedor. | 
+
+### Return type
+
+[**InlineResponse201**](InlineResponse201.md)
+
+### Authorization
+
+[OAuth2-CC](../README.md#OAuth2-CC)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **lista_transferencias_lote**
+> RootTypeForBatchTransferGETResponseObject lista_transferencias_lote(gw_dev_app_key, authorization, start_date, end_date, opts)
+
+List of transfers in batch
+
+Retorna uma lista de lotes de pagamentos.
+
+### Example
+
+```ruby
+# load the gem
+require 'bb_payments'
+# setup authorization
+BancoBrasilPayments.configure do |config|
+    # Configure OAuth2 access token for authorization: OAuth2-CC
+    config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = BancoBrasilPayments::BatchPaymentsApi.new
+gw_dev_app_key = 'gw_dev_app_key_example' # String | Chave de acesso do aplicativo do desenvolvedor. Esta chave é única e obtida no Portal “BB for Developers” e usada para identificar as requisições da aplicação do desenvolvedor.  Example: 0021239456d80136bebf005056891bed
+authorization = 'authorization_example' # String | É um “token” de acesso fornecido pelo OAuth 2.0.  Example: Bearer [ACCESS_TOKEN]
+start_date = 56 # Integer | Data inicial de envio da requisição a ser pesquisada (formato: ddmmaaaa)
+end_date = 56 # Integer | Data final de envio da requisição a ser pesquisada (formato: ddmmaaaa)
+opts = {
+    payment_contract: 56, # Integer | Contrato de pagamento entre o terceiro e o Banco do Brasil. Opcionalmente, quando não informado, será considerado o contrato vinculado à identificação interna do cliente.
+    debit_branch_office: 56, # Integer | Código da agência para débito. Não é necessário quando a solicitação é acessada pelo código de autorização no fluxo do OAuth.
+    debit_current_account: 56, # Integer | Conta corrente de débito. Não é necessário quando a solicitação é acessada pelo código de autorização no fluxo do OAuth.
+    check_digits_debit_current_account: 'check_digits_debit_current_account_example', # String | Dígito do verificador da conta corrente para débito. Não é necessário quando a solicitação é acessada pelo código de autorização no fluxo do OAuth.
+    payment_type: 56, # Integer | A modalidade que representa o tipo de pagamento, descrita a seguir: 126 significa pagamento de fornecedores; 127 significa pagamento de salário; 128 significa pagamento diverso.
+    request_status: 56, # Integer | Código do estado da requisição a ser pesquisada: 1 - Requisição com todos os lançamentos com dados consistentes;  2 - Requisição com ao menos um dos lançamentos com dados inconsistentes; 3 - Requisição com todos os lançamentos com dados inconsistentes;  4 - Requisição pendente de ação pelo Conveniado - falta autorizar o pagamento;  5 - Requisição em processamento pelo Banco;  6 - Requisição Processada;  7 - Requisição Rejeitada,  8 - Preparando remessa não liberada,  9 - Requisição liberada via API,  10 -  Preparando remessa liberada.   As situações 1, 2 e 8 são transitórias e não requerem qualquer ação do Cliente Conveniado. situação 3 sempre será migrada para situação 7.  A situação 4 Significa que, ao menos um lançamento, depende de ação do Cliente Conveniado, seja liberando ou cancelando os pagamentos.  As situações 5, 6, 7, 9 e 10 não requerem qualquer ação do Cliente Conveniado. A situação 5 significa que, ao menos um lançamento, está agendado.  As situações 6 e 7 são definitivas não havendo alteração posterior da situação da requisição. 
+    index: 56 # Integer | Posição do índice de paginação.  Indica a posição a partir da qual a pesquisa tratá os registros (ex: valor 0, indica que está trazendo a partir do registro 1, valor 300 indica que está trazendo a partir do 301). Cada resposta tem um limite de 300 ocorrências na lista paymentList, iniciada a partir do valor do índice fornecido. Para todas as ocorrências, itere sobre esse recurso usando o valor do campo nextIndex da resposta
+}
+
+begin
+    #List of transfers in batch
+    result = api_instance.lista_transferencias_lote(gw_dev_app_key, authorization, start_date, end_date, opts)
+    p result
+rescue BancoBrasilPayments::ApiError => e
+    puts "Exception when calling BatchPaymentsApi->lista_transferencias_lote: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **gw_dev_app_key** | **String**| Chave de acesso do aplicativo do desenvolvedor. Esta chave é única e obtida no Portal “BB for Developers” e usada para identificar as requisições da aplicação do desenvolvedor.  Example: 0021239456d80136bebf005056891bed | 
+ **authorization** | **String**| É um “token” de acesso fornecido pelo OAuth 2.0.  Example: Bearer [ACCESS_TOKEN] | 
+ **start_date** | **Integer**| Data inicial de envio da requisição a ser pesquisada (formato: ddmmaaaa) | 
+ **end_date** | **Integer**| Data final de envio da requisição a ser pesquisada (formato: ddmmaaaa) | 
+ **payment_contract** | **Integer**| Contrato de pagamento entre o terceiro e o Banco do Brasil. Opcionalmente, quando não informado, será considerado o contrato vinculado à identificação interna do cliente. | [optional] 
+ **debit_branch_office** | **Integer**| Código da agência para débito. Não é necessário quando a solicitação é acessada pelo código de autorização no fluxo do OAuth. | [optional] 
+ **debit_current_account** | **Integer**| Conta corrente de débito. Não é necessário quando a solicitação é acessada pelo código de autorização no fluxo do OAuth. | [optional] 
+ **check_digits_debit_current_account** | **String**| Dígito do verificador da conta corrente para débito. Não é necessário quando a solicitação é acessada pelo código de autorização no fluxo do OAuth. | [optional] 
+ **payment_type** | **Integer**| A modalidade que representa o tipo de pagamento, descrita a seguir: 126 significa pagamento de fornecedores; 127 significa pagamento de salário; 128 significa pagamento diverso. | [optional] 
+ **request_status** | **Integer**| Código do estado da requisição a ser pesquisada: 1 - Requisição com todos os lançamentos com dados consistentes;  2 - Requisição com ao menos um dos lançamentos com dados inconsistentes; 3 - Requisição com todos os lançamentos com dados inconsistentes;  4 - Requisição pendente de ação pelo Conveniado - falta autorizar o pagamento;  5 - Requisição em processamento pelo Banco;  6 - Requisição Processada;  7 - Requisição Rejeitada,  8 - Preparando remessa não liberada,  9 - Requisição liberada via API,  10 -  Preparando remessa liberada.   As situações 1, 2 e 8 são transitórias e não requerem qualquer ação do Cliente Conveniado. situação 3 sempre será migrada para situação 7.  A situação 4 Significa que, ao menos um lançamento, depende de ação do Cliente Conveniado, seja liberando ou cancelando os pagamentos.  As situações 5, 6, 7, 9 e 10 não requerem qualquer ação do Cliente Conveniado. A situação 5 significa que, ao menos um lançamento, está agendado.  As situações 6 e 7 são definitivas não havendo alteração posterior da situação da requisição.  | [optional] 
+ **index** | **Integer**| Posição do índice de paginação.  Indica a posição a partir da qual a pesquisa tratá os registros (ex: valor 0, indica que está trazendo a partir do registro 1, valor 300 indica que está trazendo a partir do 301). Cada resposta tem um limite de 300 ocorrências na lista paymentList, iniciada a partir do valor do índice fornecido. Para todas as ocorrências, itere sobre esse recurso usando o valor do campo nextIndex da resposta | [optional] 
+
+### Return type
+
+[**RootTypeForBatchTransferGETResponseObject**](RootTypeForBatchTransferGETResponseObject.md)
+
+### Authorization
+
+[OAuth2-CC](../README.md#OAuth2-CC)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **sondagem_transferencia_lote**
+> InlineResponse2002 sondagem_transferencia_lote(id, gw_dev_app_key, authorization)
+
+Checks a transfers in batch request
+
+Verifica se a requisição ao recurso Transfers in Batch foi bem-sucedida ao se registrar no sistema de pagamento do Banco do Brasil.  O requestresource (Transfers in Batch) faz uma validação referente ao solicitante do pagamento e às entradasfornecidas na requisição. Após 10 minutos, quando a rotina em lote é executada, o cliente deve verificar o resultado para ver se algum outro ponto de inconsistência foi encontrado. Além disso, após a data de pagamento informada, o cliente deve consultar novamente a solicitação de pagamento para saber definitivamente se tudo correu bem.
+
+### Example
+
+```ruby
+# load the gem
+require 'bb_payments'
+# setup authorization
+BancoBrasilPayments.configure do |config|
+    # Configure OAuth2 access token for authorization: OAuth2-CC
+    config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = BancoBrasilPayments::BatchPaymentsApi.new
+id = 'id_example' # String | Identificador da requisição de pagamento. Número único, não sequencial, controlado pelo cliente, com domínio entre 1 e 999999999.
+gw_dev_app_key = 'gw_dev_app_key_example' # String | Chave de acesso do aplicativo do desenvolvedor. Esta chave é única e obtida no Portal “BB for Developers” e usada para identificar as requisições da aplicação do desenvolvedor.
+authorization = 'authorization_example' # String | É um “token” de acesso fornecido pelo OAuth 2.0.
+
+begin
+    #Checks a transfers in batch request
+    result = api_instance.sondagem_transferencia_lote(id, gw_dev_app_key, authorization)
+    p result
+rescue BancoBrasilPayments::ApiError => e
+    puts "Exception when calling BatchPaymentsApi->sondagem_transferencia_lote: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**| Identificador da requisição de pagamento. Número único, não sequencial, controlado pelo cliente, com domínio entre 1 e 999999999. | 
+ **gw_dev_app_key** | **String**| Chave de acesso do aplicativo do desenvolvedor. Esta chave é única e obtida no Portal “BB for Developers” e usada para identificar as requisições da aplicação do desenvolvedor. | 
+ **authorization** | **String**| É um “token” de acesso fornecido pelo OAuth 2.0. | 
+
+### Return type
+
+[**InlineResponse2002**](InlineResponse2002.md)
+
+### Authorization
+
+[OAuth2-CC](../README.md#OAuth2-CC)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+

data/lib/bb_payments/api/base.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+# TODO: add generic methods and args verifications
+module BancoBrasilPayments::Base
+  def without_http_info_meths(*method_names)
+    method_names.compact.each do |method_name|
+      define_method(method_name) { |*args, &block| send("#{method_name}_with_http_info", *args, &block)[0] }
+    end
+  end
+end

data/lib/bb_payments/api/base_api.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module BancoBrasilPayments::BaseApi
+  def call_api_client(api_client:, http_method:, path:, data_only: true, client_opts: {})
+    data, status_code, headers = api_client.call_api(http_method, path, client_opts)
+
+    if api_client.config.debugging
+      api_client.config.logger.debug "API called: BatchPaymentsApi#consult_payments\n"\
+      "Data: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+    end
+
+    return data if data_only
+    return data, status_code, headers
+  end
+
+  def validations(api_client:, body: nil, validate_body: false, required_params: {})
+    label = caller_locations(1, 1)[0].label
+
+    if api_client.config.debugging
+      api_client.config.logger.debug "Calling API: BatchPaymentsApi.#{label} ..."
+    end
+    return unless api_client.config.client_side_validation
+
+    # verify the required parameter 'gw_app_key' is set
+    if gw_app_key.nil?
+      fail ArgumentError, "Missing the required parameter 'gw_app_key' when calling BatchPaymentsApi.#{label}"
+    end
+
+    required_params.each do |par_name, par_value|
+      next unless par_value.nil?
+
+      fail ArgumentError, "Missing the required parameter '#{par_name}' when calling BatchPaymentsApi.#{label}"
+    end
+
+    return unless validate_body
+    if body.nil? || !body.valid?
+      base_msg = "Invalid required parameter 'body' when calling BatchPaymentsApi.#{label}. "
+      reason_msg = "Parameter missing" if body.nil?
+      reason_msg = "#{body.list_invalid_properties}" if body.present?
+      fail ArgumentError, "#{base_msg} #{reason_msg}"
+    end
+  end
+
+  def build_client_opts(api_client:, gw_app_key:, opts:, return_type: 'Object', body: nil)
+    client_opts = {
+      base_path: '/pagamentos-lote/v1',
+      body: opts[:body] || body,
+      form_params: opts[:form_params] || {},
+      return_type: opts[:return_type] || return_type,
+      auth_names: opts[:auth_names] || ['OAuth2-CC'],
+      query_params: opts[:query_params] || {},
+      header_params: opts[:header_params] || {}
+    }
+
+    # query parameters
+    client_opts[:query_params][api_client.config.app_key_name.to_sym] = gw_app_key
+
+    # HTTP header 'Accept' (if needed)
+    client_opts[:header_params]['Accept'] = api_client.select_header_accept(['application/json'])
+
+    client_opts
+  end
+end

data/lib/bb_payments/api/batch_payments_api.rb

@@ -0,0 +1,50 @@
+=begin
+openapi: 3.0.1
+info:
+  title: Pagamentos em Lote
+  description: API para realizar consultas, requisições, liberações, cancelamentos, etc., de pagamento/transferências em lote.
+  contact:
+    name: Banco do Brasil S.A. - BB for Developers
+    url: https://developers.bb.com.br
+  version: '1.41'
+
+[Implemented] - [Tag]      => Description
+[N] - [GPS]                => Pagamentos que envolvem GPS
+[N] - [GRU]                => Pagamentos que envolvem GRUs
+[N] - [DARF Preto]         => Pagamentos que envolvem DARFs Preto
+[Y] - [Pagamentos]         => Pagamentos que envolvem mais de um tipo de Pagamento
+[N] - [Código de Barras]   => Pagamentos que envolvem Códigos de Barras
+[Y] - [Transferências]     => Pagamentos que envolvem Transferências
+[N] - [Boletos]            => Pagamentos que envolvem Boletos
+[Y] - [Transferências-PIX] => Pagamentos que envolvem Transferências do tipo PIX
+
+=end
+
+module BancoBrasilPayments
+  class BatchPaymentsApi
+    include BaseApi
+    include Payments
+    include Transfers
+
+    attr_accessor :api_client, :gw_app_key
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+      @gw_app_key = @api_client.config.gw_app_key
+    end
+
+    def swagger(opts = {})
+      validations(api_client: api_client)
+
+      client_opts = build_client_opts(api_client: api_client,
+                                      gw_app_key: gw_app_key,
+                                      opts: opts)
+
+      call_api_client(api_client: api_client,
+                      http_method: :GET,
+                      path: '/swagger',
+                      data_only: opts.fetch(:data_only, true),
+                      client_opts: client_opts)
+    end
+  end
+end