Pagamentos e recargas (PIX, boleto e cartão): /recharge,
/{provider}/pix/*, /{provider}/boleto/*, /mercadopago/card/*.
alias ApiBrasil.Platform.Payments
{:ok, _} = Payments.recharge(client, %{"amount" => 50, "type" => "pix"})
{:ok, _} = Payments.pix_generate(client, Payments.provider_santander(), %{"amount" => 50})
{:ok, pdf} = Payments.boleto_pdf(client, Payments.provider_inter(), "ID")
File.write!("boleto.pdf", pdf)Summary
Functions
Gera um boleto: POST /{provider}/boleto/generate.
Como boleto_generate/4, mas levanta ApiBrasil.Core.Error em caso de falha.
Baixa o PDF de um boleto: GET /{provider}/boleto/{id}/pdf.
Como boleto_pdf/4, mas levanta ApiBrasil.Core.Error em caso de falha.
Consulta um boleto: GET /{provider}/boleto/{id}.
Como boleto_status/4, mas levanta ApiBrasil.Core.Error em caso de falha.
Consulta as parcelas do cartão: POST /mercadopago/card/installments.
Como card_installments/3, mas devolve o resultado direto e levanta ApiBrasil.Core.Error em caso de falha.
Processa um pagamento com cartão (Mercado Pago): POST /mercadopago/card/process.
Como card_process/3, mas devolve o resultado direto e levanta ApiBrasil.Core.Error em caso de falha.
Consulta um pagamento de cartão: GET /mercadopago/card/{id}.
Como card_status/3, mas levanta ApiBrasil.Core.Error em caso de falha.
Finaliza o checkout: POST /checkout/finalize.
Como checkout_finalize/3, mas devolve o resultado direto e levanta ApiBrasil.Core.Error em caso de falha.
Métodos de pagamento do checkout: GET /checkout/payment-methods.
Como checkout_payment_methods/2, mas devolve o resultado direto e levanta ApiBrasil.Core.Error em caso de falha.
Períodos do checkout: GET /checkout/periods.
Como checkout_periods/2, mas devolve o resultado direto e levanta ApiBrasil.Core.Error em caso de falha.
Gera uma cobrança PIX: POST /{provider}/pix/generate.
Como pix_generate/4, mas levanta ApiBrasil.Core.Error em caso de falha.
Consulta uma cobrança PIX: GET /{provider}/pix/{tx_id}.
Como pix_status/4, mas levanta ApiBrasil.Core.Error em caso de falha.
Provedor de pagamento Inter (inter).
Provedor de pagamento Mercado Pago (mercadopago).
Provedor de pagamento Santander (santander).
Provedor de pagamento Sicoob (sicoob).
Cria uma recarga (pix | boleto): POST /recharge.
Como recharge/3, mas devolve o resultado direto e levanta ApiBrasil.Core.Error em caso de falha.
Detalha uma recarga: GET /recharge/{identifier}.
Como recharge_show/3, mas levanta ApiBrasil.Core.Error em caso de falha.
Lista as recargas: GET /recharges.
Como recharges/2, mas devolve o resultado direto e levanta ApiBrasil.Core.Error em caso de falha.
Valida um cupom: POST /checkout/validate-coupon.
Como validate_coupon/3, mas devolve o resultado direto e levanta ApiBrasil.Core.Error em caso de falha.
Types
@type result() :: {:ok, map()} | {:error, ApiBrasil.Core.Error.t()}
Functions
@spec boleto_generate(ApiBrasil.Client.t(), String.t(), term(), keyword()) :: result()
Gera um boleto: POST /{provider}/boleto/generate.
@spec boleto_generate!(ApiBrasil.Client.t(), String.t(), term(), keyword()) :: map()
Como boleto_generate/4, mas levanta ApiBrasil.Core.Error em caso de falha.
@spec boleto_pdf(ApiBrasil.Client.t(), String.t(), String.t(), keyword()) :: {:ok, binary()} | {:error, ApiBrasil.Core.Error.t()}
Baixa o PDF de um boleto: GET /{provider}/boleto/{id}/pdf.
Devolve os bytes crus do arquivo.
@spec boleto_pdf!(ApiBrasil.Client.t(), String.t(), String.t(), keyword()) :: binary()
Como boleto_pdf/4, mas levanta ApiBrasil.Core.Error em caso de falha.
@spec boleto_status(ApiBrasil.Client.t(), String.t(), String.t(), keyword()) :: result()
Consulta um boleto: GET /{provider}/boleto/{id}.
@spec boleto_status!(ApiBrasil.Client.t(), String.t(), String.t(), keyword()) :: map()
Como boleto_status/4, mas levanta ApiBrasil.Core.Error em caso de falha.
@spec card_installments(ApiBrasil.Client.t(), term(), keyword()) :: result()
Consulta as parcelas do cartão: POST /mercadopago/card/installments.
@spec card_installments!(ApiBrasil.Client.t(), term(), keyword()) :: map()
Como card_installments/3, mas devolve o resultado direto e levanta ApiBrasil.Core.Error em caso de falha.
@spec card_process(ApiBrasil.Client.t(), term(), keyword()) :: result()
Processa um pagamento com cartão (Mercado Pago): POST /mercadopago/card/process.
@spec card_process!(ApiBrasil.Client.t(), term(), keyword()) :: map()
Como card_process/3, mas devolve o resultado direto e levanta ApiBrasil.Core.Error em caso de falha.
@spec card_status(ApiBrasil.Client.t(), String.t(), keyword()) :: result()
Consulta um pagamento de cartão: GET /mercadopago/card/{id}.
@spec card_status!(ApiBrasil.Client.t(), String.t(), keyword()) :: map()
Como card_status/3, mas levanta ApiBrasil.Core.Error em caso de falha.
@spec checkout_finalize(ApiBrasil.Client.t(), term(), keyword()) :: result()
Finaliza o checkout: POST /checkout/finalize.
@spec checkout_finalize!(ApiBrasil.Client.t(), term(), keyword()) :: map()
Como checkout_finalize/3, mas devolve o resultado direto e levanta ApiBrasil.Core.Error em caso de falha.
@spec checkout_payment_methods( ApiBrasil.Client.t(), keyword() ) :: result()
Métodos de pagamento do checkout: GET /checkout/payment-methods.
@spec checkout_payment_methods!( ApiBrasil.Client.t(), keyword() ) :: map()
Como checkout_payment_methods/2, mas devolve o resultado direto e levanta ApiBrasil.Core.Error em caso de falha.
@spec checkout_periods( ApiBrasil.Client.t(), keyword() ) :: result()
Períodos do checkout: GET /checkout/periods.
@spec checkout_periods!( ApiBrasil.Client.t(), keyword() ) :: map()
Como checkout_periods/2, mas devolve o resultado direto e levanta ApiBrasil.Core.Error em caso de falha.
@spec pix_generate(ApiBrasil.Client.t(), String.t(), term(), keyword()) :: result()
Gera uma cobrança PIX: POST /{provider}/pix/generate.
@spec pix_generate!(ApiBrasil.Client.t(), String.t(), term(), keyword()) :: map()
Como pix_generate/4, mas levanta ApiBrasil.Core.Error em caso de falha.
@spec pix_status(ApiBrasil.Client.t(), String.t(), String.t(), keyword()) :: result()
Consulta uma cobrança PIX: GET /{provider}/pix/{tx_id}.
@spec pix_status!(ApiBrasil.Client.t(), String.t(), String.t(), keyword()) :: map()
Como pix_status/4, mas levanta ApiBrasil.Core.Error em caso de falha.
@spec provider_inter() :: String.t()
Provedor de pagamento Inter (inter).
@spec provider_mercado_pago() :: String.t()
Provedor de pagamento Mercado Pago (mercadopago).
@spec provider_santander() :: String.t()
Provedor de pagamento Santander (santander).
@spec provider_sicoob() :: String.t()
Provedor de pagamento Sicoob (sicoob).
@spec recharge(ApiBrasil.Client.t(), term(), keyword()) :: result()
Cria uma recarga (pix | boleto): POST /recharge.
@spec recharge!(ApiBrasil.Client.t(), term(), keyword()) :: map()
Como recharge/3, mas devolve o resultado direto e levanta ApiBrasil.Core.Error em caso de falha.
@spec recharge_show(ApiBrasil.Client.t(), String.t(), keyword()) :: result()
Detalha uma recarga: GET /recharge/{identifier}.
@spec recharge_show!(ApiBrasil.Client.t(), String.t(), keyword()) :: map()
Como recharge_show/3, mas levanta ApiBrasil.Core.Error em caso de falha.
@spec recharges( ApiBrasil.Client.t(), keyword() ) :: result()
Lista as recargas: GET /recharges.
@spec recharges!( ApiBrasil.Client.t(), keyword() ) :: map()
Como recharges/2, mas devolve o resultado direto e levanta ApiBrasil.Core.Error em caso de falha.
@spec validate_coupon(ApiBrasil.Client.t(), term(), keyword()) :: result()
Valida um cupom: POST /checkout/validate-coupon.
@spec validate_coupon!(ApiBrasil.Client.t(), term(), keyword()) :: map()
Como validate_coupon/3, mas devolve o resultado direto e levanta ApiBrasil.Core.Error em caso de falha.