Get Account Statements

Get Account Statements

GET{{Environment_URL}}/vendors/v1/charges/balance

Account Statements lists operations that were effectively paid, based on Payin/Deposit records, as well as withdrawal transactions derived from Payout/Withdrawal records.

Headers

Name	Value
Authorization	Bearer <token>

Path Params

Key	Description	Required	Data Type	Example
page	Current page	false	Number	1
limit	Number of documents per page	false	Number	50
id	Charge or Batch ID	false	String	ch_74pq9wxyunl6zrsediovay2hjk
account	User Account ID. Primarily used for comm.PIX Users (Account Type)	false	String	acc_48qpvel2xn9us51qqb3whysrl
financialId	Batch ID. Used to find the Charges linked to specified Batch	false	String	fin_48qpvel2xn9us51qqb3whysrl
action	Transaction type action referring the money path	false	String	PAYIN PAYOUT PAYIN_REFUND
createdAtStart	Lists based on date interval. createdAtStart must be used with createdAtEnd	false *	String	2025-01-01
createdAtEnd	Lists based on date interval. createdAtEnd must be used with createdAtStart	false *	String	2025-02-01

Response

200 - OK

{
    "page": 1,
    "totalPages": 5,
    "docsShown": 15,
    "totalDocs": 69,
    "docs": [
        {
            "createdAt": "2025-03-24T18:41:44.013Z",
            "id": "ch_74pq9wxyunl6zrsediovay2hjk",
            "resource": "COMM.PIX",
            "action": "PAYIN",
            "status": "SUCCEEDED",
            "amount": 200000,
            "transactionType": "DEPOSIT",
            "currency": "EUR",
            "account": {
                "id": "acc_48qpvel2xn9us51qqb3whysrl",
                "name": "CASHIER_DALLAS_01",
                "mpath": "acc_48qpvel2xn9us51qqb3whysrl.",
                "type": "ADMINISTRATOR"
            },
            "vendor": {
                "id": "vnd_75pq9ssykkl6zrsedfghvay2ggk",
                "name": "Tony's Superpizza"
            },
            "receiverReferenceId": "vnd_75pq9ssykkl6zrsedfghvay2ggk",
            "receiverReferenceName": "Tony's Superpizza",
            "financialId": "fin_01jq4ddm5w6gqbr0q4eyzbgghd",
            "balance": 822669
        }
    ]
}