Query Payment Order

Request

This endpoint allows querying the details of a specific payment order associated with an automatic Pix recurrence.

ENDPOINT

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

METHOD

GET

Path Params

Field	Type	Description	Characters
account_key	uuidv4	Unique account identification key.	36
outgoing_recurrence_key	uuidv4	Unique key of the recurrence to be queried.	36
payment_order_key	uuidv4	Unique key of the payment order to be queried.	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

Field	Type	Description	Characters
outgoing_recurrence_spi_id	string	SPI ID of the automatic recurrence.	36
payment_order_status	string	Current status of the payment order.	payment_order_status Enumerators
reference_date	string	Reference date of the charge.	10
payment_order_conciliation_batch_key	uuidv4	Conciliation batch key of the payment order.	36
receiver_conciliation_id	uuidv4	Receiver conciliation ID.	36
transaction_amount	number	Transaction amount.	-
transaction_key	uuidv4	Unique transaction key.	36
incoming_pix_transfer_key	uuidv4	Incoming Pix transfer key.	36
debtor_account_data	object	Debtor account data.	debtor_account_data Object
created_at	string	Order creation date/time.	-
paid_at	string	Payment completion date/time.	-
payment_order_attempts	array	Payment attempts for the order.	payment_order_attempts Array

debtor_account_data Object

Field	Type	Description	Characters
account_number	string	Account number	-
account_digit	string	Account digit	-
account_branch	string	Branch	-
ispb	string	Financial institution ISPB	-

payment_order_attempts Array

Field	Type	Description	Characters
payment_order_attempt_key	string	Unique key of the payment attempt.	36
end_to_end_id	string	End-to-end identifier of the attempt.	36
payment_order_attempt_status	string	Status of the payment attempt.	-
payment_order_attempt_error	object	Error associated with the payment attempt.	payment_order_attempt_error Object
created_at	string	Attempt creation date/time.	-

payment_order_attempt_error Object

Field	Type	Description	Characters
code	string	Error code.	-
description	string	Error description.	-
translation	string	Description translation.	-

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	Cancelled 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	APX000002	Payment Order Not Found	Payment order {payment_order_key} not found.	Ordem de pagamento {payment_order_key} não encontrada.