Class: BancoBrasilPayments::FindBatchPayment

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/bb_payments/models/find_batch_payment.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

Identification of Individual or Corporate Taxpayer Registration with the Federal Revenue Service; CPF ou CNPJ do beneficiário no pagamento



22
23
24
 
# File 'lib/bb_payments/models/find_batch_payment.rb', line 22

def beneficiary_kind
  @beneficiary_kind
end

#beneficiary_name ⇒ Object

Nome da pessoa ou empresa beneficiária no pagamento



28
29
30
 
# File 'lib/bb_payments/models/find_batch_payment.rb', line 28

def beneficiary_name
  @beneficiary_name
end

#credit_type ⇒ Object

A modalidade que representa a maneira como o crédito foi dado, descrito a seguir: 1 significa Crédito em Conta Corrente; 3 significa DOC ou TED; 5 significa Crédito em Conta Poupança; 13 significa Liquidação de Guia com Código de Barra; 21 significa Liquidação de Guia sem Código de Barra; 30 significa Liquidação de Boleto Bancário; 31 significa Liquidação de Papéis Diversos; 71 significa Depósito Judicial.



19
20
21
 
# File 'lib/bb_payments/models/find_batch_payment.rb', line 19

def credit_type
  @credit_type
end

#error_codes_list ⇒ Object

Códigos de erros a serem verificados para correção dos dados e reenvio em novo lançamento. Quando “”0“” significa que não há erros de formatação nos dados.



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

def error_codes_list
  @error_codes_list
end

#payment_date ⇒ Object

Data em que deverá ser efetuado o pagamento ao favorecido.



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

def payment_date
  @payment_date
end

#payment_description ⇒ Object

Campo de uso livre pelo Cliente Conveniado - sem tratamento pelo Banco.



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

def payment_description
  @payment_description
end

#payment_id ⇒ Object

Número único gerado pelo Banco. Deve ser utilizado pelo Cliente Conveniado para efetivar consultas posteriores ao lançamento.



6
7
8
 
# File 'lib/bb_payments/models/find_batch_payment.rb', line 6

def payment_id
  @payment_id
end

#payment_status ⇒ Object

Descrição da situação do pagamento: Domínios:

Consistente (pagamento recebido pelo banco, cumprem as regras de preenchimento dos campos mas ainda irá para validação e processamento) Inconsistente (pagamento não aceito pelo banco por dados de entrada inconsistentes - não cumpre as regras de preenchimento dos campos) Pago (pagamento efetuado ao favorecido) Pendente (pagamento validado - pendência de autorização do pagamento por parte do pagador) Aguardando saldo (débito não efetivado e em verificação de saldo até o horário limite da teimosinha). Agendado (pagamento autorizado, porém aguardando a data de efetivação do pagamento ou horário de processamento) Rejeitado (dados do pagamento não passaram na validações físicas e/ou lógicas, precisam ser corrigidos e reenviados. Ex: agência e conta não existem, conta não pertence ao CPF informado) Cancelado (pagamento cancelado pelo pagador antes da data de efetivação do crédito) Bloqueado (Débito na conta do pagador não efetivado por ocorrência no convênio, inconsistência de data/float ou falta de saldo) Devolvido (pagamento efetuado e posteriormente devolvido pelo favorecido ou instituição recebedora. O valor é devolvido para a conta corrente onde ocorreu o débito da requisição)“ Debitado (pagamento debitado na conta do pagador e pendente de crédito ao favorecido)horário de processamento, PAGO - Pagamento realizado ao Favorecido,

REJEITADO - Dados do Favorecido inválidos, o que impede a efetivação do pagamento. Dados precisam ser corrigidos e reenviados,

DEVOLVIDO - Pagamento efetuado e posteriormente devolvido pelo Favorecido/Banco destinatário,

VENCIDO - Pagamento não efetuado na data indicada,

CANCELADO - Pagamento cancelado pelo Pagador antes da data de efetivação do crédito.



52
53
54
 
# File 'lib/bb_payments/models/find_batch_payment.rb', line 52

def payment_status
  @payment_status
end

#payment_value ⇒ Object

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



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

def payment_value
  @payment_value
end

#taxpayer_registration ⇒ Object

É o Nº CPF ou um Nº de CNPJ do Favorecido/Beneficiario do pagamento informado no envio do lançamento na requisição



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

def taxpayer_registration
  @taxpayer_registration
end

Class Method Details

.attribute_map ⇒ Object

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



62
63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/bb_payments/models/find_batch_payment.rb', line 62

def self.attribute_map
  {
    payment_id: :identificadorPagamento,
    payment_date: :dataPagamento,
    payment_value: :valorPagamento,
    credit_type: :tipoCredito,
    beneficiary_kind: :tipoBeneficiario,
    taxpayer_registration: :cpfCnpjBeneficiario,
    beneficiary_name: :nomeBeneficiario,
    payment_status: :estadoPagamento,
    payment_description: :descricaoPagamento,
    error_codes_list: :erros
  }
end

.openapi_types ⇒ Object

Attribute type mapping.



78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/bb_payments/models/find_batch_payment.rb', line 78

def self.openapi_types
  {
    payment_id: :Integer,
    payment_date: :NumberDate,
    payment_value: :Float,
    credit_type: :Integer,
    beneficiary_kind: :Integer,
    taxpayer_registration: :String,
    beneficiary_name: :String,
    payment_status: :String,
    payment_description: :String,
    error_codes_list: :Object
  }
end