Cancel a Payment Order

This endpoint allows canceling a specific payment order associated with an automatic Pix recurrence.

warning

It is only possible to cancel a payment order that has pending_conciliation or pending status, until 10 PM on the day before the reference_date.

Request

ENDPOINT

/automatic_pix/account/ACCOUNT_KEY/outgoing_recurrence/OUTGOING_RECURRENCE_KEY/payment_order/PAYMENT_ORDER_KEY/cancel

METHOD

PATCH

Path Params

Field	Type	Description	Characters
ACCOUNT_KEY	uuidv4	Unique account identification key.	36
OUTGOING_RECURRENCE_KEY	uuidv4	Unique recurrence key.	36
PAYMENT_ORDER_KEY	uuidv4	Unique key of the payment order to be canceled.	36

Request Body

Cancel Payment Order

{}

Response

STATUS

200

Response Body

{
    "payment_order_key": "10fc62fd-b0a0-4604-9bea-475e91a9dc82",
    "payment_order_conciliation_batch_key": "11fc62fd-b0a0-4604-9bea-475e91a9dc82",
    "payment_order_status": "cancelled"
}

Response Body Params

Field	Type	Description	Characters
payment_order_key	string	Unique key of the payment order.	36
payment_order_conciliation_batch_key	string	Key of the payment order conciliation batch.	36
payment_order_status	string	Current status of the payment order.	-

payment_order_status Enumerators

Enumerator	Description
pending_conciliation	Awaiting conciliation.
pending	Pending and not yet processed.
accepted	Accepted and awaiting payment.
paid	Successfully paid.
rejected	Rejected and will not be processed.
cancelled	Canceled before payment.

STATUS

4XX

Response Error

{
  "title": "titulo",
  "description": "description in English",
  "translation": "descrição em português",
  "code": "codigo"
}

HTTP Code	QI Code code	Title title	Description (eng) description	Description (ptbr) translation
400	QIT000002	Bad Request	Invalid request schema.	Erro no esquema da requisição.
404	APX000404	Payment Order Not Found	Payment Order {payment_order_key} not found.	Lote de conciliação {payment_order_key} não encontrado.