bb_payments 0.1.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (140) hide show
  1. checksums.yaml +7 -0
  2. data/Gemfile +11 -0
  3. data/Gemfile.lock +82 -0
  4. data/README.md +391 -0
  5. data/Rakefile +8 -0
  6. data/bb_payments.gemspec +30 -0
  7. data/docs/BankSlipsApi.md +178 -0
  8. data/docs/BarcodeCollectionFormsIDResponseObject.md +6 -0
  9. data/docs/BarcodeCollectionFormsIDResponseObjectListaGuiaCodigoBarra.md +10 -0
  10. data/docs/BarcodeCollectionFormsIDResponseObjectListaOcorrencia.md +9 -0
  11. data/docs/BarcodeCollectionFormsRequestObject.md +12 -0
  12. data/docs/BarcodecollectionformsCollectionFormDetailsList.md +12 -0
  13. data/docs/BatchtransfersPaymentsList.md +22 -0
  14. data/docs/BatchtransferscancelPaymentIds.md +7 -0
  15. data/docs/Body.md +13 -0
  16. data/docs/CancelApi.md +63 -0
  17. data/docs/CollectionFormsApi.md +184 -0
  18. data/docs/Error.md +7 -0
  19. data/docs/ErrorErrors.md +8 -0
  20. data/docs/ErrorOAuthUnauthorized.md +10 -0
  21. data/docs/ErrorOAuthUnauthorizedAttributes.md +7 -0
  22. data/docs/InlineResponse200.md +13 -0
  23. data/docs/InlineResponse2001.md +29 -0
  24. data/docs/InlineResponse2001OcurrencesList.md +9 -0
  25. data/docs/InlineResponse2002.md +12 -0
  26. data/docs/InlineResponse2002PaymentsList.md +26 -0
  27. data/docs/InlineResponse2003.md +26 -0
  28. data/docs/InlineResponse2003ListaBoleto.md +24 -0
  29. data/docs/InlineResponse2003ListaDevolucao.md +9 -0
  30. data/docs/InlineResponse200PaymentsList.md +15 -0
  31. data/docs/InlineResponse201.md +13 -0
  32. data/docs/InlineResponse2011.md +13 -0
  33. data/docs/InlineResponse2011PaymentsList.md +16 -0
  34. data/docs/InlineResponse201PaymentsList.md +26 -0
  35. data/docs/InlineResponse400.md +7 -0
  36. data/docs/InlineResponse401.md +10 -0
  37. data/docs/ReturnedsApi.md +78 -0
  38. data/docs/RootTypeForBankSlipList.md +29 -0
  39. data/docs/RootTypeForBankSlipsBatchPayment.md +12 -0
  40. data/docs/RootTypeForBankSlipsBatchPaymentResponseObject.md +12 -0
  41. data/docs/RootTypeForBatchTransferGETResponseObject.md +9 -0
  42. data/docs/RootTypeForBatchTransferPaymentsListGET.md +21 -0
  43. data/docs/RootTypeForBatchTransfersCancelPaymentsListObject.md +10 -0
  44. data/docs/RootTypeForBatchTransfersCancelRequestObject.md +12 -0
  45. data/docs/RootTypeForBatchTransfersCancelResponseObject.md +7 -0
  46. data/docs/RootTypeForReturnedPaymentsDetails.md +33 -0
  47. data/docs/RootTypeForReturnedPaymentsResponseObject.md +10 -0
  48. data/docs/RootTypeForSlipsDetailsObject.md +23 -0
  49. data/docs/TransfersApi.md +309 -0
  50. data/lib/bb_payments/api/base.rb +10 -0
  51. data/lib/bb_payments/api/base_api.rb +63 -0
  52. data/lib/bb_payments/api/batch_payments_api.rb +50 -0
  53. data/lib/bb_payments/api/payments.rb +114 -0
  54. data/lib/bb_payments/api/transfers.rb +33 -0
  55. data/lib/bb_payments/api/transfers_pix.rb +52 -0
  56. data/lib/bb_payments/api_client.rb +414 -0
  57. data/lib/bb_payments/api_error.rb +57 -0
  58. data/lib/bb_payments/configuration.rb +246 -0
  59. data/lib/bb_payments/models/base_model.rb +177 -0
  60. data/lib/bb_payments/models/batch_pix_body.rb +30 -0
  61. data/lib/bb_payments/models/batch_pix_response.rb +69 -0
  62. data/lib/bb_payments/models/batch_transfers_body.rb +30 -0
  63. data/lib/bb_payments/models/batch_transfers_response.rb +64 -0
  64. data/lib/bb_payments/models/batchtransfers_payments_list.rb +362 -0
  65. data/lib/bb_payments/models/batchtransferscancel_payment_ids.rb +212 -0
  66. data/lib/bb_payments/models/body.rb +274 -0
  67. data/lib/bb_payments/models/error.rb +210 -0
  68. data/lib/bb_payments/models/error_errors.rb +227 -0
  69. data/lib/bb_payments/models/error_o_auth_unauthorized.rb +257 -0
  70. data/lib/bb_payments/models/error_o_auth_unauthorized_attributes.rb +213 -0
  71. data/lib/bb_payments/models/find_batch_payment.rb +93 -0
  72. data/lib/bb_payments/models/find_batch_response.rb +71 -0
  73. data/lib/bb_payments/models/inline_response_200.rb +270 -0
  74. data/lib/bb_payments/models/inline_response_200_1.rb +430 -0
  75. data/lib/bb_payments/models/inline_response_200_1_ocurrences_list.rb +227 -0
  76. data/lib/bb_payments/models/inline_response_200_2.rb +260 -0
  77. data/lib/bb_payments/models/inline_response_200_2_payments_list.rb +399 -0
  78. data/lib/bb_payments/models/inline_response_200_3.rb +487 -0
  79. data/lib/bb_payments/models/inline_response_200_3_lista_boleto.rb +377 -0
  80. data/lib/bb_payments/models/inline_response_200_3_lista_devolucao.rb +227 -0
  81. data/lib/bb_payments/models/inline_response_200_payments_list.rb +289 -0
  82. data/lib/bb_payments/models/inline_response_201.rb +270 -0
  83. data/lib/bb_payments/models/inline_response_201_1.rb +270 -0
  84. data/lib/bb_payments/models/inline_response_201_1_payments_list.rb +299 -0
  85. data/lib/bb_payments/models/inline_response_201_payments_list.rb +399 -0
  86. data/lib/bb_payments/models/inline_response_400.rb +210 -0
  87. data/lib/bb_payments/models/inline_response_401.rb +257 -0
  88. data/lib/bb_payments/models/root_type_for_bank_slip_list.rb +430 -0
  89. data/lib/bb_payments/models/root_type_for_bank_slips_batch_payment.rb +270 -0
  90. data/lib/bb_payments/models/root_type_for_bank_slips_batch_payment_response_object.rb +260 -0
  91. data/lib/bb_payments/models/root_type_for_batch_transfer_get_response_object.rb +230 -0
  92. data/lib/bb_payments/models/root_type_for_batch_transfer_payments_list_get.rb +348 -0
  93. data/lib/bb_payments/models/root_type_for_batch_transfers_cancel_payments_list_object.rb +238 -0
  94. data/lib/bb_payments/models/root_type_for_batch_transfers_cancel_request_object.rb +275 -0
  95. data/lib/bb_payments/models/root_type_for_batch_transfers_cancel_response_object.rb +210 -0
  96. data/lib/bb_payments/models/root_type_for_returned_payments_details.rb +468 -0
  97. data/lib/bb_payments/models/root_type_for_returned_payments_response_object.rb +240 -0
  98. data/lib/bb_payments/models/root_type_for_slips_details_object.rb +408 -0
  99. data/lib/bb_payments/models/transfer_base.rb +128 -0
  100. data/lib/bb_payments/models/transfer_pix.rb +34 -0
  101. data/lib/bb_payments/models/transfer_pix_base.rb +146 -0
  102. data/lib/bb_payments/version.rb +3 -0
  103. data/lib/bb_payments.rb +85 -0
  104. data/spec/api/batch_payments_api_spec.rb +113 -0
  105. data/spec/api_client_spec.rb +225 -0
  106. data/spec/base_object_spec.rb +109 -0
  107. data/spec/configuration_spec.rb +41 -0
  108. data/spec/models/body_spec.rb +76 -0
  109. data/spec/models/error_errors_spec.rb +46 -0
  110. data/spec/models/error_o_auth_unauthorized_attributes_spec.rb +40 -0
  111. data/spec/models/error_o_auth_unauthorized_spec.rb +58 -0
  112. data/spec/models/error_spec.rb +40 -0
  113. data/spec/models/inline_response_200_1_ocurrences_list_spec.rb +52 -0
  114. data/spec/models/inline_response_200_1_spec.rb +172 -0
  115. data/spec/models/inline_response_200_2_payments_list_spec.rb +154 -0
  116. data/spec/models/inline_response_200_2_spec.rb +70 -0
  117. data/spec/models/inline_response_200_3_lista_boleto_spec.rb +142 -0
  118. data/spec/models/inline_response_200_3_lista_devolucao_spec.rb +52 -0
  119. data/spec/models/inline_response_200_3_spec.rb +154 -0
  120. data/spec/models/inline_response_200_payments_list_spec.rb +88 -0
  121. data/spec/models/inline_response_200_spec.rb +76 -0
  122. data/spec/models/inline_response_201_1_payments_list_spec.rb +94 -0
  123. data/spec/models/inline_response_201_1_spec.rb +76 -0
  124. data/spec/models/inline_response_201_payments_list_spec.rb +154 -0
  125. data/spec/models/inline_response_201_spec.rb +76 -0
  126. data/spec/models/inline_response_400_spec.rb +40 -0
  127. data/spec/models/inline_response_401_spec.rb +58 -0
  128. data/spec/models/root_type_for_bank_slip_list_spec.rb +172 -0
  129. data/spec/models/root_type_for_bank_slips_batch_payment_response_object_spec.rb +70 -0
  130. data/spec/models/root_type_for_bank_slips_batch_payment_spec.rb +70 -0
  131. data/spec/models/root_type_for_batch_transfer_get_response_object_spec.rb +52 -0
  132. data/spec/models/root_type_for_batch_transfer_payments_list_get_spec.rb +124 -0
  133. data/spec/models/root_type_for_batch_transfers_cancel_payments_list_object_spec.rb +58 -0
  134. data/spec/models/root_type_for_batch_transfers_cancel_request_object_spec.rb +70 -0
  135. data/spec/models/root_type_for_batch_transfers_cancel_response_object_spec.rb +40 -0
  136. data/spec/models/root_type_for_returned_payments_details_spec.rb +196 -0
  137. data/spec/models/root_type_for_returned_payments_response_object_spec.rb +58 -0
  138. data/spec/models/root_type_for_slips_details_object_spec.rb +136 -0
  139. data/spec/spec_helper.rb +110 -0
  140. metadata +292 -0
@@ -0,0 +1,128 @@
1
+ require 'date'
2
+
3
+ module BancoBrasilPayments
4
+ # Representação dos campos de uma solicitação de transferência em lote.
5
+ class TransferBase < BaseModel
6
+
7
+ # Código de identificação da instituição para crédito na câmara de compensação (no Brasil, identificado pela sigla COMPE).
8
+ # 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.
9
+ attr_accessor :clearinghouse_code # numeroCOMPE || integer($int32)
10
+
11
+ # Código identificador do Sistema de Pagamento Brasileiro (Identificado pelo acrônimo ISPB) para crédito.
12
+ # 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.
13
+ attr_accessor :ispb_code # numeroISPB || integer($int32)
14
+
15
+ # Número da agência da conta de crédito do favorecido.
16
+ # Obrigatório caso campo "formaIdentificacao" seja 5, e se campo "contaPagamento" não informado.
17
+ attr_accessor :credit_branch_office # agenciaCredito || integer($int32)
18
+
19
+ # Número da conta de crédito do favorecido.
20
+ # Obrigatório caso campo "formaIdentificacao" seja 5, e se campo "contaPagamento" não informado.
21
+ attr_accessor :credit_current_account # contaCorrenteCredito || integer($int64)
22
+
23
+ # Dígito verificador da agência da conta de crédito do favorecido.
24
+ # Obrigatório caso campo "formaIdentificacao" seja 5, e se campo "contaPagamento" não informado.
25
+ attr_accessor :check_digits_credit_current_account # digitoVerificadorContaCorrente || string maxLength: 1
26
+
27
+ # Número da conta pagamento do favorecido.
28
+ # Obrigatório caso campo "formaIdentificacao" seja 5, e caso os campos "agencia", "conta" e "digitoVerificadorContaCorrente" não sejam informados.
29
+ attr_accessor :credit_payment_account # contaPagamentoCredito || string maxLength: 20
30
+
31
+ # Número do CPF junto à Receita Federal. Não informado quando diz respeito ao pagamento de contribuinte do tipo pessoa jurídica.
32
+ attr_accessor :individual_taxpayer_registration # cpfBeneficiario || integer($int64)
33
+
34
+ # Número do CNPJ junto à Receita Federal. Não informado quando diz respeito ao pagamento de contribuinte do tipo pessoa física.
35
+ attr_accessor :corporate_taxpayer_registration # cnpjBeneficiario || integer($int64)
36
+
37
+ # Data em que deverá ser efetuada a transferência para o favorecido. Formato: ddmmaaaa.
38
+ # Zero no início de numérico deve ser omitido.
39
+ attr_accessor :payment_date # dataTransferencia || integer($int32) || example: 5112020
40
+
41
+ # Valor do pagamento em reais (formato 0.00)
42
+ attr_accessor :payment_value # valorTransferencia || number($double)
43
+
44
+ # Documento de débito que será mostrado no extrato da conta do pagador.
45
+ # 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.
46
+ # De igual modo será se o mesmo número for informado para todos os lançamentos de crédito.
47
+ # Quando números diferentes forem informados para cada lançamento, os lançamentos de débitos serão individualizados.
48
+ attr_accessor :debit_document # documentoDebito || x-oad-type: integer
49
+
50
+ # Número do documento de crédito exibido no extrato do favorecido - uso exclusivo para Crédito em conta corrente no BB.
51
+ attr_accessor :credit_document # documentoCredito || integer($int64)
52
+
53
+ # Código de finalidade informado quando se trata de DOC. Uma lista de códigos permitidos é obtida na
54
+ # Federação Brasileira de Bancos (identificada pela sigla FEBRABAN). Por exemplo, 1 para Crédito em Conta Corrente;
55
+ # 11 para DOC em Conta Poupança; 12 para DOC em Conta de Depósito Judicial.
56
+ attr_accessor :credit_order_purpose_code
57
+
58
+ # Código de finalidade informado quando se trata de TED. Uma lista de códigos permitidos é obtida no
59
+ # Banco Central do Brasil (Identificado pelo acrônimo BACEN).
60
+ attr_accessor :wire_transfer_purpose_code
61
+
62
+ # Identificador informado quando se trata de depósito judicial. Insira valor 1 para o campo COMPE ou valor 0 para
63
+ # o campo ISPB. Se esse campo estiver preenchido, os campos creditBranchOffice, creditCurrentAccount,
64
+ # checkDigitsCreditCurrentAccount e creditPaymentAccount não deverão ser inseridos.
65
+ attr_accessor :deposit_in_court_identifier
66
+
67
+ # Campo de uso livre pelo cliente conveniado - sem tratamento pelo Banco.
68
+ attr_accessor :payment_description # descricaoTransferencia || string maxLength: 40
69
+
70
+ # Attribute mapping from ruby-style variable name to JSON key.
71
+ def self.attribute_map
72
+ {
73
+ clearinghouse_code: :numeroCOMPE,
74
+ ispb_code: :numeroISPB,
75
+ payment_date: :dataTransferencia,
76
+ payment_value: :valorTransferencia,
77
+ debit_document: :documentoDebito,
78
+ credit_document: :documentoCredito,
79
+ payment_description: :descricaoTransferencia,
80
+ individual_taxpayer_registration: :cpfBeneficiario,
81
+ corporate_taxpayer_registration: :cnpjBeneficiario,
82
+ credit_branch_office: :agenciaCredito,
83
+ credit_current_account: :contaCorrenteCredito,
84
+ check_digits_credit_current_account: :digitoVerificadorContaCorrente,
85
+ credit_payment_account: :contaPagamentoCredito,
86
+ credit_order_purpose_code: :codigoFinalidadeDOC,
87
+ wire_transfer_purpose_code: :codigoFinalidadeTED,
88
+ deposit_in_court_identifier: :numeroDepositoJudicial
89
+ }
90
+ end
91
+
92
+ # Attribute type mapping.
93
+ def self.openapi_types
94
+ {
95
+ payment_date: :Integer,
96
+ payment_value: :Float,
97
+ debit_document: :Integer,
98
+ credit_document: :Integer,
99
+ payment_description: :String,
100
+ individual_taxpayer_registration: :Integer,
101
+ corporate_taxpayer_registration: :Integer,
102
+ clearinghouse_code: :Integer,
103
+ ispb_code: :Integer,
104
+ credit_branch_office: :Integer,
105
+ credit_current_account: :Integer,
106
+ check_digits_credit_current_account: :String,
107
+ credit_payment_account: :String,
108
+ credit_order_purpose_code: :Integer,
109
+ wire_transfer_purpose_code: :Integer,
110
+ deposit_in_court_identifier: :String
111
+ }
112
+ end
113
+
114
+ # Show invalid properties with the reasons. Usually used together with valid?
115
+ # @return Array for valid properties with the reasons
116
+ # TODO: add remaining constraints
117
+ def list_invalid_properties
118
+ invalid_properties = Array.new
119
+ %i[payment_date payment_value].each do |attr|
120
+ next if send(attr).present?
121
+
122
+ invalid_properties.push("invalid value for '#{attr}': cannot be nil.")
123
+ end
124
+
125
+ invalid_properties
126
+ end
127
+ end
128
+ end
@@ -0,0 +1,34 @@
1
+ require 'date'
2
+
3
+ module BancoBrasilPayments
4
+ # Representação dos campos de uma solicitação de transferência em lote.
5
+ class TransferPix < TransferPixBase
6
+
7
+ # Número único gerado pelo Banco. Poderá ser utilizado pelo cliente conveniado para consultas o lançamento.
8
+ attr_accessor :payment_id # identificadorPagamento || integer($int64)
9
+
10
+ # Indicador de validação do preenchimento dos campos de cada lançamento.
11
+ # Domínio: S - Sim (Indica que os dados foram informados conforme regra de preenchimento) N - Não (Indica que os dados não foram informados conforme regra de preenchimento)
12
+ # Quando não aceito, cliente conveniado deverá observar o significado dos códigos de erro presentes no campo "erros".
13
+ # Após corrigidos, o cliente conveniado poderá enviar o lançamento novamente em nova requisição de pagamento em lotes.
14
+ attr_accessor :payment_accepted # indicadorMovimentoAceito || string maxLength: 1
15
+
16
+ # Lista dos códigos de erro a serem verificados para correção dos dados.
17
+ # Essa lista virá preenchida com até 10 códigos quando campo "indicadorMovimentoAceito" for igual a "N".
18
+ attr_accessor :errors # erros || array
19
+
20
+ # Attribute mapping from ruby-style variable name to JSON key.
21
+ def self.attribute_map
22
+ { payment_id: :identificadorPagamento,
23
+ payment_accepted: :indicadorMovimentoAceito,
24
+ errors: :erros }.merge super
25
+ end
26
+
27
+ # Attribute type mapping.
28
+ def self.openapi_types
29
+ { payment_id: :Integer,
30
+ payment_accepted: :String,
31
+ errors: :Object }.merge super
32
+ end
33
+ end
34
+ end
@@ -0,0 +1,146 @@
1
+ require 'date'
2
+
3
+ module BancoBrasilPayments
4
+ # Representação dos campos de uma solicitação de transferência em lote.
5
+ class TransferPixBase < BaseModel
6
+
7
+ # Data em que deverá ser efetuada a transferência para o favorecido. Formato: ddmmaaaa.
8
+ # Zero no início de numérico deve ser omitido.
9
+ attr_accessor :payment_date # data || integer($int32) || example: 5112020
10
+
11
+ # Valor do pagamento em reais (formato 0.00)
12
+ attr_accessor :payment_value # valor || number($double)
13
+
14
+ # Documento de débito que será mostrado no extrato da conta do pagador.
15
+ # 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.
16
+ # De igual modo será se o mesmo número for informado para todos os lançamentos de crédito.
17
+ # Quando números diferentes forem informados para cada lançamento, os lançamentos de débitos serão individualizados.
18
+ attr_accessor :debit_document # documentoDebito || x-oad-type: integer
19
+
20
+ # Número do documento de crédito exibido no extrato do favorecido - uso exclusivo para Crédito em conta corrente no BB.
21
+ attr_accessor :credit_document # documentoCredito || integer($int64)
22
+
23
+ # Campo de uso livre pelo cliente conveniado - sem tratamento pelo Banco.
24
+ attr_accessor :payment_description # descricaoPagamento || string maxLength: 40
25
+
26
+ # Descrição do pagamento instantâneo para fins de conciliação do próprio cliente. Campo de uso livre pelo cliente conveniado - sem tratamento pelo Banco.
27
+ attr_accessor :instantaneous_payment_description # descricaoPagamentoInstantaneo || string maxLength: 35
28
+
29
+ # Código da forma de identificação da conta transacional, a fim de que a transferência seja feita por meio da utilização de chaves ou apelidos.
30
+ # Domínio: 1 - Chave Pix tipo Telefone 2 - Chave Pix tipo Email 3 - Chave Pix tipo CPF/CNPJ 4 - Chave Aleatória 5 - Dados Bancários
31
+ attr_accessor :key_type # formaIdentificacao || integer($int32)
32
+
33
+ # Número de Discagem Direta à Distancia (DDD) do telefone do favorecido do crédito.
34
+ # Obrigatório caso campo "formaIdentificacao" seja 1.
35
+ attr_accessor :phone_area_code # dddTelefone || integer($int32)
36
+
37
+ # Número do telefone do favorecido do crédito. Obrigatório caso campo "formaIdentificacao" seja 1.
38
+ attr_accessor :phone # telefone || integer($int32)
39
+
40
+ # Email do favorecido do crédito. Obrigatório caso campo "formaIdentificacao" seja 2.
41
+ attr_accessor :email # email || string maxLength: 99
42
+
43
+ # Número do CPF junto à Receita Federal. Não informado quando diz respeito ao pagamento de contribuinte do tipo pessoa jurídica.
44
+ attr_accessor :individual_taxpayer_registration # cpf || integer($int64)
45
+
46
+ # Número do CNPJ junto à Receita Federal. Não informado quando diz respeito ao pagamento de contribuinte do tipo pessoa física.
47
+ attr_accessor :corporate_taxpayer_registration # cnpj || integer($int64)
48
+
49
+ # Código de identificação Aleatória do favorecido do crédito.
50
+ # Obrigatório caso campo "formaIdentificacao" seja 4.
51
+ attr_accessor :random_key # identificacaoAleatoria || string maxLength: 99
52
+
53
+ # Código de identificação da instituição para crédito na câmara de compensação (no Brasil, identificado pela sigla COMPE).
54
+ # 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.
55
+ attr_accessor :clearinghouse_code # numeroCOMPE || integer($int32)
56
+
57
+ # Código identificador do Sistema de Pagamento Brasileiro (Identificado pelo acrônimo ISPB) para crédito.
58
+ # 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.
59
+ attr_accessor :ispb_code # numeroISPB || integer($int32)
60
+
61
+ # Codigo do tipo de conta de crédito do favorecido. Domínio: 1 - Conta Corrente 2 - Conta Pagamento 3 - Conta Poupança
62
+ attr_accessor :credit_account_kind # tipoConta || integer($int32)
63
+
64
+ # Número da agência da conta de crédito do favorecido.
65
+ # Obrigatório caso campo "formaIdentificacao" seja 5, e se campo "contaPagamento" não informado.
66
+ attr_accessor :credit_branch_office # agencia || integer($int32)
67
+
68
+ # Número da conta de crédito do favorecido.
69
+ # Obrigatório caso campo "formaIdentificacao" seja 5, e se campo "contaPagamento" não informado.
70
+ attr_accessor :credit_current_account # conta || integer($int64)
71
+
72
+ # Dígito verificador da agência da conta de crédito do favorecido.
73
+ # Obrigatório caso campo "formaIdentificacao" seja 5, e se campo "contaPagamento" não informado.
74
+ attr_accessor :check_digits_credit_current_account # digitoVerificadorConta || string maxLength: 1
75
+
76
+ # Número da conta pagamento do favorecido.
77
+ # Obrigatório caso campo "formaIdentificacao" seja 5, e caso os campos "agencia", "conta" e "digitoVerificadorConta" não sejam informados.
78
+ attr_accessor :credit_payment_account # contaPagamento || string maxLength: 20
79
+
80
+ # Attribute mapping from ruby-style variable name to JSON key.
81
+ def self.attribute_map
82
+ {
83
+ payment_date: :data,
84
+ payment_value: :valor,
85
+ debit_document: :documentoDebito,
86
+ credit_document: :documentoCredito,
87
+ payment_description: :descricaoPagamento,
88
+ instantaneous_payment_description: :descricaoPagamentoInstantaneo,
89
+ key_type: :formaIdentificacao,
90
+ phone_area_code: :dddTelefone,
91
+ phone: :telefone,
92
+ email: :email,
93
+ individual_taxpayer_registration: :cpf,
94
+ corporate_taxpayer_registration: :cnpj,
95
+ random_key: :identificacaoAleatoria,
96
+ clearinghouse_code: :numeroCOMPE,
97
+ ispb_code: :numeroISPB,
98
+ credit_account_kind: :tipoConta,
99
+ credit_branch_office: :agencia,
100
+ credit_current_account: :conta,
101
+ check_digits_credit_current_account: :digitoVerificadorConta,
102
+ credit_payment_account: :contaPagamento,
103
+ }
104
+ end
105
+
106
+ # Attribute type mapping.
107
+ def self.openapi_types
108
+ {
109
+ payment_date: :Integer,
110
+ payment_value: :Float,
111
+ debit_document: :Integer,
112
+ credit_document: :Integer,
113
+ payment_description: :String,
114
+ instantaneous_payment_description: :String,
115
+ key_type: :Integer,
116
+ phone_area_code: :Integer,
117
+ phone: :Integer,
118
+ email: :String,
119
+ individual_taxpayer_registration: :Integer,
120
+ corporate_taxpayer_registration: :Integer,
121
+ random_key: :String,
122
+ clearinghouse_code: :Integer,
123
+ ispb_code: :Integer,
124
+ credit_account_kind: :Integer,
125
+ credit_branch_office: :Integer,
126
+ credit_current_account: :Integer,
127
+ check_digits_credit_current_account: :String,
128
+ credit_payment_account: :String,
129
+ }
130
+ end
131
+
132
+ # Show invalid properties with the reasons. Usually used together with valid?
133
+ # @return Array for valid properties with the reasons
134
+ # TODO: add remaining constraints
135
+ def list_invalid_properties
136
+ invalid_properties = Array.new
137
+ %i[payment_date payment_value key_type].each do |attr|
138
+ next if send(attr).present?
139
+
140
+ invalid_properties.push("invalid value for '#{attr}': cannot be nil.")
141
+ end
142
+
143
+ invalid_properties
144
+ end
145
+ end
146
+ end
@@ -0,0 +1,3 @@
1
+ module BancoBrasilPayments
2
+ VERSION = '0.1.1'
3
+ end
@@ -0,0 +1,85 @@
1
+ =begin
2
+ #Payments-VPN
3
+
4
+ #Esta API fornece os serviços de pagamento do Banco do Brasil.
5
+
6
+ OpenAPI spec version: 3.5
7
+
8
+ Generated by: https://github.com/swagger-api/swagger-codegen.git
9
+ Swagger Codegen version: 3.0.24
10
+ =end
11
+
12
+ # Common files
13
+ require 'bb_oauth'
14
+ require 'bb_payments/api_client'
15
+ require 'bb_payments/api_error'
16
+ require 'bb_payments/version'
17
+ require 'bb_payments/configuration'
18
+
19
+ # Models
20
+ require 'bb_payments/models/base_model'
21
+ require 'bb_payments/models/body'
22
+ require 'bb_payments/models/batch_pix_body'
23
+ require 'bb_payments/models/transfer_pix_base'
24
+ require 'bb_payments/models/transfer_pix'
25
+ require 'bb_payments/models/batch_pix_response'
26
+ require 'bb_payments/models/batch_transfers_body'
27
+ require 'bb_payments/models/batch_transfers_response'
28
+ require 'bb_payments/models/transfer_base'
29
+ require 'bb_payments/models/find_batch_payment.rb'
30
+ require 'bb_payments/models/find_batch_response.rb'
31
+ require 'bb_payments/models/error'
32
+ require 'bb_payments/models/error_errors'
33
+ require 'bb_payments/models/error_o_auth_unauthorized'
34
+ require 'bb_payments/models/error_o_auth_unauthorized_attributes'
35
+ require 'bb_payments/models/inline_response_200'
36
+ require 'bb_payments/models/inline_response_200_1'
37
+ require 'bb_payments/models/inline_response_200_1_ocurrences_list'
38
+ require 'bb_payments/models/inline_response_200_2'
39
+ require 'bb_payments/models/inline_response_200_2_payments_list'
40
+ require 'bb_payments/models/inline_response_200_3'
41
+ require 'bb_payments/models/inline_response_200_3_lista_boleto'
42
+ require 'bb_payments/models/inline_response_200_3_lista_devolucao'
43
+ require 'bb_payments/models/inline_response_200_payments_list'
44
+ require 'bb_payments/models/inline_response_201'
45
+ require 'bb_payments/models/inline_response_201_1'
46
+ require 'bb_payments/models/inline_response_201_1_payments_list'
47
+ require 'bb_payments/models/inline_response_201_payments_list'
48
+ require 'bb_payments/models/inline_response_400'
49
+ require 'bb_payments/models/inline_response_401'
50
+ require 'bb_payments/models/root_type_for_bank_slip_list'
51
+ require 'bb_payments/models/root_type_for_bank_slips_batch_payment'
52
+ require 'bb_payments/models/root_type_for_bank_slips_batch_payment_response_object'
53
+ require 'bb_payments/models/root_type_for_batch_transfer_get_response_object'
54
+ require 'bb_payments/models/root_type_for_batch_transfer_payments_list_get'
55
+ require 'bb_payments/models/root_type_for_batch_transfers_cancel_payments_list_object'
56
+ require 'bb_payments/models/root_type_for_batch_transfers_cancel_request_object'
57
+ require 'bb_payments/models/root_type_for_batch_transfers_cancel_response_object'
58
+ require 'bb_payments/models/root_type_for_returned_payments_details'
59
+ require 'bb_payments/models/root_type_for_returned_payments_response_object'
60
+ require 'bb_payments/models/root_type_for_slips_details_object'
61
+
62
+ # APIs
63
+ require 'bb_payments/api/base_api'
64
+ require 'bb_payments/api/transfers'
65
+ require 'bb_payments/api/transfers_pix'
66
+ require 'bb_payments/api/payments'
67
+ require 'bb_payments/api/batch_payments_api'
68
+
69
+ module BancoBrasilPayments
70
+ class << self
71
+ # Customize default settings for the SDK using block.
72
+ # BancoBrasilPayments.configure do |config|
73
+ # config.username = "xxx"
74
+ # config.password = "xxx"
75
+ # end
76
+ # If no block given, return the default Configuration object.
77
+ def configure
78
+ if block_given?
79
+ yield(Configuration.default)
80
+ else
81
+ Configuration.default
82
+ end
83
+ end
84
+ end
85
+ end
@@ -0,0 +1,113 @@
1
+ =begin
2
+ #Payments-VPN
3
+
4
+ #Esta API fornece os serviços de pagamento do Banco do Brasil.
5
+
6
+ OpenAPI spec version: 3.5
7
+
8
+ Generated by: https://github.com/swagger-api/swagger-codegen.git
9
+ Swagger Codegen version: 3.0.24
10
+ =end
11
+
12
+ require 'spec_helper'
13
+ require 'json'
14
+
15
+ # Unit tests for BancoBrasilPayments::BatchPaymentsApi
16
+ # Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
17
+ # Please update as you see appropriate
18
+ describe 'BatchPaymentsApi' do
19
+ before do
20
+ # run before each test
21
+ @instance = BancoBrasilPayments::BatchPaymentsApi.new
22
+ end
23
+
24
+ after do
25
+ # run after each test
26
+ end
27
+
28
+ describe 'test an instance of BatchPaymentsApi' do
29
+ it 'should create an instance of BatchPaymentsApi' do
30
+ expect(@instance).to be_instance_of(BancoBrasilPayments::BatchPaymentsApi)
31
+ end
32
+ end
33
+
34
+ # unit tests for consula_pagamento_transferencias_lote
35
+ # Retrieval of detailed infomation of a specific payment
36
+ # Recupera detalhes de uma transferência específica enviada enviada pela solicitação ao recurso /batch-transfers (POST)
37
+ # @param id Identificação de um pagamento específico para um beneficiário. NÃO é o valor do campo requestIdentification do recurso \&quot;Solicitação para transferências em lote\&quot;, mas o campo paymentId na matriz paymentsList do recurso \&quot;Recuperação de transferências em lote\&quot;.
38
+ # @param gw_dev_app_key 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.
39
+ # @param authorization É um “token” de acesso fornecido pelo OAuth 2.0.
40
+ # @param [Hash] opts the optional parameters
41
+ # @return [InlineResponse2001]
42
+ describe 'consula_pagamento_transferencias_lote test' do
43
+ it 'should work' do
44
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
45
+ end
46
+ end
47
+
48
+ # unit tests for consulta_transferencia_lote
49
+ # Retrieval from transfers in batch
50
+ # 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.
51
+ # @param id Identificador da requisição de pagamento. Número único, não sequencial, com domínio entre 1 e 999999999.
52
+ # @param gw_dev_app_key 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.
53
+ # @param authorization É um “token” de acesso fornecido pelo OAuth 2.0.
54
+ # @param [Hash] opts the optional parameters
55
+ # @option opts [BigDecimal] :index 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.
56
+ # @return [InlineResponse200]
57
+ describe 'consulta_transferencia_lote test' do
58
+ it 'should work' do
59
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
60
+ end
61
+ end
62
+
63
+ # unit tests for envia_transferencias_lote
64
+ # Request for transfers in batch
65
+ # 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)
66
+ # @param body
67
+ # @param authorization É um \&quot;token\&quot; de acesso fornecido pelo OAuth 2.0.
68
+ # @param gw_dev_app_key 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.
69
+ # @param [Hash] opts the optional parameters
70
+ # @return [InlineResponse201]
71
+ describe 'envia_transferencias_lote test' do
72
+ it 'should work' do
73
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
74
+ end
75
+ end
76
+
77
+ # unit tests for lista_transferencias_lote
78
+ # List of transfers in batch
79
+ # Retorna uma lista de lotes de pagamentos.
80
+ # @param gw_dev_app_key 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
81
+ # @param authorization É um “token” de acesso fornecido pelo OAuth 2.0. Example: Bearer [ACCESS_TOKEN]
82
+ # @param start_date Data inicial de envio da requisição a ser pesquisada (formato: ddmmaaaa)
83
+ # @param end_date Data final de envio da requisição a ser pesquisada (formato: ddmmaaaa)
84
+ # @param [Hash] opts the optional parameters
85
+ # @option opts [Integer] :payment_contract 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.
86
+ # @option opts [Integer] :debit_branch_office 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.
87
+ # @option opts [Integer] :debit_current_account Conta corrente de débito. Não é necessário quando a solicitação é acessada pelo código de autorização no fluxo do OAuth.
88
+ # @option opts [String] :check_digits_debit_current_account 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.
89
+ # @option opts [Integer] :payment_type 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.
90
+ # @option opts [Integer] :request_status 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.
91
+ # @option opts [Integer] :index 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
92
+ # @return [RootTypeForBatchTransferGETResponseObject]
93
+ describe 'lista_transferencias_lote test' do
94
+ it 'should work' do
95
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
96
+ end
97
+ end
98
+
99
+ # unit tests for sondagem_transferencia_lote
100
+ # Checks a transfers in batch request
101
+ # 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.
102
+ # @param id Identificador da requisição de pagamento. Número único, não sequencial, controlado pelo cliente, com domínio entre 1 e 999999999.
103
+ # @param gw_dev_app_key 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.
104
+ # @param authorization É um “token” de acesso fornecido pelo OAuth 2.0.
105
+ # @param [Hash] opts the optional parameters
106
+ # @return [InlineResponse2002]
107
+ describe 'sondagem_transferencia_lote test' do
108
+ it 'should work' do
109
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
110
+ end
111
+ end
112
+
113
+ end