bb_payments 0.1.1

data/docs/BankSlipsApi.md

@@ -0,0 +1,178 @@
+# BancoBrasilPayments::BankSlipsApi
+
+All URIs are relative to *https://api.desenv.bb.com.br/payments-vpn/v3*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**consulta_pagamento_boleto**](BankSlipsApi.md#consulta_pagamento_boleto) | **GET** /barcode-payment-slips/{id} | Barcode Payment Slip Details
+[**enviar_pagamento_boletos_lote**](BankSlipsApi.md#enviar_pagamento_boletos_lote) | **POST** /batch-slips | Batch Payment of Bank Slips
+[**sondagem_pagamento_boleto**](BankSlipsApi.md#sondagem_pagamento_boleto) | **GET** /batch-slips/{id}/check | Checks the payment of Bank Slips made in the Request Payment feature
+
+# **consulta_pagamento_boleto**
+> InlineResponse2003 consulta_pagamento_boleto(id, gw_dev_app_key, authorization, opts)
+
+Barcode Payment Slip Details
+
+Detalha um boleto de pagamento.
+
+### 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::BankSlipsApi.new
+id = 'id_example' # String | Código identificador do pagamento.
+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]
+opts = { 
+  agencia: 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.
+  conta: 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. 
+  digito_conta: 'digito_conta_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. 
+}
+
+begin
+  #Barcode Payment Slip Details
+  result = api_instance.consulta_pagamento_boleto(id, gw_dev_app_key, authorization, opts)
+  p result
+rescue BancoBrasilPayments::ApiError => e
+  puts "Exception when calling BankSlipsApi->consulta_pagamento_boleto: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**| Código identificador do pagamento. | 
+ **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] | 
+ **agencia** | **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] 
+ **conta** | **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] 
+ **digito_conta** | **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] 
+
+### Return type
+
+[**InlineResponse2003**](InlineResponse2003.md)
+
+### Authorization
+
+[OAuth2-CC](../README.md#OAuth2-CC)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **enviar_pagamento_boletos_lote**
+> RootTypeForBankSlipsBatchPaymentResponseObject enviar_pagamento_boletos_lote(bodyauthorizationgw_dev_app_key)
+
+Batch Payment of Bank Slips
+
+solicitar pagamento em lote de Boletos
+
+### 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::BankSlipsApi.new
+body = BancoBrasilPayments::RootTypeForBankSlipsBatchPayment.new # RootTypeForBankSlipsBatchPayment | Objeto de requisição do recurso de pagamento em lote de Boletos.
+authorization = 'authorization_example' # String | É um “token” de acesso fornecido pelo OAuth 2.0.  Example: Bearer [ACCESS_TOKEN]
+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
+
+
+begin
+  #Batch Payment of Bank Slips
+  result = api_instance.enviar_pagamento_boletos_lote(bodyauthorizationgw_dev_app_key)
+  p result
+rescue BancoBrasilPayments::ApiError => e
+  puts "Exception when calling BankSlipsApi->enviar_pagamento_boletos_lote: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**RootTypeForBankSlipsBatchPayment**](RootTypeForBankSlipsBatchPayment.md)| Objeto de requisição do recurso de pagamento em lote de Boletos. | 
+ **authorization** | **String**| É um “token” de acesso fornecido pelo OAuth 2.0.  Example: Bearer [ACCESS_TOKEN] | 
+ **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 | 
+
+### Return type
+
+[**RootTypeForBankSlipsBatchPaymentResponseObject**](RootTypeForBankSlipsBatchPaymentResponseObject.md)
+
+### Authorization
+
+[OAuth2-CC](../README.md#OAuth2-CC)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **sondagem_pagamento_boleto**
+> RootTypeForBankSlipsBatchPaymentResponseObject sondagem_pagamento_boleto(id)
+
+Checks the payment of Bank Slips made in the Request Payment feature
+
+Consulta o pagamento de Boletos realizado no recurso de Solicitação de Pagamento. Recurso utilizado quando a empresa não recebeu a confirmação da Solicitação de Pagamento do Boleto, ou quando precisar recuperar a resposta original ou quando quer confirmar que o número requestID já foi utilizado.
+
+### 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::BankSlipsApi.new
+id = 'id_example' # String | Numero controlado pelo cliente para identificar cada acionamento da API e os lançamentos de cada chamada. Não precisa ser sequencial. De uso único.
+
+
+begin
+  #Checks the payment of Bank Slips made in the Request Payment feature
+  result = api_instance.sondagem_pagamento_boleto(id)
+  p result
+rescue BancoBrasilPayments::ApiError => e
+  puts "Exception when calling BankSlipsApi->sondagem_pagamento_boleto: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**| Numero controlado pelo cliente para identificar cada acionamento da API e os lançamentos de cada chamada. Não precisa ser sequencial. De uso único. | 
+
+### Return type
+
+[**RootTypeForBankSlipsBatchPaymentResponseObject**](RootTypeForBankSlipsBatchPaymentResponseObject.md)
+
+### Authorization
+
+[OAuth2-CC](../README.md#OAuth2-CC)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+

data/docs/BarcodeCollectionFormsIDResponseObject.md

@@ -0,0 +1,6 @@
+# BancoBrasilPayments::BarcodeCollectionFormsIDResponseObject
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+

data/docs/BarcodeCollectionFormsIDResponseObjectListaGuiaCodigoBarra.md

@@ -0,0 +1,10 @@
+# BancoBrasilPayments::BarcodeCollectionFormsIDResponseObjectListaGuiaCodigoBarra
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**codigo_barra** | **Float** | Código de barras da guia consultada. | [optional] 
+**nome_recebedor** | **String** | Nome do recebedor/conveniado que emitiu a  guia. | [optional] 
+**seu_numero** | **Float** | Codigo do seu numero  informado na solicitação de pagamento. | [optional] 
+**texto_livre** | **String** | Campo livre informado pelo pagador quando do envio do lançamento consultado – sem tratamento pelo Banco. | [optional] 
+

data/docs/BarcodeCollectionFormsIDResponseObjectListaOcorrencia.md

@@ -0,0 +1,9 @@
+# BancoBrasilPayments::BarcodeCollectionFormsIDResponseObjectListaOcorrencia
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**codigo** | **Float** | Código do motivo da ocorrência, conforme descrito a seguir.  Domínio: 1 - Agência de crédito igual a zero. Informe o nº da Agência de Crédito. 2 - Conta de crédito não é numérica. Informe apenas números. 3 - Dígito conta de crédito igual a espaços. Informe o DV da conta de crédito. 4 - CPF não é numérico. Informe apenas números. 5 - CNPJ não é numérico. Informe apenas números. 6 - Data do pagamento igual a zeros. Informe a data do pagamento. 7 - Data do pagamento inválida. Informe uma data de pagamento válida. 8 - Valor do pagamento não é númerico. Informe apenas números. 9 - Valor do pagamento igual a zeros. Informe o valor do pagamento. 10 - Ambos os campos Número Compensação e Número ISPB estão zerados. Informe um dos campos. 11 - Ambos os campos Número Compensação e Número ISPB foram informados. Informe apenas um dos campos. 12 - Ambos os campos Finalidade DOC e Finalidade TED estão zerados. Informe um dos campos. 13 - Ambos os campos Finalidade DOC e Finalidade TED foram informados. Informe apenas um dos campos. 14 - Número depósito judicial igual a espaços.  15 - Digito da conta de crédito inválido.  16 - Ambos os campos CPF e CNPJ foram informados. Informe apenas um dos campos. Caso informado os 2 campos, nas consultas será exibido apenas os dados do CPF. 17 - Ambos os campos CPF e CNPJ estão zerados. Informe um dos campos. 18 - Digito do CPF inválido. Verifique o dado informado. 19 - Dígito do CNPJ inválido. Verifique o dado informado. 20 - Agência e conta de crédito estão iguais a de débito. Opção não permitida. 21 - Número Compensação inválido. Verifique o dado informado. 22 - Número ISPB diferente de zeros. Não informe o nº ISPB. 23 - Conta de crédito igual a zeros. Informe o número da conta de crédito. 24 - CPF igual a Zeros. Obrigatório informar o nº do CPF. 25 - CNPJ diferente de zeros. Não permitido informar CNPJ. 26 - Conta de crédito diferente de zeros. Não permitido informar Conta de crédito. 27 - Dígito conta de crédito diferente de espaços. Não informar dígito da conta de crédito. 28 - Finalidade DOC diferente de zeros. Não informar finalidade DOC. 29 - Finalidade TED diferente de zeros. Não informar finalidade TED. 30 - Número Depósito Judicial diferente de espaços. Não informar finalidade Depósito Judicial. 31 - Número do documento de crédito não é numérico. Informar números. 32 - Número do documento de débito não é numérico. Informar números. 33 - CPF não encontrado na base da receita federal. 34 - CNPJ não encontrado na base da receita federal. 35 - Conta de poupança não permitido. Para creditar poupança utilize Código Produto igual a 128 - Pagamentos Diversos. 36 - Código COMPE deve ser igual a 1. 37 - Código ISPB deve ser igual a 0. 38 - Código de barras não é numérico. Informar números. 39 - Código de barras igual a zeros. Informar números. 40 - Número de inscrição do pagador não é numérico. Informar números. 41 - Número de inscrição do beneficiário não é numérico. Informar números. 42 - Número de inscrição do avalista não é numérico. Informar números. 43 - Digito do CPF para o pagador inválido. Verifique o nº correto. 44 - Digito do CPF para o beneficiário inválido. Verifique o nº correto. 45 - Digito do CPF para o avalista inválido. Verifique o nº correto. 46 - Digito do CNPJ para o pagador inválido. Verifique o nº correto. 47 - Digito do CNPJ para o beneficiário inválido. Verifique o nº correto. 48 - Digito do CNPJ para o avalista inválido. Verifique o nº correto. 49 - Data do vencimento inválida.  Informar data válida. 50 - Valor nominal não é numérico. Informar números. 51 - Valor de desconto não é numérico. Informar números. 52 - Valor de mora não é numérico. Informar números. 53 - Data do pagamento deve ser maior ou igual ao dia atual.  54 - Número do documento de débito igual a zeros. 55 - Data do vencimento igual a zeros. Informar data de vencimento. 56 - Nome do beneficiário não informado. 57 - Número de inscrição do beneficiário não informado. Obrigatório informar o CPF ou CNPJ do beneficiário. 58 - Conta pagamento diferente de espaços. Não informar conta pagamento. 59 - Ambos os campos conta de crédito e conta pagamento foram informados. Informar apenas um dos campos. 99 - Consultar o Banco para detalhar o erro. 200 - Insuficiência de Fundos - Débito Não Efetuado. 201 - Crédito ou Débito Cancelado pelo Pagador. 202 - Débito Autorizado pela Agência - Efetuado. 203 - Controle Inválido. Verificar campos 01, 02 e 03 do header ou segmento A, B, C, J, J52, N, O ou W do Arquivo CNAB240. Limitação de 80 carecteres para uso nos canais logados BB: Controle Inválido. Vide campos 01,02 e 03 do header/segmento do Arquivo CNAB240. 204 - Tipo de Operação Inválido. 205 - Tipo de Serviço Inválido. Utilize 20 para Pagamento a Fornecedores, 30 Pagamento de Salários ou 98 Pagamentos Diversos. 206 - Forma de Lançamento Inválida. Para crédito em Poupança utilize Pagamentos Diversos. Para crédito em Conta Pagamento utilize Pagamentos Diversos ou Pagamento a Fornecedores.  Para Pagamento de salário a conta de crédito deve ser do BB. 207 - Tipo/Número de Inscrição Inválido. CPF ou CNPJ inválido. 208 - Código de Convênio Inválido. 209 - Agência/Conta Corrente/DV Inválido. 210 - Nº Seqüencial do Registro no Lote Inválido. 211 - Código de Segmento de Detalhe Inválido. 212 - Lançamento inconsistente, rejeitado na prévia. Corrigir os dados do lançamento e enviar novo pagamento. 213 - Nº Compe do Banco para crédito Inválido. 214 - Nº do ISPB Banco, Instituição de Pagamento para crédito Inválido. 215 - Agência Mantenedora da Conta Corrente do Favorecido Inválida. 216 - Conta Corrente/DV/Conta de Pagamento do Favorecido Inválido. 217 - Nome do Favorecido Não Informado. 218 - Data Lançamento Inválido. 219 - Tipo/Quantidade da Moeda Inválido. 220 - Valor do Lançamento Inválido. 221 - Aviso ao Favorecido - Identificação Inválida. 222 - Tipo/Número de Inscrição do Favorecido Inválido CPF ou CNPJ do favorecido inválido. 223 - Logradouro do Favorecido Não Informado. 224 - Nº do Local do Favorecido Não Informado. 225 - Cidade do Favorecido Não Informada. 226 - CEP/Complemento do Favorecido Inválido. 227 - Sigla do Estado do Favorecido Inválida. 228 - Nº do Banco para crédito Inválido. 229 - Código/Nome da Agência Depositária Não Informado. 230 - Seu Número Inválido. 231 - Nosso Número Inválido. 232 - Inclusão Efetuada com Sucesso. 233 - Alteração Efetuada com Sucesso. 234 - Exclusão Efetuada com Sucesso. 235 - Agência/Conta Impedida Legalmente. 236 - Empresa não pagou salário Conta de crédito só aceita pagamento de salário. 237 - Falecimento do mutuário. 238 - Empresa não enviou remessa do mutuário. 239 - Empresa não enviou remessa no vencimento. 240 - Valor da parcela inválida. 241 - Identificação do contrato inválida. 242 - Operação de Consignação Incluída com Sucesso. 243 - Operação de Consignação Alterada com Sucesso. 244 - Operação de Consignação Excluída com Sucesso. 245 - Operação de Consignação Liquidada com Sucesso. 246 - Reativação Efetuada com Sucesso. 247 - Suspensão Efetuada com Sucesso. 248 - Código de Barras - Código do Banco Inválido. 249 - Código de Barras - Código da Moeda Inválido. 250 - Código de Barras - Dígito Verificador Geral Inválido. 251 - Código de Barras - Valor do Título Inválido. 252 - Código de Barras - Campo Livre Inválido. 253 - Valor do Documento Inválido. 254 - Valor do Abatimento Inválido. 255 - Valor do Desconto Inválido. 256 - Valor de Mora Inválido. 257 - Valor da Multa Inválido. 258 - Valor do IR Inválido. 259 - Valor do ISS Inválido. 260 - Valor do IOF Inválido. 261 - Valor de Outras Deduções Inválido. 262 - Valor de Outros Acréscimos Inválido. 263 - Valor do INSS Inválido. 264 - Lote Não Aceito. 265 - Inscrição da Empresa Inválida para o Contrato. 266 - Convênio com a Empresa Inexistente/Inválido para o Contrato. 267 - Agência/Conta Corrente da Empresa Inexistente/Inválido para o Contrato. 268 - Tipo de Serviço Inválido para o Contrato. 269 - Conta Corrente da Empresa com Saldo Insuficiente. 270 - Lote de Serviço Fora de Seqüência. 271 - Lote de Serviço Inválido. 272 - Arquivo não aceito. 273 - Tipo de Registro Inválido. 274 - Código Remessa / Retorno Inválido. 275 - Versão de layout inválida. 276 - Mutuário não identificado. 277 - Tipo do beneficio não permite empréstimo. 278 - Beneficio cessado/suspenso. 279 - Beneficio possui representante legal. 280 - Beneficio é do tipo PA (Pensão alimentícia). 281 - Quantidade de contratos permitida excedida. 282 - Beneficio não pertence ao Banco informado. 283 - Início do desconto informado já ultrapassado. 284 - Número da parcela inválida. 285 - Quantidade de parcela inválida. 286 - Margem consignável excedida para o mutuário dentro do prazo do contrato. 287 - Empréstimo já cadastrado. 288 - Empréstimo inexistente. 289 - Empréstimo já encerrado. 290 - Arquivo sem trailer. 291 - Mutuário sem crédito na competência. 292 - Não descontado – outros motivos. 293 - Retorno de Crédito não pago. 294 - Cancelamento de empréstimo retroativo. 295 - Outros Motivos de Glosa. 296 - Margem consignável excedida para o mutuário acima do prazo do contrato. 297 - Mutuário desligado do empregador. 298 - Mutuário afastado por licença. 299 - Primeiro nome do mutuário diferente do primeiro nome do movimento do censo ou diferente da base de Titular do Benefício. 300 - Benefício suspenso/cessado pela APS ou Sisobi. 301 - Benefício suspenso por dependência de cálculo. 302 - Benefício suspenso/cessado pela inspetoria/auditoria. 303 - Benefício bloqueado para empréstimo pelo beneficiário. 304 - Benefício bloqueado para empréstimo por TBM. 305 - Benefício está em fase de concessão de PA ou desdobramento. 306 - Benefício cessado por óbito. 307 - Benefício cessado por fraude. 308 - Benefício cessado por concessão de outro benefício. 309 - Benefício cessado: estatutário transferido para órgão de origem. 310 - Empréstimo suspenso pela APS. 311 - Empréstimo cancelado pelo banco. 312 - Crédito transformado em PAB. 313 - Término da consignação foi alterado. 314 - Fim do empréstimo ocorreu durante período de suspensão ou concessão. 315 - Empréstimo suspenso pelo banco. 316 - Não averbação de contrato – quantidade de parcelas/competências informadas ultrapassou a data limite da extinção de cota do dependente titular de benefícios. 317 - Lote Não Aceito - Totais do Lote com Diferença. 318 - Título Não Encontrado. 319 - Identificador Registro Opcional Inválido. 320 - Código Padrão Inválido. 321 - Código de Ocorrência Inválido. 322 - Complemento de Ocorrência Inválido. 323 - Alegação já Informada. 324 - Agência / Conta do Favorecido Substituída. 325 - Divergência entre o primeiro e último nome do beneficiário versus primeiro e último nome na Receita Federal. 326 - Confirmação de Antecipação de Valor. 327 - Antecipação parcial de valor. 328 - Boleto bloqueado na base. Não passível de pagamento. 329 - Sistema em contingência – Boleto valor maior que referência. 330 - Sistema em contingência – Boleto vencido. 331 - Sistema em contingência – Boleto indexado. 332 - Beneficiário divergente.  333 - Limite de pagamentos parciais do boleto excedido. Consulte o Beneficiário do boleto. 334 - Boleto já liquidado. Não passível de pagamento. 999 - Consultar o Banco para detalhar o erro. | [optional] 
+**data** | **Float** | Data em que o beneficiário do pagamento envio a devolução dos recursos. | [optional] 
+**valor** | **Float** | Valor devolvido pelo beneficiário do pagamento. Pode ser parcial. | [optional] 
+

data/docs/BarcodeCollectionFormsRequestObject.md

@@ -0,0 +1,12 @@
+# BancoBrasilPayments::BarcodeCollectionFormsRequestObject
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**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. | 
+**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] 
+**collection_form_details_list** | [**Array<BarcodecollectionformsCollectionFormDetailsList>**](BarcodecollectionformsCollectionFormDetailsList.md) | Lista de Guias de Pagamento detalhadas | 
+

data/docs/BarcodecollectionformsCollectionFormDetailsList.md

@@ -0,0 +1,12 @@
+# BancoBrasilPayments::BarcodecollectionformsCollectionFormDetailsList
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**numeric_bar_code** | **String** | Define o código de barras numérico da Guia de Recolhimento. | 
+**payment_date** | **Integer** | Data em que deverá ser efetivado o pagamento (formato: ddmmaaaa). Os pagamentos poderão ser agendados para até 180 dias. Campo Obrigatório. | 
+**payment_value** | **Float** | Valor total das Guias de Recolhimento (formato 0.00). Campo Obrigatório. | 
+**debit_code** | **Integer** | Código personalizado usado para identificar um débito no extrato bancário do cliente. Pode ser usado para agrupar débitos similares | [optional] 
+**your_number** | **String** | Nº de uso livre pelo cliente conveniado. Equivalente ao Seu Número (Limitado a 20 caracteres). | [optional] 
+**customer_description** | **String** | Descrição do pagamento. Pode ser preenchido livremente pelo cliente como forma de identificação para o pagamento. | [optional] 
+

data/docs/BatchtransfersPaymentsList.md

@@ -0,0 +1,22 @@
+# BancoBrasilPayments::BatchtransfersPaymentsList
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**clearinghouse_code** | **Float** | 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** | **Float** | 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** | **Float** | Código da agência para crédito. | [optional] 
+**credit_current_account** | **Float** | Conta corrente para crédito. | [optional] 
+**check_digits_credit_current_account** | **String** | Dígito verificador da conta corrente para crédito. | [optional] 
+**credit_payment_account** | **String** | Conta de pagamento para crédito. Se esse campo estiver preenchido, os campos creditBranchOffice, creditCurrentAccount, checkDigitsCreditCurrentAccount e depositInCourtIdentifier não deverão ser inseridos. | [optional] 
+**individual_taxpayer_registration** | **Float** | Número do CPF junto à Receita Federal. Não informado quando diz respeito ao pagamento de contribuinte do tipo pessoa jurídica. | [optional] 
+**corporate_taxpayer_registration** | [**BigDecimal**](BigDecimal.md) | Número do CNPJ junto à Receita Federal. Não informado quando diz respeito ao pagamento de contribuinte do tipo pessoa física. | [optional] 
+**payment_date** | **Float** | 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. Poderão ser efetuados agendamentos para até 180 dias | [optional] 
+**payment_value** | **Float** | Valor do pagamento em reais (formato 0.00) | 
+**debit_document** | **Float** | Documento de débito que será mostrado no extrato da conta do pagador.  Por ser um campo opcional, se não inserido, a conta de débito terá um único lançamento no valor total de todos os lançamentos de créditos validados. De igual modo será se o mesmo número for informado para todos os lançamentos de crédito.  Quando números diferentes forem informados para cada lançamento, os lançamentos de débitos serão individualizados. | [optional] 
+**credit_document** | **Float** | Número do documento de crédito exibido no extrato do favorecido - uso exclusivo para Crédito em conta corrente no BB. | [optional] 
+**credit_order_purpose_code** | **String** | Código de finalidade informado quando se trata de DOC. Uma lista de códigos permitidos é obtida na Federação Brasileira de Bancos (identificada pela sigla FEBRABAN). Por exemplo, 1 para Crédito em Conta Corrente; 11 para DOC em Conta Poupança; 12 para DOC em Conta de Depósito Judicial. | [optional] 
+**wire_transfer_purpose_code** | **String** | Código de finalidade informado quando se trata de TED.  Uma lista de códigos permitidos é obtida no Banco Central do Brasil (Identificado pelo acrônimo BACEN). | [optional] 
+**deposit_in_court_identifier** | **String** | Identificador informado quando se trata de depósito judicial.  Insira valor 1 para o campo COMPE ou valor 0 para o campo ISPB.  Se esse campo estiver preenchido, os campos creditBranchOffice, creditCurrentAccount, checkDigitsCreditCurrentAccount e creditPaymentAccount não deverão ser inseridos. | [optional] 
+**payment_description** | **String** | Campo de uso livre pelo cliente conveniado - sem tratamento pelo Banco. | [optional] 
+

data/docs/BatchtransferscancelPaymentIds.md

@@ -0,0 +1,7 @@
+# BancoBrasilPayments::BatchtransferscancelPaymentIds
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**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. | 
+

data/docs/Body.md

@@ -0,0 +1,13 @@
+# BancoBrasilPayments::Body
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**request_identification** | **Float** | 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] 
+**payment_contract** | **Float** | 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** | **Float** | 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) | 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** | **Float** | Modalidade que representa o tipo de pagamento, sendo: 126 pagamento de fornecedores; 127 pagamento de salário e 128 pagamentos diversos | [optional] 
+**payments_list** | [**Array<BatchtransfersPaymentsList>**](BatchtransfersPaymentsList.md) | Lista de pagamentos a serem processados em lote. Não permitido mais de 250 registros. | [optional] 
+

data/docs/CancelApi.md

@@ -0,0 +1,63 @@
+# BancoBrasilPayments::CancelApi
+
+All URIs are relative to *https://api.desenv.bb.com.br/payments-vpn/v3*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**cancelamento_transferencia_lote**](CancelApi.md#cancelamento_transferencia_lote) | **POST** /batch-transfers/cancel | Cancels a request for transfers in batch
+
+# **cancelamento_transferencia_lote**
+> RootTypeForBatchTransfersCancelResponseObject cancelamento_transferencia_lote(bodyauthorizationgw_dev_app_key)
+
+Cancels a request for transfers in batch
+
+Cancela, em lote, solicitações de transferências e de pagamentos boletos e guias, requisitadas através dos recursos: /batch-transfers (POST), /barcode-collection-forms (POST), /payments-vpn/v2/batch-slips (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::CancelApi.new
+body = BancoBrasilPayments::RootTypeForBatchTransfersCancelRequestObject.new # RootTypeForBatchTransfersCancelRequestObject | Objeto de Requisição do recurso Batch Transfers Cancel
+authorization = 'authorization_example' # String | É um “token” de acesso fornecido pelo OAuth 2.0.  Example: Bearer [ACCESS_TOKEN]
+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
+
+
+begin
+  #Cancels a request for transfers in batch
+  result = api_instance.cancelamento_transferencia_lote(bodyauthorizationgw_dev_app_key)
+  p result
+rescue BancoBrasilPayments::ApiError => e
+  puts "Exception when calling CancelApi->cancelamento_transferencia_lote: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**RootTypeForBatchTransfersCancelRequestObject**](RootTypeForBatchTransfersCancelRequestObject.md)| Objeto de Requisição do recurso Batch Transfers Cancel | 
+ **authorization** | **String**| É um “token” de acesso fornecido pelo OAuth 2.0.  Example: Bearer [ACCESS_TOKEN] | 
+ **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 | 
+
+### Return type
+
+[**RootTypeForBatchTransfersCancelResponseObject**](RootTypeForBatchTransfersCancelResponseObject.md)
+
+### Authorization
+
+[OAuth2-CC](../README.md#OAuth2-CC)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/CollectionFormsApi.md

@@ -0,0 +1,184 @@
+# BancoBrasilPayments::CollectionFormsApi
+
+All URIs are relative to *https://api.desenv.bb.com.br/payments-vpn/v3*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**consulta_pagamento_guia_lote**](CollectionFormsApi.md#consulta_pagamento_guia_lote) | **GET** /barcode-collection-forms/{id} | Consulta Pagamentos em Lote de Guias com Código de Barra
+[**envia_pagamento_guias_lote**](CollectionFormsApi.md#envia_pagamento_guias_lote) | **POST** /barcode-collection-forms | Barcode Collection Forms Payment
+[**sondagem_pagamento_guia_lote**](CollectionFormsApi.md#sondagem_pagamento_guia_lote) | **GET** /barcode-collection-forms/{id}/check | Barcode Collection Forms Payment Check
+
+# **consulta_pagamento_guia_lote**
+> BarcodeCollectionFormsIDResponseObject consulta_pagamento_guia_lote(id, authorization, gw_dev_app_key, opts)
+
+Consulta Pagamentos em Lote de Guias com Código de Barra
+
+A partir de um código identificador de pagamento de uma Guia com Código de Barra, retorna os detalhes do pagamento desta, como estado do pagamento, data do pagamento, forma do pagamento, valor, descrição, código de devolução, entre outros.
+
+### 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::CollectionFormsApi.new
+id = 'id_example' # String | Numero controlado pelo cliente para identificar cada acionamento da API e os lançamentos de cada chamada. Não precisa ser sequencial. De uso único.
+authorization = 'authorization_example' # String | É o valor do token de acesso fornecido pelo OAuth. Exemplo: Bearer <acess_token>
+gw_dev_app_key = 'gw_dev_app_key_example' # String | É a chave de acesso do aplicativo do desenvolvedor obtida no Portal do Desenvolvedor. Essa chave será usada para identificação do aplicativo.
+opts = { 
+  agencia: 3.4, # Float | Número da agência da conta corrente de débito do valor total de cada requisição. Quando utilizado o fluxo Client Credentials, esse campo é informado pelo cliente. Quando utilizado o fluxo Authorization Code, essa informação é do token.
+  conta_corrente: 3.4, # Float | Número da conta corrente de débito do valor total de cada requisição. Quando utilizado o fluxo Client Credentials, esse campo é informado pelo cliente. Quando utilizado o fluxo Authorization Code, essa informação é do token.
+  digito_verificador: 'digito_verificador_example' # String | Dígito verificador da conta corrente de débito do valor total de cada requisição. Quando utilizado o fluxo Client Credentials, esse campo é informado pelo cliente. Quando utilizado o fluxo Authorization Code, essa informação é do token.
+}
+
+begin
+  #Consulta Pagamentos em Lote de Guias com Código de Barra
+  result = api_instance.consulta_pagamento_guia_lote(id, authorization, gw_dev_app_key, opts)
+  p result
+rescue BancoBrasilPayments::ApiError => e
+  puts "Exception when calling CollectionFormsApi->consulta_pagamento_guia_lote: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**| Numero controlado pelo cliente para identificar cada acionamento da API e os lançamentos de cada chamada. Não precisa ser sequencial. De uso único. | 
+ **authorization** | **String**| É o valor do token de acesso fornecido pelo OAuth. Exemplo: Bearer &lt;acess_token&gt; | 
+ **gw_dev_app_key** | **String**| É a chave de acesso do aplicativo do desenvolvedor obtida no Portal do Desenvolvedor. Essa chave será usada para identificação do aplicativo. | 
+ **agencia** | **Float**| Número da agência da conta corrente de débito do valor total de cada requisição. Quando utilizado o fluxo Client Credentials, esse campo é informado pelo cliente. Quando utilizado o fluxo Authorization Code, essa informação é do token. | [optional] 
+ **conta_corrente** | **Float**| Número da conta corrente de débito do valor total de cada requisição. Quando utilizado o fluxo Client Credentials, esse campo é informado pelo cliente. Quando utilizado o fluxo Authorization Code, essa informação é do token. | [optional] 
+ **digito_verificador** | **String**| Dígito verificador da conta corrente de débito do valor total de cada requisição. Quando utilizado o fluxo Client Credentials, esse campo é informado pelo cliente. Quando utilizado o fluxo Authorization Code, essa informação é do token. | [optional] 
+
+### Return type
+
+[**BarcodeCollectionFormsIDResponseObject**](BarcodeCollectionFormsIDResponseObject.md)
+
+### Authorization
+
+[OAuth2-CC](../README.md#OAuth2-CC)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **envia_pagamento_guias_lote**
+> InlineResponse2011 envia_pagamento_guias_lote(body)
+
+Barcode Collection Forms Payment
+
+Solicitar pagamento em lote de Guias de Recolhimento com código de barras.
+
+### 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::CollectionFormsApi.new
+body = BancoBrasilPayments::BarcodeCollectionFormsRequestObject.new # BarcodeCollectionFormsRequestObject | Objeto de requisição do recurso de pagamento em lote de Guias com Código de Barras.
+
+
+begin
+  #Barcode Collection Forms Payment
+  result = api_instance.envia_pagamento_guias_lote(body)
+  p result
+rescue BancoBrasilPayments::ApiError => e
+  puts "Exception when calling CollectionFormsApi->envia_pagamento_guias_lote: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**BarcodeCollectionFormsRequestObject**](BarcodeCollectionFormsRequestObject.md)| Objeto de requisição do recurso de pagamento em lote de Guias com Código de Barras. | 
+
+### Return type
+
+[**InlineResponse2011**](InlineResponse2011.md)
+
+### Authorization
+
+[OAuth2-CC](../README.md#OAuth2-CC)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **sondagem_pagamento_guia_lote**
+> InlineResponse2011 sondagem_pagamento_guia_lote(id, gw_dev_app_key, authorization, debit_branch_office, debit_current_account, check_digits_debit_current_account)
+
+Barcode Collection Forms Payment Check
+
+Consultar a resposta de uma solicitação de pagamento em lote de guias de recolhimento com código de barras.
+
+### 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::CollectionFormsApi.new
+id = 'id_example' # String | Identificação da solicitação de pagamento. É um número único, não sequencial, cujo valor vai de 1 a 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.  Example: 0021239456d80136bebf005056891bed
+authorization = 'authorization_example' # String | É um “token” de acesso fornecido pelo OAuth 2.0.  Example: Bearer [ACCESS_TOKEN]
+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.
+
+
+begin
+  #Barcode Collection Forms Payment Check
+  result = api_instance.sondagem_pagamento_guia_lote(id, gw_dev_app_key, authorization, debit_branch_office, debit_current_account, check_digits_debit_current_account)
+  p result
+rescue BancoBrasilPayments::ApiError => e
+  puts "Exception when calling CollectionFormsApi->sondagem_pagamento_guia_lote: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**| Identificação da solicitação de pagamento. É um número único, não sequencial, cujo valor vai de 1 a 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.  Example: 0021239456d80136bebf005056891bed | 
+ **authorization** | **String**| É um “token” de acesso fornecido pelo OAuth 2.0.  Example: Bearer [ACCESS_TOKEN] | 
+ **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. | 
+ **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. | 
+ **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. | 
+
+### Return type
+
+[**InlineResponse2011**](InlineResponse2011.md)
+
+### Authorization
+
+[OAuth2-CC](../README.md#OAuth2-CC)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+

data/docs/Error.md

@@ -0,0 +1,7 @@
+# BancoBrasilPayments::Error
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**errors** | [**Array<ErrorErrors>**](ErrorErrors.md) | Objeto de erro. | [optional] 
+

data/docs/ErrorErrors.md

@@ -0,0 +1,8 @@
+# BancoBrasilPayments::ErrorErrors
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**code** | **String** | Código de erro. | 
+**message** | **String** | Mensagem de erro. | 
+

data/docs/ErrorOAuthUnauthorized.md

@@ -0,0 +1,10 @@
+# BancoBrasilPayments::ErrorOAuthUnauthorized
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**status_code** | [**BigDecimal**](BigDecimal.md) | Código de estado do erro. | 
+**error** | **String** | Tipo de erro. | 
+**message** | **String** | Mensagem de erro. | 
+**attributes** | [**ErrorOAuthUnauthorizedAttributes**](ErrorOAuthUnauthorizedAttributes.md) |  | 
+

data/docs/ErrorOAuthUnauthorizedAttributes.md

@@ -0,0 +1,7 @@
+# BancoBrasilPayments::ErrorOAuthUnauthorizedAttributes
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**error** | **String** | Mensagem de erro. | 
+

data/docs/InlineResponse200.md

@@ -0,0 +1,13 @@
+# BancoBrasilPayments::InlineResponse200
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**next_index** | **String** | O valor desse campo é usado no parâmetro de consulta definido como \"index\" para recuperar a próxima ocorrência de pagamentos. | [optional] 
+**request_status** | **String** | 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] 
+**payment_type** | [**BigDecimal**](BigDecimal.md) | Modalidade que representa o tipo de pagamento, sendo: 126 pagamento de fornecedores; 127 pagamento de salário e 128 pagamentos diversos | [optional] 
+**request_date** | **String** | Data da requisição (formato ddmmaaaa) | [optional] 
+**payments_total_quantity** | **String** | Quantidade total de pagamentos a serem processados em lote. Essa informação não é a quantidade de registros retornados em \"paymentsList\". | [optional] 
+**payments_total_value** | **String** | Valor montante total dos pagamentos a serem processados em lote. Esta informação não é uma soma de valores do campo \"paymentValue\" em \"paymentsList\" (formato 0.00) | [optional] 
+**payments_list** | [**Array<InlineResponse200PaymentsList>**](InlineResponse200PaymentsList.md) | Lista de pagamentos submetidos para processamento em lote. Essa lista pode ser parcial ou total, a depender da seguinte regra: se o valor do campo \"nextIndex\" for menor que o valor do campo \"paymentsTotalQuantity\", então trata-se de lista parcial; caso contrário, trata-se de lista com todos os pagamentos. | [optional] 
+