O banco 526 MONETARIE SOCIEDADE DE CRÉDITO DIRETO S.A foi incluído como domicílio bancário!

Endpoints atualizados

Os endpoints que receberam esta atualização foram:

• Enviar Verificação de Subconta — v1/accounts/{account_id}/request_verification.
• Adicionar Domicílio Bancário — v1/bank_verification.

Agora também é possível coletar o URL e/ou PDF do Boleto na API Cobrança Direta

Para os usuários que não utilizam o Checkout iugu e utilizam a API Cobrança Direta — POST /v1/charge para emissão de Boletos, agora é possível coletar o PDF e/ou a imagem deste boleto através das propriedades a seguir:

Requisição exemplo

{
  "method": "bank_slip",
  "email": "[email protected]",
  "items": [
    {
      "description": "Descrição",
      "quantity": 1,
      "price_cents": 500
    }
  ],
  "payer": {
    "cpf_cnpj": "113.436.750-30",
    "name": "Nome"
  }
}

Retorno exemplo

{
    "success": true,
    "url": "?bs=true",
    "pdf": ".pdf",
    "bank_slip_url": "https://boletos.iugu.com/v1/public/invoice/eaf26318-9dce-480d-962c-d0db4bc97ccf-60c3/bank_slip",
    "bank_slip_pdf_url": "https://boletos.iugu.com/v1/public/invoice/eaf26318-9dce-480d-962c-d0db4bc97ccf-60c3/bank_slip.pdf",
    "identification": "40192024257800000000600002057180198590000000500",
    "invoice_id": "EAF263189DCE480D962CD0DB4BC97CCF"
}

Importante ⚠️

Esta propriedade será retornada apenas se, durante a requisição, for informado bank_slip no parâmetro method.

Agora é possível listar todas as transações de cartão de crédito das subcontas a partir de uma Conta Mestre

Utilize o endpoint Listar Transações de Cartão de Crédito de Subcontas — GET /v1/accounts/credit_card_transactions informando o api_token da Conta Mestre.

Requisição exemplo

curl --request GET \
     --url 'https://api.iugu.com/v1/accounts/credit_card_transactions?api_token=api_token_da_conta-mestre' \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '
{
  "created_at_from": "2024-10-01T00:00:01"
}
'

Response exemplo

{
  "items": [
    {
      "id": "555099DFD7F5487B8C8517070431B3C8",
      "invoice_id": "C4D2C3C67B254DA09573C069837798BA",
      "account_id": "E68BF5BC96144DE48B9EFA0012C85756",
      "status": "unauthorized",
      "authorize_lr": null,
      "cancel_lr": null,
      "lr": "AF02",
      "holder_name": "NOME NO CARTÃO",
      "bin": 411111,
      "last4": "1111",
      "tid": null,
      "nsu": null,
      "arp": null,
      "created_at": "2024-10-01T15:21:46-03:00",
      "authorized_at": null,
      "canceled_at": null,
      "payer_cpf_cnpj": null,
      "payer_name": null,
      "email": "[email protected]",
      "test_mode": false
    }
  ],
  "totalItems": 1
}

** Realizado a atualização na documentação "Status Simulação da Antecipação" para melhor interpretação dos parâmetros e exemplo de retorno.

Status Simulação da Antecipação

Acionado sempre que uma simulação de Antecipação de recebíveis for finalizada.

🚧

Importante

Este gatilho é acionado por simulações de antecipação pelo Alia ou API Criar Simulação Antecipação — v1/advancement_request/simulation

event: advancement_request.simulation_status
  "data[status]": "done",
  "data[total_advance_fee_cents]": "311",
  "data[reached_amount_cents]": "13904",
  "data[average_days]": "3",
  "data[available_amount_cents]": "13904",
  "data[simulation_amount_cents]": "13904",
  "data[requested_amount_cents]": "13904"

RAW BODY
event=advancement_request.simulation_status&data%5Bstatus%5D=done&data%5Btotal_advance_fee_cents%5D=49&data%5Breached_amount_cents%5D=14587&data%5Baverage_days%5D=3&data%5Bavailable_amount_cents%5D=48378&data%5Bsimulation_amount_cents%5D=20000&data%5Brequested_amount_cents%5D=20000

Agora é possível criar um QR Code Pix com prazo de expiração!

No endpoint Criar Fatura — POST /v1/invoices, foi adicionado o parâmetro pix_qr_code_expires_at.

{
  "pix_qr_code_expires_at": "2024-09-05T19:52:37"
}

Importante

Este parâmetro deve seguir o parâmetro ISO 8601.

Agora é possível desativar subcontas!

Utilize o endpoint Desativar Subconta — /v1/marketplace/deactivate. No body da requisição, informe o account_id da conta que deseja desativar.

Requisição exemplo

curl --request POST \
     --url 'https://api.iugu.com/v1/marketplace/deactivate?api_token=your_live_api_token' \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '
{
  "account_id": "911E249555C24F28A30602D647A1CCBB"
}
'

Response exemplo

{
  "success": true,
  "message": "A conta está em processo de desativação, em alguns instantes será finalizado."
}

Importante ⚠️

Atente-se as informações importantes antes de requisitar este endpoint:

1. Ao requisitar este endpoint, todas as faturas, assinaturas e carnês pendentes serão cancelados e a conta terá o status unverified.
2. A conta não poderá ter saldo.
3. A requisição precisa ser feita utilizando o live_api_token da Conta Mestre.

Novos parâmetros no endpoint de Criar Fatura - POST /v1/invoices.

pix_remittance_info``string , - Máximo 140 caracteres,
pix_additional_info``array of objects , - Máximo 5 itens. Cada item deste array, precisa conter "nome"e "valor".
name (string) - Limite de 50 caracteres.
value (string) - Limite de 200 caracteres.

Response exemplo:

pix_additional_info — array of objects

       "variables": {
            "variable": "pix_additional_info",
            "value": "[{\"nome\":\"Foo\",\"valor\":\"Bar\"}]"
        },
        {
            "variable": "pix_remittance_info",
            "value": "Teste info"
        }
    ],

Versão 3.1.12 disponível!

Acesse a nova versão por aqui e, antes de atualizar, desative qualquer versão anterior a 3.1.11.

Notas de atualização

• Correção: Removido avisos de incompatibilidade com parâmetros depreciados.
• Correção: Adicionada mensagem de incompatibilidade com "High-performance order storage".

Realizado a adição do parâmetro 'customer_minimum_balance_cents' no response da chamada https://api.iugu.com/v1/accounts/{id} .

     "informations": {
      "key": "customer_minimum_balance_cents",
      "value": "500"
    },

Agora é possível alterar os Métodos de Pagamento durante a alteração de um Plano da Assinatura

O parâmetro payable_with foi adicionado ao endpoint Alterar Plano da Assinatura — v1/subscriptions/{id}/change_plan/{plan_identifier}, permitindo que o Método de Pagamento daquela Assinatura também seja alterado. Antes, era necessário usar a API Editar Assinatura para, só então, utilizar este endpoint. Resultando em uma chamada a mais.

Abaixo um exemplo do objeto payable_with:

{
  "payable_with": [
    "pix, 
    credit_card, 
    bank_slip"
  ]
}

📘

E o all?

Também é possível utilizar o valor all se o Plano contar com todos os métodos.

Importante

Deve-se inserir apenas os métodos disponíveis no Plano especificado no parâmetro plan_identifier. Caso contrário, será retornado o erro a seguir:

422

{
  "payable_with": "são incompatíveis com o plano. Métodos disponíveis no plano: [método(s)]"
}

Dica💡

Utilize o endpoint Buscar Plano pelo Identificador ou Buscar Plano para consultar os métodos de pagamento do plano escolhido.