Class: BancoBrasilPayments::TransferPixBase

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

Overview

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

Direct Known Subclasses

TransferPix

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.



74
75
76
 
# File 'lib/bb_payments/models/transfer_pix_base.rb', line 74

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.



55
56
57
 
# File 'lib/bb_payments/models/transfer_pix_base.rb', line 55

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.



47
48
49
 
# File 'lib/bb_payments/models/transfer_pix_base.rb', line 47

def corporate_taxpayer_registration
  @corporate_taxpayer_registration
end

#credit_account_kind ⇒ Object

Codigo do tipo de conta de crédito do favorecido. Domínio: 1 - Conta Corrente 2 - Conta Pagamento 3 - Conta Poupança



62
63
64
 
# File 'lib/bb_payments/models/transfer_pix_base.rb', line 62

def 
  @credit_account_kind
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.



66
67
68
 
# File 'lib/bb_payments/models/transfer_pix_base.rb', line 66

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.



70
71
72
 
# File 'lib/bb_payments/models/transfer_pix_base.rb', line 70

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.



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

def credit_document
  @credit_document
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 “digitoVerificadorConta” não sejam informados.



78
79
80
 
# File 'lib/bb_payments/models/transfer_pix_base.rb', line 78

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.



18
19
20
 
# File 'lib/bb_payments/models/transfer_pix_base.rb', line 18

def debit_document
  @debit_document
end

#email ⇒ Object

Email do favorecido do crédito. Obrigatório caso campo “formaIdentificacao” seja 2.



41
42
43
 
# File 'lib/bb_payments/models/transfer_pix_base.rb', line 41

def email
  @email
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.



44
45
46
 
# File 'lib/bb_payments/models/transfer_pix_base.rb', line 44

def individual_taxpayer_registration
  @individual_taxpayer_registration
end

#instantaneous_payment_description ⇒ Object

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
28
29
 
# File 'lib/bb_payments/models/transfer_pix_base.rb', line 27

def instantaneous_payment_description
  @instantaneous_payment_description
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.



59
60
61
 
# File 'lib/bb_payments/models/transfer_pix_base.rb', line 59

def ispb_code
  @ispb_code
end

#key_type ⇒ Object

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. 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
32
33
 
# File 'lib/bb_payments/models/transfer_pix_base.rb', line 31

def key_type
  @key_type
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.



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

def payment_date
  @payment_date
end

#payment_description ⇒ Object

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



24
25
26
 
# File 'lib/bb_payments/models/transfer_pix_base.rb', line 24

def payment_description
  @payment_description
end

#payment_value ⇒ Object

Valor do pagamento em reais (formato 0.00)



12
13
14
 
# File 'lib/bb_payments/models/transfer_pix_base.rb', line 12

def payment_value
  @payment_value
end

#phone ⇒ Object

Número do telefone do favorecido do crédito. Obrigatório caso campo “formaIdentificacao” seja 1.



38
39
40
 
# File 'lib/bb_payments/models/transfer_pix_base.rb', line 38

def phone
  @phone
end

#phone_area_code ⇒ Object

Número de Discagem Direta à Distancia (DDD) do telefone do favorecido do crédito. Obrigatório caso campo “formaIdentificacao” seja 1.



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

def phone_area_code
  @phone_area_code
end

#random_key ⇒ Object

Código de identificação Aleatória do favorecido do crédito. Obrigatório caso campo “formaIdentificacao” seja 4.



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

def random_key
  @random_key
end

Class Method Details

.attribute_map ⇒ Object

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



81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/bb_payments/models/transfer_pix_base.rb', line 81

def self.attribute_map
  {
    payment_date: :data,
    payment_value: :valor,
    debit_document: :documentoDebito,
    credit_document: :documentoCredito,
    payment_description: :descricaoPagamento,
    instantaneous_payment_description: :descricaoPagamentoInstantaneo,
    key_type: :formaIdentificacao,
    phone_area_code: :dddTelefone,
    phone: :telefone,
    email: :email,
    individual_taxpayer_registration: :cpf,
    corporate_taxpayer_registration: :cnpj,
    random_key: :identificacaoAleatoria,
    clearinghouse_code: :numeroCOMPE,
    ispb_code: :numeroISPB,
    credit_account_kind: :tipoConta,
    credit_branch_office: :agencia,
    credit_current_account: :conta,
    check_digits_credit_current_account: :digitoVerificadorConta,
    credit_payment_account: :contaPagamento,
  }
end

.openapi_types ⇒ Object

Attribute type mapping.



107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
 
# File 'lib/bb_payments/models/transfer_pix_base.rb', line 107

def self.openapi_types
  {
    payment_date: :Integer,
    payment_value: :Float,
    debit_document: :Integer,
    credit_document: :Integer,
    payment_description: :String,
    instantaneous_payment_description: :String,
    key_type: :Integer,
    phone_area_code: :Integer,
    phone: :Integer,
    email: :String,
    individual_taxpayer_registration: :Integer,
    corporate_taxpayer_registration: :Integer,
    random_key: :String,
    clearinghouse_code: :Integer,
    ispb_code: :Integer,
    credit_account_kind: :Integer,
    credit_branch_office: :Integer,
    credit_current_account: :Integer,
    check_digits_credit_current_account: :String,
    credit_payment_account: :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



135
136
137
138
139
140
141
142
143
144
 
# File 'lib/bb_payments/models/transfer_pix_base.rb', line 135

def list_invalid_properties
  invalid_properties = Array.new
  %i[payment_date payment_value key_type].each do |attr|
    next if send(attr).present?
    
    invalid_properties.push("invalid value for '#{attr}': cannot be nil.")
  end      

  invalid_properties
end