Check Account Statement

This endpoint is used to check the bank account statement.

Params (Query Params)

ParameterValueDescriptionExample
account_branch_identifierNumberThis field should be filled with the branch number you wish to inquire about. Branch numbers always consist of 4 digits.0001
account_numberNumberIn this field, you should fill in the bank account number you wish to inquire about. A bank account number does not have a specific pattern and may vary in length depending on the financial institution. (Example: Accounts registered with SaQ.Digital typically have 6 characters).401050
startStringThis field must be filled with the start date.2024-06-01T00%3A00%3A22Z
endStringThis field must be filled with the end date.2024-12-30T00%3A00%3A22Z

Headers

ParameterTypeDescriptionExample
AuthorizationStringBearer + Access_tokenBearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiYWNjZXNzIiwiZXhwIjoxNzEzMzAwOTMxLCJpYXQiOjE3MTMyOTczMzEsImp0aSI6Ijc2ZWI4ZTE5ZjM4YjQ4NmZiODdmNzNjNTdkMWVmNDJhIiwidXNlcl9pZCI6MjQ2fQ.5zekMa7CUj9p-MvNHns5ke4ZPhYV3Y1CLOsYL7hDUUo

Response Details

{
    "worked": true,
    "statement": [
        {
            "credit_or_debit": "CREDIT",
            "amount": 5.0,
            "date_time": "2024-04-11T13:53:18.823",
            "date_time_utc": "2024-04-11T16:53:18.823",
            "name": "xxxxxx xxxxxx xxxxxx",
            "document": "***557567**",
            "identification": "PIXREC",
            "code_transaction": "xxxxx8be-xxxx-xxxx-xxxx-08dcxxxxxx38",
            "code": "68xxxxce-xxxx-xxxx-xxxx-xxxxxx7c"
        },
        {
            "credit_or_debit": "DEBIT",
            "amount": 3.8,
            "date_time": "2024-04-11T14:40:05.433",
            "date_time_utc": "2024-04-11T17:40:05.433",
            "name": "xxxxxx xxxxx xxxxxx",
            "document": "***557567**",
            "identification": "PIXREC",
            "code_transaction": "6xxxx73-c631-xxxx-xxxx-xxxxxxxxxx",
            "code": "68xxxxce-xxxx-xxxx-xxxx-xxxxxx7c"
        },
    ]
}

FieldDescription
credit_or_debitThis field returns whether a debit or credit Pix occurred in the banking transaction.
amountThis field returns the value of the transaction Pix was made.
date_timeThis field returns the date/time when the transaction Pix was made.
date_time_utcThis field returns the date/time of the transaction converted to the Europe/London international time zone.
nameThis field returns the name of the person or company involved in the Pix transaction.
documentThis field returns the document (CPF or CNPJ) of the resource involved in the Pix transaction.
identificationPIXENV: This identification code indicates that a PIX transfer was made (PIX cashout, Transfer, debit) PIXREC: This identification code indicates that a value was received in the account (PIX cash in, credit) PIXDEV: This identification code indicates that a value was refunded. (Chargeback, Refund Pix Transactions, Debit)
code_transactionReturns the Unique Pix payment identifier generated (UUID). This value never repeats; it's a universal tracking value for the payment among the involved banking institutions.
codeReturns the Unique Pix payment identifier generated (UUID). This value never repeats; it's a universal tracking value for the payment among the involved banking institutions.
Language
Click Try It! to start a request and see the response here!