查询 Payment Order

请求

此端点允许查询与 Pix 自动定期付款关联的特定付款订单的详细信息。

ENDPOINT

/account/ACCOUNT_KEY/outgoing_recurrence/OUTGOING_RECURRENCE_KEY/payment_order/PAYMENT_ORDER_KEY

方法

GET

Path Params

字段	类型	描述	字符数
account_key	uuidv4	账户的唯一标识键。	36
outgoing_recurrence_key	uuidv4	待查询的定期付款唯一键。	36
payment_order_key	uuidv4	待查询的付款订单唯一键。	36

Response Body

STATUS

200

Response Body

{
    "outgoing_recurrence_spi_id": "RR2222222220240429njua7shf40k",
    "payment_order_status": "paid",
    "reference_date": "2025-06-30",
    "payment_order_conciliation_batch_key": "21fc62fd-b0a0-4604-9bea-475e91a9dc82",
    "receiver_conciliation_id": "cac0b5f7-4ee2-40f1-b2ad-16902506503d",
    "transaction_amount": 125.53,
    "transaction_key": "21fc62fd-b0a0-4604-9bea-475e91a9dc56",
    "incoming_pix_transfer_key": "21fc62fd-b0a0-4604-9bea-475e91a9dc56",
    "debtor_account_data": {
        "account_number": "897465",
        "account_digit": "1",
        "account_branch": "0123",
        "ispb": "323243"
    },
    "created_at": "2021-10-22T20:30:23.459Z",
    "paid_at": "2023-10-22T20:30:23.459Z",
    "payment_order_attempts": [
        {
            "payment_order_attempt_key": "uuid",
            "end_to_end_id": "id",
            "payment_order_attempt_status": "sent",
            "payment_order_attempt_error": {
                "code": "code",
                "description": "description do error",
                "translation": "translation"
            },
            "created_at": "2021-10-22T20:30:23.459Z"
        }
    ]
}

Response Body Params

字段	类型	描述	字符数
outgoing_recurrence_spi_id	string	自动定期付款的 SPI ID。	36
payment_order_status	string	付款订单的当前状态。	Enumeradores payment_order_status
reference_date	string	收费参考日期。	10
payment_order_conciliation_batch_key	uuidv4	付款订单对账批次键。	36
receiver_conciliation_id	uuidv4	接收方对账 ID。	36
transaction_amount	number	交易金额。	-
transaction_key	uuidv4	交易唯一键。	36
incoming_pix_transfer_key	uuidv4	收到的 Pix 转账键。	36
debtor_account_data	object	债务人账户数据。	Objeto debtor_account_data
created_at	string	订单创建日期/时间。	-
paid_at	string	付款日期/时间。	-
payment_order_attempts	array	订单的付款尝试记录。	Array payment_order_attempts

Objeto debtor_account_data

字段	类型	描述	字符数
account_number	string	账户号码。	-
account_digit	string	账户校验位。	-
account_branch	string	支行。	-
ispb	string	金融机构 ISPB。	-

Array payment_order_attempts

字段	类型	描述	字符数
payment_order_attempt_key	string	付款尝试的唯一键。	36
end_to_end_id	string	尝试的端到端标识符。	36
payment_order_attempt_status	string	付款尝试状态。	-
payment_order_attempt_error	object	与付款尝试关联的错误。	Objeto payment_order_attempt_error
created_at	string	尝试创建日期/时间。	-

Objeto payment_order_attempt_error

字段	类型	描述	字符数
code	string	错误代码。	-
description	string	错误描述。	-
translation	string	描述的翻译。	-

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
400	QIT000002	Bad Request	Invalid request schema.	Erro no esquema da requisição.
404	APX000002	Payment Order Not Found	Payment order {payment_order_key} not found.	Ordem de pagamento {payment_order_key} não encontrada.