Get Statement

Path Parameters

merchantId

string

required

Merchant ID

Query Parameters

category_id

string

Filter by transaction category IDs (comma-separated integers)Example: 1,8,9 (PIX Payment, PIX Fee, Boleto Fee)

created_after

string

Filter statements created after this date (YYYY-MM-DD)Example: 2024-01-01Note: Either created_after/created_before OR occurrence_after/occurrence_before is required

created_before

string

Filter statements created before this date (YYYY-MM-DD)Example: 2024-01-31

occurrence_after

string

Filter statements by occurrence date after this date (YYYY-MM-DD)Example: 2024-01-01Note: Either created_after/created_before OR occurrence_after/occurrence_before is required

occurrence_before

string

Filter statements by occurrence date before this date (YYYY-MM-DD)Example: 2024-01-31

string

Filter by specific statement ID

entity

string

Filter by entity type (e.g., payin, payout)

use_for_billing

string

Filter statements used for billing

recipient_id

string

Filter by recipient ID

currency

string

Filter by currency codeAllowed values: USD, AUD, EUR, BRL, GBP, CAD, CHF

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 of statement entries

Show Statement Entry

integer

Statement ID

entity

string

Entity type (e.g., payin, payout, transfer)

entity_id

integer

Entity identifier

impact_balance

string

How transaction impacts balance (e.g., available, reserve, both)

Transaction Categories

The statement includes various transaction categories. Use the category ID when filtering:

ID	Name	Description
1	PIX Payment	PIX payment received
2	PIX Reversal	PIX payment reversal
3	TED Payment	TED transfer payment
4	TED Reversal	TED transfer reversal
5	Transfer Between WE Accounts	Internal transfers between WE accounts
6	Transfer	General transfers
7	Boleto Payment	Boleto payment received
8	PIX Fee	PIX transaction fee
9	Boleto Fee	Boleto transaction fee
10	TED Fee	TED transfer fee
11	Merchant Note Settlement	Settlement entry
12	Merchant Note Tax	Tax entry
13	Merchant Note Generic	Generic merchant note
14	Transfer Fee	Transfer transaction fee
15	Others	Other transactions
16	Rolling Reserve	Rolling reserve
17	Credit Card Transaction	Credit card payment
18	Credit Card Fee	Credit card fee
51	Merchant Note Judicial Freeze	Judicial freeze
52	PIX Refund	PIX refund
53	Markup	Markup fee
54	Current Balance	Current balance

Example: To filter PIX-related transactions (payments and fees), use: ?category_id=1,8

Pagination

The API uses header-based pagination:

// Get first page
const page1 = await getStatement(merchantId, { page: 1, per_page: 50 });

// Check if there are more pages
const nextPage = response.headers.get('x-next-page');
if (nextPage) {
  const page2 = await getStatement(merchantId, { page: nextPage, per_page: 50 });
}

Use Cases

Generate Monthly Statement

Generate a complete monthly statement for accounting:

async function getMonthlyStatement(merchantId, year, month) {
  const startDate = `${year}-${String(month).padStart(2, '0')}-01`;
  const lastDay = new Date(year, month, 0).getDate();
  const endDate = `${year}-${String(month).padStart(2, '0')}-${String(lastDay).padStart(2, '0')}`;
  
  let allStatements = [];
  let page = 1;
  let hasMore = true;
  
  while (hasMore) {
    const response = await fetch(
      `https://api.wepayments.com/v2/account/${merchantId}/statement?created_after=${startDate}&created_before=${endDate}&page=${page}&per_page=100`,
      {
        headers: {
          'Authorization': 'Bearer YOUR_TOKEN',
          'Accept': 'application/json'
        }
      }
    );
    
    const data = await response.json();
    allStatements = allStatements.concat(data);
    
    const nextPage = response.headers.get('x-next-page');
    hasMore = nextPage !== null && nextPage !== '0';
    page = nextPage;
  }
  
  return allStatements;
}

Filter by Category

Retrieve transactions for a specific category:

async function getTransactionsByCategory(merchantId, categoryId, startDate, endDate) {
  const response = await fetch(
    `https://api.wepayments.com/v2/account/${merchantId}/statement?category_id=${categoryId}&created_after=${startDate}&created_before=${endDate}`,
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN',
        'Accept': 'application/json'
      }
    }
  );
  
  return await response.json();
}

// Get all PIX payment transactions for January 2024
const pixPayments = await getTransactionsByCategory(
  merchantId, 
  1, // PIX Payment category ID
  '2024-01-01',
  '2024-01-31'
);

Calculate Total Fees

Calculate total fees paid in a period:

async function calculateTotalFees(merchantId, startDate, endDate) {
  // Fee category IDs: PIX Fee (8), Boleto Fee (9), TED Fee (10), Transfer Fee (14), Credit Card Fee (18)
  const feeCategoryIds = '8,9,10,14,18';
  
  const response = await fetch(
    `https://api.wepayments.com/v2/account/${merchantId}/statement?category_id=${feeCategoryIds}&created_after=${startDate}&created_before=${endDate}&per_page=150`,
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN',
        'Accept': 'application/json'
      }
    }
  );
  
  const statements = await response.json();
  const totalFees = statements.reduce((sum, s) => sum + Math.abs(s.amount), 0);
  
  return totalFees;
}

// Calculate total fees for January 2024
const fees = await calculateTotalFees(merchantId, '2024-01-01', '2024-01-31');
console.log(`Total fees: ${fees}`);

Export to CSV

Export statement data to CSV format:

async function exportStatementToCSV(merchantId, startDate, endDate) {
  const response = await fetch(
    `https://api.wepayments.com/v2/account/${merchantId}/statement?created_after=${startDate}&created_before=${endDate}&per_page=150`,
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN',
        'Accept': 'application/json'
      }
    }
  );
  
  const statements = await response.json();
  
  const headers = ['Date', 'Occurrence', 'Category', 'Description', 'Amount', 'Balance'];
  const rows = statements.map(s => [
    s.created_at,
    s.occurrence_at,
    s.category.name,
    s.description || '',
    s.amount,
    s.available_balance
  ]);
  
  const csv = [headers, ...rows]
    .map(row => row.join(','))
    .join('\n');
  
  return csv;
}

Track Balance Changes

Monitor balance changes over time:

async function trackBalanceChanges(merchantId, startDate, endDate) {
  const response = await fetch(
    `https://api.wepayments.com/v2/account/${merchantId}/statement?created_after=${startDate}&created_before=${endDate}&per_page=150`,
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN',
        'Accept': 'application/json'
      }
    }
  );
  
  const statements = await response.json();
  
  const balanceHistory = statements.map(s => ({
    timestamp: s.occurrence_at,
    created_at: s.created_at,
    amount: s.amount,
    available_balance: s.available_balance,
    balance: s.balance,
    category: s.category.name,
    entity: s.entity
  }));
  
  return balanceHistory;
}

Best Practices

Use Pagination: Always implement pagination when retrieving statements to avoid timeouts and memory issues with large datasets. Valid per_page values are: 10, 20, 25, 50, 100, 150.

Date Filters Required: You must provide either created_after/created_before OR occurrence_after/occurrence_before filters. The API will return a 400 error if no date range is specified.

Filter by Multiple Categories: Use comma-separated category IDs to filter multiple transaction types at once. For example: ?category_id=1,8,9 to get PIX payments and all fee types.

Account

Banks

Credit Card

Automatic Pix

Payin

Payout

KYC

Markup

Path Parameters

Query Parameters

Response Headers

Response Body

Transaction Categories

Use Cases

Best Practices

Account

Banks

Credit Card

Automatic Pix

Payin

Payout

KYC

Markup

​Path Parameters

​Query Parameters

​Response Headers

​Response Body

​Transaction Categories

​Pagination

​Use Cases

​Best Practices

Path Parameters

Query Parameters

Response Headers

Response Body

Transaction Categories

Pagination

Use Cases

Best Practices