取消 Pix 交易预约

Request

ENDPOINT

/account/ACCOUNT_KEY/pix_schedule/SCHEDULE_KEY/cancel

MÉTODO

PATCH

Path Params

字段	类型	描述	字符数
account_key	uuidv4	账户的唯一标识键。	36
schedule_key	uuidv4	预约的唯一标识键	36

Response

STATUS

200

Response Body: 预约已取消

{
  "request_control_key": "b6804f32-101e-4702-8fbc-c2dbc4c2caec",
  "schedule_key": "f64b3fa7-d09d-4927-ad4f-b966df9fb153",
  "schedule_status": "cancelled",
  "schedule_date": "2024-12-31",
  "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": {}
}

HTTP 代码 status	QI 代码 code	标题 title	描述（英文） description	描述（葡文） 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
400	PSC000028	Bad Request	Pix Schedule cannot be cancelled in current status	Agendamento pix não pode ser cancelado no status atual
400	PSC000029	Bad Request	The given Pix Schedule is tied to a batch. It cannot be individually cancelled	O agendamento pix enviado está ligado a um lote. Ela não pode ser individualmente cancelada