Cobrar com PIX por API
O que você irá aprender com esse artigo?
- O que é PIX
- Configurar PIX
- Realizar cobrança de uma fatura com PIX
O que é PIX?
PIX é um sistema de pagamento instantâneo desenvolvido pelo Banco Central do Brasil. Ele permite transferências e pagamentos 24 horas por dia, todos os dias da semana, com transações concluídas em até 10 segundos. PIX é gratuito para pessoas físicas e facilita operações entre contas de diferentes bancos e instituições financeiras de forma rápida e segura.
1. Ativar PIX como método de pagamento
Antes de oferecer o PIX como método de pagamento, deve-se ativá-lo. Para isso, há duas formas:
- Via Painel. Acesse alia.iugu.com > Configurações > Pix > marque a caixa de seleção "Pix" > Salvar.
- Via API. Utilize o endpoint Configurar Pagamentos Pix —
v1/payments/pix
com o parâmetroenable
comotrue
.
Importante
Certifique-se que a conta que fará a requisição esteja verificada. Saiba mais.
2. Cobrar com PIX
Com o PIX ativado, utilize o endpoint Criar Fatura — v1/invoices
. Atente-se aos parâmetros:
email
— E-mail do cliente. Não obrigatório se utilizadocustomer_id
.payable_with
— Insira apenas o valorpix
para disponibilizar apenas este método de pagamento para esta fatura. Para mais métodos, adicione os valores (separando-os por vírgula):
credit_card
— Cartão de Créditobank_slip
— Boleto Bancário. Torna os parâmetrosname
ecpf_cnpj
do arraypayer
obrigatóriosall
— Todos
Request exemplo
curl --request POST \
--url 'https://api.iugu.com/v1/invoices?api_token=<seu-api_token>' \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--data '
{
"email": "[email protected]",
"due_date": "2024-05-27",
"items": [
{
"description": "Item",
"quantity": 1,
"price_cents": 100
}
],
"payable_with": [
"pix"
]
}
'
{
"id": "B894097671074A29A8CA966CC12A7992",
"due_date": "2024-05-27",
"currency": "BRL",
"discount_cents": null,
"email": "[email protected]",
"items_total_cents": 100,
"notification_url": null,
"return_url": null,
"status": "pending",
"tax_cents": null,
"total_cents": 100,
"total_paid_cents": 0,
"taxes_paid_cents": null,
"paid_at": null,
"paid_cents": null,
"cc_emails": null,
"financial_return_date": null,
"payable_with": "pix", //Método de pagamento PIX
(...)
{
"qrcode": "https://faturas.iugu.com/qr_code/b8940976-7107-4a29-a8ca-966cc12a7992-9f62",
"qrcode_text": "00020101021226840014br.gov.bcb.pix2562qr.iugu.com/public/payload/v2/B894097671074A29A8CA966CC12A799252040000530398654041.005802BR5925IUGU INSTITUICAO DE PAGAM6009SAO PAULO62070503***63045188",
"status": "qr_code_created",
"payer_cpf_cnpj": null,
"payer_name": null,
"end_to_end_id": null,
"end_to_end_refund_id": null,
"account_number_last_digits": null
}
PIX copia e cola e QRCode
No objeto
pix
, é possível coletar a imagem e a linha digitável do QRCode pelas propriedadesqrcode
eqrcode_text
, respectivamente.
Pagar com PIX
Quando um pagamento é bem sucedido, o valor é instantaneamente transferido, além de ficar disponível para utilização.
Temos gatilho para esse evento
Utilize o Gatilho Fatura Liberada —
invoice.released
para ser avisado quando o valor de uma Fatura ficar disponível para utilização.
Diagrama de Sequência
![](https://files.readme.io/2f4e778-sequence-diagram-pix.png)
Updated 3 months ago