Module: BancoBrasilPayments::TransfersPix

Includes:
BaseApi
Included in:
BatchPaymentsApi
Defined in:
lib/bb_payments/api/transfers_pix.rb

Overview

Transferências-PIX

> Pagamentos que envolvem Transferências do tipo PIX

Implemented
  • Endpoint

    > Description

Y ]- [POST /lotes-transferencias-pix

> Efetuar Pagamentos em Lote via Transferência PIX

Y*]- [GET /pagamentos

> Consultar Pagamentos (* See BancoBrasilPayments::Payments)

Y ]- [GET /lotes-transferencias-pix/id/solicitacao

> Consultar Solicitação de Transferências PIX

Instance Method Summary collapse

Methods included from BaseApi

#build_client_opts, #call_api_client, #validations

Instance Method Details

#create_batch_transfers_pix(body, opts = {}) ⇒ Object

POST /lotes-transferencias-pix Efetuar Pagamentos em Lote via Transferência PIX



17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
 
# File 'lib/bb_payments/api/transfers_pix.rb', line 17

def create_batch_transfers_pix(body, opts = {})
  validations(api_client: api_client, body: body, validate_body: true)

  client_opts = build_client_opts(api_client: api_client,
                                  gw_app_key: gw_app_key,
                                  opts: opts,
                                  return_type: 'BatchPixResponse',
                                  body: @api_client.object_to_http_body(body))
  client_opts[:header_params]['Content-Type'] = @api_client.select_header_content_type(['application/json'])
  data_only = opts.fetch :data_only, true

  call_api_client(api_client: api_client,
                  http_method: :POST,
                  path: '/lotes-transferencias-pix',
                  data_only: data_only,
                  client_opts: client_opts)
end

#find_batch_transfer_pix(id, opts = {}) ⇒ Object

GET /lotes-transferencias-pix/id/solicitacao # Consultar Solicitação de Transferências PIX



37
38
39
40
41
42
43
44
45
46
47
48
49
50
 
# File 'lib/bb_payments/api/transfers_pix.rb', line 37

def find_batch_transfer_pix(id, opts = {})
  validations(api_client: api_client, required_params: { id: id })

  client_opts = build_client_opts(api_client: api_client,
                                  gw_app_key: gw_app_key,
                                  opts: opts)
  client_opts[:query_params][:'index'] = opts[:'index'] if !opts[:'index'].nil?

  call_api_client(api_client: api_client,
                  http_method: :GET,
                  path: "/lotes-transferencias-pix/#{id}/solicitacao",
                  data_only: opts.fetch(:data_only, true),
                  client_opts: client_opts)
end

#find_payment_pix(id, opts = {}) ⇒ Object

GET /pix/id # Detalha todos os dados de um pagamento efetuado na modalidade PIX.



54
55
56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/bb_payments/api/transfers_pix.rb', line 54

def find_payment_pix(id, opts = {})
  validations(api_client: api_client, required_params: { id: id })

  client_opts = build_client_opts(api_client: api_client,
                                  gw_app_key: gw_app_key,
                                  opts: opts,
                                  return_type: 'FindPaymentPixResponse')

  call_api_client(api_client: api_client,
                  http_method: :GET,
                  path: "/pix/#{id}",
                  data_only: opts.fetch(:data_only, true),
                  client_opts: client_opts)
end