Class: BancoBrasilPayments::BatchPixResponse

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

#payments_list ⇒ Object

Lista de transferências enviada. Os campos desta lista dizem respeito a crédito a determinado beneficiário.



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

def payments_list
  @payments_list
end

#payments_total_quantity ⇒ Object

Quantidade total dos lançamentos enviados para pagamento.



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

def payments_total_quantity
  @payments_total_quantity
end

#payments_total_value ⇒ Object

Valor total dos lançamentos enviados para pagamento.



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

def payments_total_value
  @payments_total_value
end

#request_identification ⇒ Object

Identificador da requisição de pagamento em lote. Valor do identificador é controlado pelo cliente.



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

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



26
27
28
 
# File 'lib/bb_payments/models/batch_pix_response.rb', line 26

def request_status
  @request_status
end

#valid_payments_total_quantity ⇒ Object

Quantidade total de lançamentos válidos.



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

def valid_payments_total_quantity
  @valid_payments_total_quantity
end

#valid_payments_total_value ⇒ Object

Valor total dos lançamentos válidos.



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

def valid_payments_total_value
  @valid_payments_total_value
end

Class Method Details

.attribute_map ⇒ Object

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



44
45
46
47
48
49
50
51
52
53
54
 
# File 'lib/bb_payments/models/batch_pix_response.rb', line 44

def self.attribute_map
  {
    request_identification: :numeroRequisicao,
    request_status: :estadoRequisicao,
    payments_total_quantity: :quantidadeTransferencias,
    payments_total_value: :valorTransferencias,
    valid_payments_total_quantity: :quantidadeTransferenciasValidas,
    valid_payments_total_value: :valorTransferenciasValidas,
    payments_list: :listaTransferencias
  }
end

.openapi_types ⇒ Object

Attribute type mapping.



57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/bb_payments/models/batch_pix_response.rb', line 57

def self.openapi_types
  {
    request_identification: :Integer,
    request_status: :Integer,
    payments_total_quantity: :Integer,
    payments_total_value: :Float,
    valid_payments_total_quantity: :String,
    valid_payments_total_value: :Float,
    payments_list: :'Array<TransferPix>'
  }
end