Class: BancoBrasilPayments::Release

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

Overview

Objeto de Requisição quando da solicitação para efetuar pagamentos em lote via Transferência PIX.

Instance Attribute Summary collapse

Class Method Summary collapse

Methods inherited from BaseModel

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

Constructor Details

This class inherits a constructor from BancoBrasilPayments::BaseModel

Instance Attribute Details

#beneficiary_kind ⇒ Object

Tipo de pessoa do Beneficiário (1 - Física, 2 - Jurídica).



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

def beneficiary_kind
  @beneficiary_kind
end

#beneficiary_name ⇒ Object

Nome do favorecido.



15
16
17
 
# File 'lib/bb_payments/models/release.rb', line 15

def beneficiary_name
  @beneficiary_name
end

#credit_document_number ⇒ Object

Numero do documento de crédito informado pelo pagador para apresentação no extrato do favorecido.



33
34
35
 
# File 'lib/bb_payments/models/release.rb', line 33

def credit_document_number
  @credit_document_number
end

#credit_form_code ⇒ Object

Código da forma de crédito. Enum [ 1, 3, 5, 13, 21, 30, 47, 71 ]



37
38
39
 
# File 'lib/bb_payments/models/release.rb', line 37

def credit_form_code
  @credit_form_code
end

#debit_date ⇒ Object

Data do débito.



43
44
45
 
# File 'lib/bb_payments/models/release.rb', line 43

def debit_date
  @debit_date
end

#debit_document_number ⇒ Object

Numero do documento de débito informado pelo pagador para apresentação no extrato do favorecido.



30
31
32
 
# File 'lib/bb_payments/models/release.rb', line 30

def debit_document_number
  @debit_document_number
end

#payment_auth_code ⇒ Object

Código de autenticação do pagamento.



40
41
42
 
# File 'lib/bb_payments/models/release.rb', line 40

def payment_auth_code
  @payment_auth_code
end

#payment_date ⇒ Object

Data do pagamento.



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

def payment_date
  @payment_date
end

#payment_id ⇒ Object

Número identificador do pagamento. Equivale ao número do protocolo do evento.



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

def payment_id
  @payment_id
end

#payment_request_number ⇒ Object

Número da requisição de transferências de valores.



5
6
7
 
# File 'lib/bb_payments/models/release.rb', line 5

def payment_request_number
  @payment_request_number
end

#payment_state ⇒ Object

Descrição da situação do pagamento. Enum: [ Consistente, Inconsistente, Pendente, Agendado, Pago, Rejeitado, Devolvido, Cancelado, Debitado, Bloqueado, Aguardando Saldo ]



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

def payment_state
  @payment_state
end

#payment_type ⇒ Object

Código atribuído pelo sistema PRD ao produto a ser comercializado pelo BB (ativo/passivo/prestação de serviços). Podendo ser: 126=Pagamento a Fornecedores; 127=Pagamento de Salários; 128=Pagamentos Diversos.



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

def payment_type
  @payment_type
end

#payment_value ⇒ Object

Valor do Pagamento que deverá ser efetuada a crédito do favorecido.



27
28
29
 
# File 'lib/bb_payments/models/release.rb', line 27

def payment_value
  @payment_value
end

#tax_number ⇒ Object

Número do CPF ou CNPJ do favorecido do pagamento.



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

def tax_number
  @tax_number
end

Class Method Details

.attribute_map ⇒ Object

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



50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/bb_payments/models/release.rb', line 50

def self.attribute_map
  {
    payment_request_number: :numeroRequisicaoPagamento,
    payment_state: :textoEstadoPagamento,
    payment_id: :codigoIdentificadorDoPagamento,
    beneficiary_name: :nomeBeneficiario,
    beneficiary_kind: :tipoBeneficiario,
    tax_number: :numeroCPFouCNPJ,
    payment_date: :dataPagamento,
    payment_value: :valorPagamento,
    debit_document_number: :numeroDocumentoDebito,
    credit_document_number: :numeroDocumentoCredito,
    credit_form_code: :codigoFormaCredito,
    payment_auth_code: :codigoAutenticacaoPagamento,
    debit_date: :dataDebito,
    payment_type: :codigoTipoPagamento
  }
end

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    payment_request_number: :Integer,
    payment_state: :String,
    payment_id: :Integer,
    beneficiary_name: :String,
    beneficiary_kind: :Integer,
    tax_number: :Integer,
    payment_date: :NumberDate,
    payment_value: :Float,
    debit_document_number: :Integer,
    credit_document_number: :Integer,
    credit_form_code: :Integer,
    payment_auth_code: :String,
    debit_date: :NumberDate,
    payment_type: :Integer
  }
end