added

11/02/25 — Novo endpoint: Cancelar PIX Agendado!

Mudou de ideia? Então cancele seu o PIX Agendado com a rota PATCH /v1/transfer_requests/{id}/scheduled_cancel

Este endpoint permite cancelar, individualmente, um PIX que foi Agendado. Para isso, basta informar o ID da Transferência que é sempre disponibilizado no retorno do endpoint Transferência para TerceirosPOST /v1/transfer_requests na propriedade transfer_request_id.

Requisição exemplo

curl --request PATCH \
     --url 'https://api.iugu.com/v1/transfer_requests/AB2483B68CA624DC98A88AFC7D1565213/scheduled_cancel?api_token=seu-api_token' \
     --header 'accept: application/json'

Retorno exemplo

{
    "transfer_request_id": "E2483B68CA624DC98A88AFC7D1565213",
    "created_at": "2025-02-11T11:28:08-03:00",
    "amount_cents": 10,
    "transfer_type": "pix",
    "end_to_end_id": "E151119752025021114280e7d38e1745",
    "external_reference": null,
    "receipt_url": "https://comprovantes.iugu.test/e2483b68-ca62-4dc9-8a88-afc7d1565213-d52c04",
    "status": "cancelled"
}

Importante ⚠️

O status desta transferência deve ser scheduled. Se não, o erro abaixo será retornado:

{
  "errors": "Status da transferência deve ser igual a agendado."
}

Não tem acesso ao transfer_request_id?

Caso não tenha a este ID, utilize o endpoint Listar Comprovantes de Transferências para TerceirosGET /v1/transfer_requests/. Busque pela transferência deseja e atente-se a propriedade id.