Class: BancoBrasilPayments::TransferBase

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/bb_payments/models/transfer_base.rb

Overview

Representação dos campos de uma solicitação de transferência em lote.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#==, #_deserialize, #_to_hash, #build_from_hash, build_from_hash, #eql?, #hash, #initialize, openapi_nullable, #to_body, #to_hash, #to_s, #valid?

Constructor Details

This class inherits a constructor from BancoBrasilPayments::BaseModel

Instance Attribute Details

#check_digits_credit_current_account ⇒ Object

Dígito verificador da agência da conta de crédito do favorecido. Obrigatório caso campo “formaIdentificacao” seja 5, e se campo “contaPagamento” não informado.



25
26
27
 
# File 'lib/bb_payments/models/transfer_base.rb', line 25

def 
  @check_digits_credit_current_account
end

#clearinghouse_code ⇒ Object

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.



9
10
11
 
# File 'lib/bb_payments/models/transfer_base.rb', line 9

def clearinghouse_code
  @clearinghouse_code
end

#corporate_taxpayer_registration ⇒ Object

Número do CNPJ junto à Receita Federal. Não informado quando diz respeito ao pagamento de contribuinte do tipo pessoa física.



35
36
37
 
# File 'lib/bb_payments/models/transfer_base.rb', line 35

def corporate_taxpayer_registration
  @corporate_taxpayer_registration
end

#credit_branch_office ⇒ Object

Número da agência da conta de crédito do favorecido. Obrigatório caso campo “formaIdentificacao” seja 5, e se campo “contaPagamento” não informado.



17
18
19
 
# File 'lib/bb_payments/models/transfer_base.rb', line 17

def credit_branch_office
  @credit_branch_office
end

#credit_current_account ⇒ Object

Número da conta de crédito do favorecido. Obrigatório caso campo “formaIdentificacao” seja 5, e se campo “contaPagamento” não informado.



21
22
23
 
# File 'lib/bb_payments/models/transfer_base.rb', line 21

def 
  @credit_current_account
end

#credit_document ⇒ Object

Número do documento de crédito exibido no extrato do favorecido - uso exclusivo para Crédito em conta corrente no BB.



51
52
53
 
# File 'lib/bb_payments/models/transfer_base.rb', line 51

def credit_document
  @credit_document
end

#credit_order_purpose_code ⇒ Object

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.



56
57
58
 
# File 'lib/bb_payments/models/transfer_base.rb', line 56

def credit_order_purpose_code
  @credit_order_purpose_code
end

#credit_payment_account ⇒ Object

Número da conta pagamento do favorecido. Obrigatório caso campo “formaIdentificacao” seja 5, e caso os campos “agencia”, “conta” e “digitoVerificadorContaCorrente” não sejam informados.



29
30
31
 
# File 'lib/bb_payments/models/transfer_base.rb', line 29

def 
  @credit_payment_account
end

#debit_document ⇒ Object

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.



48
49
50
 
# File 'lib/bb_payments/models/transfer_base.rb', line 48

def debit_document
  @debit_document
end

#deposit_in_court_identifier ⇒ Object

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.



65
66
67
 
# File 'lib/bb_payments/models/transfer_base.rb', line 65

def deposit_in_court_identifier
  @deposit_in_court_identifier
end

#individual_taxpayer_registration ⇒ Object

Número do CPF junto à Receita Federal. Não informado quando diz respeito ao pagamento de contribuinte do tipo pessoa jurídica.



32
33
34
 
# File 'lib/bb_payments/models/transfer_base.rb', line 32

def individual_taxpayer_registration
  @individual_taxpayer_registration
end

#ispb_code ⇒ Object

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.



13
14
15
 
# File 'lib/bb_payments/models/transfer_base.rb', line 13

def ispb_code
  @ispb_code
end

#payment_date ⇒ Object

Data em que deverá ser efetuada a transferência para o favorecido. Formato: ddmmaaaa. Zero no início de numérico deve ser omitido.



39
40
41
 
# File 'lib/bb_payments/models/transfer_base.rb', line 39

def payment_date
  @payment_date
end

#payment_description ⇒ Object

Campo de uso livre pelo cliente conveniado - sem tratamento pelo Banco.



68
69
70
 
# File 'lib/bb_payments/models/transfer_base.rb', line 68

def payment_description
  @payment_description
end

#payment_value ⇒ Object

Valor do pagamento em reais (formato 0.00)



42
43
44
 
# File 'lib/bb_payments/models/transfer_base.rb', line 42

def payment_value
  @payment_value
end

#wire_transfer_purpose_code ⇒ Object

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).



60
61
62
 
# File 'lib/bb_payments/models/transfer_base.rb', line 60

def wire_transfer_purpose_code
  @wire_transfer_purpose_code
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/bb_payments/models/transfer_base.rb', line 71

def self.attribute_map
  {
    clearinghouse_code: :numeroCOMPE,
    ispb_code: :numeroISPB,
    payment_date: :dataTransferencia,
    payment_value: :valorTransferencia,
    debit_document: :documentoDebito,
    credit_document: :documentoCredito,
    payment_description: :descricaoTransferencia,
    individual_taxpayer_registration: :cpfBeneficiario,
    corporate_taxpayer_registration: :cnpjBeneficiario,
    credit_branch_office: :agenciaCredito,
    credit_current_account: :contaCorrenteCredito,
    check_digits_credit_current_account: :digitoVerificadorContaCorrente,
    credit_payment_account: :contaPagamentoCredito,
    credit_order_purpose_code: :codigoFinalidadeDOC,
    wire_transfer_purpose_code: :codigoFinalidadeTED,
    deposit_in_court_identifier: :numeroDepositoJudicial
  }
end

.openapi_types ⇒ Object

Attribute type mapping.



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
 
# File 'lib/bb_payments/models/transfer_base.rb', line 93

def self.openapi_types
  {
    payment_date: :Integer,
    payment_value: :Float,
    debit_document: :Integer,
    credit_document: :Integer,
    payment_description: :String,
    individual_taxpayer_registration: :Integer,
    corporate_taxpayer_registration: :Integer,
    clearinghouse_code: :Integer,
    ispb_code: :Integer,
    credit_branch_office: :Integer,
    credit_current_account: :Integer,
    check_digits_credit_current_account: :String,
    credit_payment_account: :String,
    credit_order_purpose_code: :Integer,
    wire_transfer_purpose_code: :Integer,
    deposit_in_court_identifier: :String
  }
end

Instance Method Details

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid? TODO: add remaining constraints

Returns:

  • Array for valid properties with the reasons



117
118
119
120
121
122
123
124
125
126
 
# File 'lib/bb_payments/models/transfer_base.rb', line 117

def list_invalid_properties
  invalid_properties = Array.new
  %i[payment_date payment_value].each do |attr|
    next if send(attr).present?

    invalid_properties.push("invalid value for '#{attr}': cannot be nil.")
  end

  invalid_properties
end