Realizar cobrança 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

Diagrama de sequência

O que é o PIX?

O PIX é uma forma de pagamento que ocorre de forma instantânea. Veja como funciona o PIX na iugu:

Configurar PIX

Existem duas maneiras de realizar a configuração do método de pagamento PIX, que iremos explicar nesse artigo:
1) Pela interface da plataforma
2) Por API

Caso sua necessidade seja habilitar esse método para várias contas, indicamos o uso da API. Porém se esse processo for realizado apenas para uma conta, a melhor opção será realizar o cadastro pela plataforma.

Plataforma

Para configurar pela plataforma, basta acessar o menu Configurações> PIX> Flegar como ativo>Definir o valor de taxas e tarifas e clicar em Salvar.

API

Após realizar a criação da subconta e a verificação da conta, deve ser habilitado o PIX.

Caso não tenha realizado nenhuma dessas atividades, recomendamos ler o artigo Como posso configurar uma subconta por api.

Para realizar essa configuração, a conta precisa estar verificada, ou seja, é premissa realizar a request Enviar verificação de subconta, caso contrário será retornado o status http 401 e no body a mensagem Unauthorized.

O método da request é PUT e no body, deve ser informado true or false, na api_token deve ser usado o live-token da subconta.

Modelo de request

curl --location --request PUT 'https://api.iugu.com/v1/payments/pix?api_token={chaveapi}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Cookie: __cfruid=0061e0ce76c9748e57cfd03b25563473a0fe496a-1626699286' \
--data-raw '{
    "enable": true
}'

Modelo de response

Realizar uma cobrança com PIX

Uma vez configurada sua conta, deve ser realizado um POST na api Criar Faturas. Nela é possível criar o cliente e realizar a cobrança ou usar o id de um cliente já existente.

Modelo de request

curl --location --request POST 'https://api.iugu.com/v1/invoices?api_token={chaveapi}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Cookie: __cfruid=df598e45cd90947e522e12ec895a84f7059cacbc-1627922464' \
--data-raw '{
    "payer": {
        "address": {
            "zip_code": "09550-034",
            "street": "Sao Paulo",
            "number": "2330",
            "city": "teste",
            "state": "SP",
            "country": "BR",
            "complement": "AP 61",
            "district": "Santa Paula"
        },
        "cpf_cnpj": "numero do cpf",
        "name": "Iugu",
        "email": "[email protected]"
    },
    "items": [
        {
            "description": "item de teste iugu",
            "quantity": 1,
            "price_cents": 1500
        }
    ],
    "payable_with": [
        "pix"
    ],
    "email": "[email protected]",
    "due_date": "2021-08-02",
    "order_id": "id da order"
}'

Modelo de response

Retornamos nessa request o PIX copia e cola e a imagem do QRcode, para ser disponibilizado ao cliente final.

Após o cliente realizar o pagamento da fatura, será disparado pela iugu o gatilho invoice.status_change. Com ele é possível validar se a compra foi paga de fato, ou não, de acordo com seu status.


Did this page help you?