IUiugu

Cancelar Pix Agendado

Utilize o live_api_token<br><br>Cancela um PIX previamente agendado. Importante: O status da transferência deve ser scheduled.

patch/transfer_requests/{id}/scheduled_cancel

Request

  • Base URL
    https://api.iugu.com/v1
  • URL
    https://api.iugu.com/v1/transfer_requests/{id}/scheduled_cancel
  • Auth
    API key in query parameter api_token

Path parameters

idstring required

ID da Transferência. Informada no retorno do endpoint Transferência para Terceiros — /v1/transfer_requests na propriedade transfer_request_id.

Response

200

transfer_request_idstring
created_atstring
amount_centsinteger
transfer_typestring
end_to_end_idstring
external_referenceunknown
receipt_urlstring
statusstring

Example response

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

Changes

No recorded changes to this operation across all 1 revision of this API.