Skip to main content
GET
Get Statement

Path Parameters

merchantId
string
required
Merchant ID

Query Parameters

id
string
Specific statement ID
entity
string
Filter by entity typeAllowed values: payout_merchant_note, payout_deposit, payout_transaction, payout_data_qualification, payin_transaction, payin_transaction_split, payin_transaction_creditcard, payin_transaction_creditcard_fee, payin_transaction_creditcard_split, payin_transaction_creditcard_installment, payin_transaction_creditcard_installment_fee, payin_transaction_creditcard_installment_split, payin_transaction_creditcard_installment_parent_split, payin_transaction_creditcard_parent_split_fee, payin_withdrawal, payin_transaction_refund, payin_transaction_rolling_reserve, payout_pix_reversal,
category_id
string
Category IDs separated by commaExample: 1,8,9
use_for_billing
string
Filter by billing usage
created_after
string
Initial creation date (format: YYYY-MM-DD)Example: 2024-01-01
created_before
string
Final creation date (format: YYYY-MM-DD)Example: 2024-01-31
occurrence_after
string
Initial occurrence date (format: YYYY-MM-DD)Example: 2024-01-01
occurrence_before
string
Final occurrence date (format: YYYY-MM-DD)Example: 2024-01-31
recipient_id
string
Recipient ID
currency
string
CurrencyAllowed values: USD, AUD, EUR, BRL, GBP, CAD, CHF
Required: Must provide created_after/created_before OR occurrence_after/occurrence_before OR id
page
integer
Page number
per_page
integer
Quantity of items per page

Response Headers

x-next-page
string
Next page number
x-page
string
Current page number
x-per-page
string
Total items per page
x-prev-page
string
Previous page number
x-total
string
Total count of records
x-value
string
Boolean indicating if results exist
x-total-pages
string
Total pages

Response Body

array
array
Array of statement entries

Transaction Categories

The statement includes various transaction categories. Use the category ID when filtering: Example: To filter PIX-related transactions (payments and fees), use: ?category_id=1,8