Cancel TED Batch Schedule Transaction

Request

ENDPOINT

/account/ACCOUNT_KEY/ted_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 schedule batch identification key	36

Response

STATUS

200

Response Body: Cancelled Schedule

{
  "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": "descrição em portugues",
  "code": "codigo",
  "extra_fields": {}
}

STATUS

4xx

Response Body: Error

{
  "title": "titulo",
  "description": "description in English",
  "translation": "descrição em portugues",
  "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	TED000009	Not Found	Account not found for the given key: {account_key}	Conta não encontrada para a chave fornecida: {account_key}
403	TED000018	Unauthorized	Provided account not owned by SELECTED_AGENT	Conta fornecida não pertencente ao SELECTED_AGENT
400	TED000096	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	TED000101	TedBatch not Found	TedBatch was not found	TedBatch não encontrada
404	TED000103	ScheduleBatch not Found	Ted Schedule Batch was not found	Agendamento de Ted em lote não encontrado
400	TED000104	Invalid Status	Schedule Batch cannot be cancelled in current status	Lote de agendamento não pode ser cancelado no status atual
400	TED000105	Schedule Batch could not be cancelled	ScheduleBatch could not be cancelled due to current date being equal or after earliest schedule date. Cancel schedules one by one	ScheduleBatch não pode ser cancelada devido a data atual ser superior ou igual à menor schedule_date. Cancele agendamentos individualmente