跳到主要内容

取消付款订单

此端点允许取消与 Pix 自动定期付款关联的特定付款订单。

注意

只能取消状态为 pending_conciliation 或 pending 的付款订单，且必须在 reference_date 前一天的 22 时之前完成。

请求​

ENDPOINT
/automatic_pix/account/ACCOUNT_KEY/outgoing_recurrence/OUTGOING_RECURRENCE_KEY/payment_order/PAYMENT_ORDER_KEY/cancel
方法
PATCH

Path Params​

字段类型描述字符数
ACCOUNT_KEYuuidv4账户的唯一标识键。36
OUTGOING_RECURRENCE_KEYuuidv4定期付款的唯一键。36
PAYMENT_ORDER_KEYuuidv4待取消的付款订单唯一键。36

Request Body​

取消 Payment Order
{}

响应​

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​

字段类型描述字符数
payment_order_keystring付款订单的唯一键。36
payment_order_conciliation_batch_keystring付款订单对账批次键。36
payment_order_statusstring付款订单的当前状态。-

Enumeradores payment_order_status​

枚举值描述
pending_conciliation等待对账。
pending待处理，尚未处理。
accepted已接受，等待付款。
paid成功付款。
rejected已拒绝，不会处理。
cancelled付款前已取消。
STATUS
4XX
Response Error
{
  "title": "titulo",
  "description": "description in English",
  "translation": "descrição em português",
  "code": "codigo"
}
HTTP 状态码QI 代码
code		标题
title		描述（英文）
description		描述（葡文）
translation
400QIT000002Bad RequestInvalid request schema.Erro no esquema da requisição.
404APX000404Payment Order Not FoundPayment Order {payment_order_key} not found.Lote de conciliação {payment_order_key} não encontrado.