List account statement

GET https://api.somossimpay.com.br/v2/finance/account-statements/{account_branch_identifier}/{account_number}

This endpoint is used to query the bank account balance.

Params (Query Params)

Parameter	Value	Description	Example
account_branch_identifier	Number	Required. The bank branch identifier/agency code	Ex: 0001
account_number	Number	Required. The account number	Ex: 401050

Headers

Parameter	Type	Description	Example
Authorization	String	Bearer + Access_token	Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiYWNjZXNzIiwiZXhwIjoxNzEzMzAwOTMxLCJpYXQiOjE3MTMyOTczMzEsImp0aSI6Ijc2ZWI4ZTE5ZjM4YjQ4NmZiODdmNzNjNTdkMWVmNDJhIiwidXNlcl9pZCI6MjQ2fQ.5zekMa7CUj9p-MvNHns5ke4ZPhYV3Y1CLOsYL7hDUUo

Params (Query Params)

Parameter	Type	Description	Example
start	datetime	Required. Start datetime in ISO format	start=2023-10-01T00:00:00
end	datetime	Required. End datetime in ISO format	end=2023-10-31T23:59:59
limit	integer	Optional. Number of records per page (Min: 1, Max: 100, Default: 50)	limit=20
cursor_id	integer	Optional. Cursor ID for pagination navigation	cursor_id=12345
cursor_datetime	datetime	Optional. Cursor datetime for pagination navigation (ISO 8601 format)	cursor_datetime=2023-10-15T14:30:00
cursor_direction	string	Optional. Pagination direction: next or previous (Default: next)	cursor_direction=next

Example Requests

Basic Request

GET /v3/account-statements/1234/567890?start=2023-10-01T00:00:00&end=2023-10-31T23:59:59

Request with Pagination

GET /v3/account-statements/1234/567890?start=2023-10-01T00:00:00&end=2023-10-31T23:59:59&limit=25&cursor_direction=next

cURL Example

curl -X GET "https://api.saq.digital/v3/account-statements/1234/567890?start=2023-10-01T00:00:00&end=2023-10-31T23:59:59&limit=50" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"

Important Filter Rules

Pagination Flow:

1. First Request: Make a request without cursor parameters
2. Next Page: Use the next URL from the response
3. Previous Page: Use the previous URL from the response
4. Direction Control: Use cursor_direction parameter ("next" or "previous")

Pagination Example Flow

# Step 1: First request
GET /v3/account-statements/1234/567890?start=2023-10-01T00:00:00&end=2023-10-31T23:59:59&limit=10

# Step 2: Use the "next" URL from response
GET /v3/account-statements/1234/567890?start=2023-10-01T00:00:00&end=2023-10-31T23:59:59&limit=10&cursor_id=12345&cursor_datetime=2023-10-15T14:30:00&cursor_direction=next

Response Schema (200 OK)

JSON

{
  "next": "https://api.saq.digital/v3/account-statements/1234/567890?cursor_id=12345&cursor_datetime=2023-10-15T14:30:00&cursor_direction=next",
  "previous": null,
  "results": [
    {
      "credit_or_debit": "CREDIT",
      "transaction_type": "PIX_CASHIN",
      "amount": 1500.50,
      "date_time": "2023-10-15T14:30:00",
      "date_time_utc": "2023-10-15T14:30:00Z",
      "identification": "PIX123456789",
      "code_transaction": "PIX123456789",
      "code": 12345,
      "qr_code_id": 98765,
      "transaction_id": 54321,
      "tag_id": "TAG_ABC123"
    },
    {
      "credit_or_debit": "DEBIT",
      "transaction_type": "PIX_CASHOUT",
      "amount": 750.25,
      "date_time": "2023-10-15T10:15:00",
      "date_time_utc": "2023-10-15T10:15:00Z",
      "identification": "PIX987654321",
      "code_transaction": "PIX987654321", 
      "code": 12346,
      "qr_code_id": null,
      "transaction_id": 54322,
      "tag_id": "TAG_XYZ789"
    }
  ]
}

Response Fields

Main Response

Field	Type	Description
worked	boolean	Indicates if the request was processed successfully
next	string\	null	URL for the next page (null if no more pages)
previous	string\	null	URL for the previous page (null if first page)
results	array	List of MED records

Statement Item Fields

Field	Type	Description
credit_or_debit	enum	Transaction direction: "CREDIT" or "DEBIT"
transaction_type	enum	URL for the next page (null if no more pages)
amount	decimal	Transaction amount
date_time	datetime	Transaction datetime
date_time_utc	datetime	Transaction datetime in UTC
identification	string\	null	Transaction identification
code_transaction	string\	null	Transaction code
code	integer	Internal transaction code
qr_code_id	integer\	null	QR code ID if applicable
transaction_id	integer\	null	Associated transaction ID
tag_id	string\	null	Transaction tag identifier

Transaction Enums

Value	Description
CREDIT	Money entering the account (cashin)
DEBIT	Money leaving the account (cashout)

Transaction Types (transaction_type)

Value	Description
PIX_CASHIN	PIX incoming payment received
PIX_CASHOUT	PIX outgoing payment sent
PIX_CASHIN_TAX	Tax charged on PIX incoming payment
PIX_CASHOUT_TAX	Tax charged on PIX outgoing payment
PIX_CASHOUT_TAX_MED	Tax charged on PIX outgoing payment for MED
PIX_CHARGEBACK	PIX chargeback transaction
PIX_CHARGEBACK_REFUND	Refund of a PIX chargeback
PIX_CASHOUT_REFUND	Refund of a PIX outgoing payment
PIX_CREDIT_IN_ACCOUNT	PIX credit directly added to account