Skip to main content
GET
/
v2
/
account
/
{merchantId}
/
statement
Get Statement
curl --request GET \
  --url https://api.sandbox.wepayout.com.br/v2/account/{merchantId}/statement \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": 12345,
    "entity": "payin_transaction",
    "entity_id": 67890,
    "impact_balance": "available",
    "category": {
      "id": 1,
      "name": "PIX Payment"
    },
    "amount": 100.50,
    "available_balance": 1500.00,
    "balance": 1500.00,
    "reserve_balance": 0.00,
    "invoice": "INV-12345",
    "description": "Payment received",
    "occurrence_at": "2024-01-15T10:30:00-03:00",
    "created_at": "2024-01-15T10:30:00-03:00"
  },
  {
    "id": 12346,
    "entity": "payin_transaction_creditcard_fee",
    "entity_id": 67890,
    "impact_balance": "available",
    "category": {
      "id": 8,
      "name": "PIX Fee"
    },
    "amount": -2.50,
    "available_balance": 1497.50,
    "balance": 1497.50,
    "reserve_balance": 0.00,
    "invoice": null,
    "description": "PIX transaction fee",
    "occurrence_at": "2024-01-15T10:30:00-03:00",
    "created_at": "2024-01-15T10:30:00-03:00"
  }
]

​
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
[
  {
    "id": 12345,
    "entity": "payin_transaction",
    "entity_id": 67890,
    "impact_balance": "available",
    "category": {
      "id": 1,
      "name": "PIX Payment"
    },
    "amount": 100.50,
    "available_balance": 1500.00,
    "balance": 1500.00,
    "reserve_balance": 0.00,
    "invoice": "INV-12345",
    "description": "Payment received",
    "occurrence_at": "2024-01-15T10:30:00-03:00",
    "created_at": "2024-01-15T10:30:00-03:00"
  },
  {
    "id": 12346,
    "entity": "payin_transaction_creditcard_fee",
    "entity_id": 67890,
    "impact_balance": "available",
    "category": {
      "id": 8,
      "name": "PIX Fee"
    },
    "amount": -2.50,
    "available_balance": 1497.50,
    "balance": 1497.50,
    "reserve_balance": 0.00,
    "invoice": null,
    "description": "PIX transaction fee",
    "occurrence_at": "2024-01-15T10:30:00-03:00",
    "created_at": "2024-01-15T10:30:00-03:00"
  }
]

​
Transaction Categories

The statement includes various transaction categories. Use the category ID when filtering:
IDNameDescription
1PIX PaymentPIX payment received
2PIX ReversalPIX payment reversal
3TED PaymentTED transfer payment
4TED ReversalTED transfer reversal
5Transfer Between WE AccountsInternal transfers between WE accounts
6TransferGeneral transfers
7Boleto PaymentBoleto payment received
8PIX FeePIX transaction fee
9Boleto FeeBoleto transaction fee
10TED FeeTED transfer fee
11Merchant Note SettlementSettlement entry
12Merchant Note TaxTax entry
13Merchant Note GenericGeneric merchant note
14Transfer FeeTransfer transaction fee
15OthersOther transactions
16Rolling ReserveRolling reserve
17Credit Card TransactionCredit card payment
18Credit Card FeeCredit card fee
51Merchant Note Judicial FreezeJudicial freeze
52PIX RefundPIX refund
53MarkupMarkup fee
54Current BalanceCurrent balance
Example: To filter PIX-related transactions (payments and fees), use: ?category_id=1,8