Cancelar uma Ordem de Pagamento

Este endpoint permite cancelar uma ordem de pagamento específica associada a uma recorrência automática Pix.

atenção

Só é possível cancelar uma payment order que está em status de pending_conciliation ou pending, até as 22h do dia anterior ao reference_date.

Request

ENDPOINT

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

MÉTODO

PATCH

Path Params

Campo	Tipo	Descrição	Caracteres
ACCOUNT_KEY	uuidv4	Chave única de identificação da conta.	36
OUTGOING_RECURRENCE_KEY	uuidv4	Chave única da recorrência.	36
PAYMENT_ORDER_KEY	uuidv4	Chave única da ordem de pagamento a ser cancelada.	36

Request Body

Cancelar 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

Campo	Tipo	Descrição	Caracteres
payment_order_key	string	Chave única da ordem de pagamento.	36
payment_order_conciliation_batch_key	string	Chave do lote de conciliação da ordem de pagamento.	36
payment_order_status	string	Status atual da ordem de pagamento.	-

Enumeradores payment_order_status

Enumerador	Descrição
pending_conciliation	Aguardando conciliação.
pending	Pendente e ainda não processada.
accepted	Aceita e aguardando pagamento.
paid	Paga com sucesso.
rejected	Rejeitada e não será processada.
cancelled	Cancelada antes do pagamento.

STATUS

4XX

Response Error

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

Código HTTP	Código QI code	Título title	Descrição (eng) description	Descrição (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.