Class: ApiBrasil::Services::Platform::PaymentsService

Inherits:
BaseService
  • Object
show all
Defined in:
lib/api_brasil/services/platform/payments_service.rb

Overview

Pagamentos e recargas (PIX, boleto e cartao) - /recharge, /{provider}/pix/*, /{provider}/boleto/*, /mercadopago/card/*.

Constant Summary collapse

PROVIDERS =

Provedores de pagamento suportados pelo gateway.

%w[santander inter mercadopago sicoob].freeze

Instance Attribute Summary

Attributes inherited from BaseService

#http

Instance Method Summary collapse

Methods inherited from BaseService

#delete, #download, #get, #initialize, #patch, #post, #put

Constructor Details

This class inherits a constructor from ApiBrasil::Services::BaseService

Instance Method Details

#boleto_generate(provider, body, options = {}) ⇒ Object

Gera um boleto: POST /{provider}/boleto/generate.

Returns:

  • (Object) 


54
55
56
 
# File 'lib/api_brasil/services/platform/payments_service.rb', line 54

def boleto_generate(provider, body, options = {})
  post("/#{provider}/boleto/generate", body, options)
end

#boleto_pdf(provider, id, options = {}) ⇒ String

Baixa o PDF de um boleto: GET /{provider}/boleto/{id}/pdf. Devolve o conteudo binario do arquivo.

Returns:

  • (String) 


69
70
71
 
# File 'lib/api_brasil/services/platform/payments_service.rb', line 69

def boleto_pdf(provider, id, options = {})
  get("/#{provider}/boleto/#{id}/pdf", { response_type: "raw" }.merge(options))
end

#boleto_status(provider, id, options = {}) ⇒ Object

Consulta um boleto: GET /{provider}/boleto/{id}.

Returns:

  • (Object) 


61
62
63
 
# File 'lib/api_brasil/services/platform/payments_service.rb', line 61

def boleto_status(provider, id, options = {})
  get("/#{provider}/boleto/#{id}", options)
end

#card_installments(body, options = {}) ⇒ Object

Consulta parcelas do cartao: POST /mercadopago/card/installments.

Returns:

  • (Object) 


83
84
85
 
# File 'lib/api_brasil/services/platform/payments_service.rb', line 83

def card_installments(body, options = {})
  post("/mercadopago/card/installments", body, options)
end

#card_process(body, options = {}) ⇒ Object

Processa pagamento com cartao (Mercado Pago): POST /mercadopago/card/process.

Returns:

  • (Object) 


76
77
78
 
# File 'lib/api_brasil/services/platform/payments_service.rb', line 76

def card_process(body, options = {})
  post("/mercadopago/card/process", body, options)
end

#card_status(id, options = {}) ⇒ Object

Consulta um pagamento de cartao: GET /mercadopago/card/{id}.

Returns:

  • (Object) 


90
91
92
 
# File 'lib/api_brasil/services/platform/payments_service.rb', line 90

def card_status(id, options = {})
  get("/mercadopago/card/#{id}", options)
end

#checkout_finalize(body, options = {}) ⇒ Object

Finaliza o checkout: POST /checkout/finalize.

Returns:

  • (Object) 


118
119
120
 
# File 'lib/api_brasil/services/platform/payments_service.rb', line 118

def checkout_finalize(body, options = {})
  post("/checkout/finalize", body, options)
end

#checkout_payment_methods(options = {}) ⇒ Object

Metodos de pagamento do checkout: GET /checkout/payment-methods.

Returns:

  • (Object) 


97
98
99
 
# File 'lib/api_brasil/services/platform/payments_service.rb', line 97

def checkout_payment_methods(options = {})
  get("/checkout/payment-methods", options)
end

#checkout_periods(options = {}) ⇒ Object

Periodos do checkout: GET /checkout/periods.

Returns:

  • (Object) 


104
105
106
 
# File 'lib/api_brasil/services/platform/payments_service.rb', line 104

def checkout_periods(options = {})
  get("/checkout/periods", options)
end

#pix_generate(provider, body, options = {}) ⇒ Object

Gera uma cobranca PIX: POST /{provider}/pix/generate.

Parameters:

  • provider (String) —

    um de PROVIDERS

Returns:

  • (Object) 


40
41
42
 
# File 'lib/api_brasil/services/platform/payments_service.rb', line 40

def pix_generate(provider, body, options = {})
  post("/#{provider}/pix/generate", body, options)
end

#pix_status(provider, tx_id, options = {}) ⇒ Object

Consulta uma cobranca PIX: GET /{provider}/pix/{tx_id}.

Returns:

  • (Object) 


47
48
49
 
# File 'lib/api_brasil/services/platform/payments_service.rb', line 47

def pix_status(provider, tx_id, options = {})
  get("/#{provider}/pix/#{tx_id}", options)
end

#recharge(body, options = {}) ⇒ Object

Cria uma recarga (pix|boleto): POST /recharge.

Parameters:

  • body (Hash) —

    amount, type

Returns:

  • (Object) 


25
26
27
 
# File 'lib/api_brasil/services/platform/payments_service.rb', line 25

def recharge(body, options = {})
  post("/recharge", body, options)
end

#recharge_show(identifier, options = {}) ⇒ Object

Detalha uma recarga: GET /recharge/{identifier}.

Returns:

  • (Object) 


32
33
34
 
# File 'lib/api_brasil/services/platform/payments_service.rb', line 32

def recharge_show(identifier, options = {})
  get("/recharge/#{identifier}", options)
end

#recharges(options = {}) ⇒ Object

Lista as recargas: GET /recharges.

Returns:

  • (Object) 


17
18
19
 
# File 'lib/api_brasil/services/platform/payments_service.rb', line 17

def recharges(options = {})
  get("/recharges", options)
end

#validate_coupon(body, options = {}) ⇒ Object

Valida um cupom: POST /checkout/validate-coupon.

Returns:

  • (Object) 


111
112
113
 
# File 'lib/api_brasil/services/platform/payments_service.rb', line 111

def validate_coupon(body, options = {})
  post("/checkout/validate-coupon", body, options)
end