Cancel batch Pix transaction scheduling

Request

ENDPOINT

/account/ACCOUNT_KEY/pix_schedule_batch/SCHEDULE_BATCH_KEY/cancel

METHOD

PATCH

Path Params

Field	Type	Description	Characters
account_key	uuidv4	Unique account identification key.	36
schedule_batch_key	uuidv4	Unique batch schedule identification key.	36

Response

STATUS

200

Response Body: Schedule Cancelled

{
  "request_control_key": "b6804f32-101e-4702-8fbc-c2dbc4c2caec",
  "schedule_batch_key": "f64b3fa7-d09d-4927-ad4f-b966df9fb153",
  "schedule_batch_status": "cancelled",
  "created_at": "2023-03-13T19:00:28.440Z"
}

STATUS

4xx

Response Body: Error

{
  "title": "titulo",
  "description": "description in English",
  "translation": "description in portuguese",
  "code": "codigo",
  "extra_fields": {}
}

HTTP Code status	QI Code code	Title title	Description (eng) description	Description (ptbr) translation
400	QIT000001	Bad Request	schema error description	Schema Inválido
404	PSC000001	Account not Found	Account was not found	Conta não encontrada
403	PSC000012	User is not allowed to do this transaction	User is not allowed to do this transaction	Usuário não tem autorização para fazer essa transação
404	PSC000025	PixSchedule not Found	PixSchedule was not found	PixSchedule não encontrada
400	PSC000027	Bad Request	Action cannot be taken place as there is currently a pending transfer in progress	A ação não pôde ser completada como há uma transferência pendente
404	PSC000042	Schedule Batch not Found	ScheduleBatch was not found	ScheduleBatch não encontrada
400	PSC000043	Schedule Batch could not be canceled	ScheduleBatch could not be canceled due to current date being equal or after earliest schedule date. Cancel pix_schedules one by one	ScheduleBatch não pode ser cancelada devido a data atual ser superior ou igual à menor schedule_date. Cancele pix_schedules individualmente
400	PSC000044	Bad Request	Schedule Batch cannot be cancelled in current status	Agendamento pix não pode ser cancelado no status atual