Consultar Payment Order

Request

Este endpoint permite consultar os detalhes de uma payment order específica associada a uma recorrência automática Pix.

ENDPOINT

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

MÉTODO

GET

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 a ser consultada.	36
payment_order_key	uuidv4	Chave única da ordem de pagamento a ser consultada.	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

Campo	Tipo	Descrição	Caracteres
outgoing_recurrence_spi_id	string	ID da SPI da recorrência automática.	36
payment_order_status	string	Status atual da ordem de pagamento.	Enumeradores payment_order_status
reference_date	string	Data de referência da cobrança.	10
payment_order_conciliation_batch_key	uuidv4	Chave do lote de conciliação da ordem de pagamento.	36
receiver_conciliation_id	uuidv4	ID de conciliação do recebedor.	36
transaction_amount	number	Valor da transação.	-
transaction_key	uuidv4	Chave única da transação.	36
incoming_pix_transfer_key	uuidv4	Chave de transferência Pix recebida.	36
debtor_account_data	object	Dados da conta devedor.	Objeto debtor_account_data
created_at	string	Data/hora de criação da ordem.	-
paid_at	string	Data/hora do pagamento efetuado.	-
payment_order_attempts	array	Tentativas de pagamento da ordem.	Array payment_order_attempts

Objeto debtor_account_data

Campo	Tipo	Descrição	Caracteres
account_number	string	Número da conta	-
account_digit	string	Dígito da conta	-
account_branch	string	Agência	-
ispb	string	ISPB da instituição financeira	-

Array payment_order_attempts

Campo	Tipo	Descrição	Caracteres
payment_order_attempt_key	string	Chave única da tentativa de pagamento.	36
end_to_end_id	string	Identificador end-to-end da tentativa.	36
payment_order_attempt_status	string	Status da tentativa de pagamento.	-
payment_order_attempt_error	object	Erro associado à tentativa de pagamento.	Objeto payment_order_attempt_error
created_at	string	Data/hora de criação da tentativa.	-

Objeto payment_order_attempt_error

Campo	Tipo	Descrição	Caracteres
code	string	Código do erro.	-
description	string	Descrição do erro.	-
translation	string	Tradução da descrição.	-

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