Class: BancoBrasilPayments::FindBatchResponse

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

#next_index ⇒ Object

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.



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

def next_index
  @next_index
end

#payment_type ⇒ Object

Informado pela API de acordo com o endpoint utilizado pelo cliente. Pode ser: 126=Pagamento a Fornecedores; 127=Pagamento de Salários; 128=Pagamentos Diversos.



31
32
33
 
# File 'lib/bb_payments/models/find_batch_response.rb', line 31

def payment_type
  @payment_type
end

#payments_list ⇒ Object

Lista de pagamentos a serem processados em lote. Não permitido mais de 500 registros.



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

def payments_list
  @payments_list
end

#payments_total_quantity ⇒ Object

Quantidade total de Pagamentos



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

def payments_total_quantity
  @payments_total_quantity
end

#payments_total_value ⇒ Object

Valor total dos Pagamentos.



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

def payments_total_value
  @payments_total_value
end

#request_date ⇒ Object

Data em que o cliente enviou ao Banco a requisição de pagamento em lote.



34
35
36
 
# File 'lib/bb_payments/models/find_batch_response.rb', line 34

def request_date
  @request_date
end

#request_status ⇒ Object

Código que identifica o estado da solicitação. 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. A 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.



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

def request_status
  @request_status
end

Class Method Details

.attribute_map ⇒ Object

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



46
47
48
49
50
51
52
53
54
55
56
 
# File 'lib/bb_payments/models/find_batch_response.rb', line 46

def self.attribute_map
  {
    next_index: :indice,
    request_status: :estadoRequisicao,
    payment_type: :tipoPagamento,
    request_date: :dataRequisicao,
    payments_total_quantity: :quantidadePagamentos,
    payments_total_value: :valorPagamentos,
    payments_list: :pagamentos
  }
end

.openapi_types ⇒ Object

Attribute type mapping.



59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/bb_payments/models/find_batch_response.rb', line 59

def self.openapi_types
  {
    next_index: :Integer,
    request_status: :Integer,
    payment_type: :Integer,
    request_date: :NumberDate,
    payments_total_quantity: :Integer,
    payments_total_value: :Float,
    payments_list: 'Array<FindBatchPayment>'
  }
end