Cancel a Pix Request Schedule (logical delete)

​

Sets the schedule status to INACTIVE. Does not remove the record from the database.

Path Parameters
  • id
    Type: string Format: uuid
    required
Headers
  • Idempotency-Key
    Type: string
    required
Responses
  • 204

    Schedule cancelled

  • 400

    Invalid request

    Erros desta resposta

    Código interno HTTP Descrição Erro normativo Bacen
    PIX-SCH-0006 400 Schedule not found —
    PIX-SCH-0007 400 Schedule already cancelled —
    PIX-SCH-0008 400 Schedule already completed —
  • 404

    Schedule not found

Request Example for delete/api/v1/pix-schedules/{id}
curl http://localhost/api/v1/pix-schedules/123e4567-e89b-12d3-a456-426614174000 \
  --request DELETE \
  --header 'Idempotency-Key: ' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
No Body

Schedule cancelled