Listing Transactions by Order Id

Reference Endpoint

GET /accounts/transactions/pix

The Request Params (Useful Example)

/accounts/transactions/pix?transactionOrderId=c2782914-4d75-4fbb-8618-695a8d159316&startDate=2024-02-07T10:00:00.000Z&endDate=2024-02-08T10:00:00.000Z&dataset.limit=10&dataset.offset=0

Path Param	Type	Required	Description
transactionOrderId	string	true	The transaction orderId as specified by you in the original request.
startDate	string	true	The initial timestamp.
endDate	string	true	The fiinal timestamp. The maximum search interval should be of one day.
dataset.limit	number	true	The pagination size as one of: 5, 10 or 20.
dataset.offset	number	true	The pagination offset, starting from 0.

Transaction Response Object

{
    "statusCode": "Done",
    "data": {
        "limit": 10,
        "offset": 0,
        "total": 1,
        "items": [
            {
                "transaction": {
                    "id": "f893693e-6d72-4a96-8091-aa1f7b4aaeb9",
                    "orderId": "36a857f8-da25-4bd5-b7d6-43fab7139efc",
                    "orderDescription": "",
                    "date": "2024-10-02T15:15:27.339Z",
                    "stateRegisteredDate": "2024-10-02T15:15:27.347Z",
                    "stateCompletedDate": "2024-10-02T15:26:59.173Z",
                    "stateCancelledDate": null,
                    "stateRefundDate": null,
                    "stateReversedDate": null,
                    "stateErrorDate": null,
                    "stateErrorCause": null,
                    "type": "Credit",
                    "paymentType": "PIX",
                    "amount": "0.990000",
                    "currency": "BRL",
                    "state": "Completed",
                    "charges": "0.000000",
                    "chargesObject": {
                        "costValue": "0",
                        "rateValue": "0",
                        "rate": "0.00"
                    },
                    "receiptVoucher": "12BB4558FD1045C1AFBFFB4B76A2EE7D",
                    "payer": {
                        "name": "Jemerson Damasio",
                        "taxNumber": "04368535405"
                    }
                },
                "payment": {
                    "payer": {
                        "name": "TestBank Sandbox Ltda",
                        "cpf": null,
                        "cnpj": "99999990000001"
                    }
                },
                "webhook": {
                    "deliveryStatus": "Sent"
                }
            }
        ]
    }
}

📘
Detailing the Transaction Item
At this point you should be familiar with the transaction object, but if not, please refer to our previous section about the Transaction Information endpoint.