Skip to main content

Get Statement

Use this route to get the statement of your account or a specific partner. The response is a unified list of credits and debits, ordered from the newest movement to the oldest.

GETv3/financial/statement

Request Query Params​

AttributeTypeDescription
sub_seller_idstringPartner ID whose statement will be queried. When omitted, the query returns the seller account statement.
date_startdateStart of the range in YYYY-MM-DD. Default: 7 days before date_end (today, Brasília time).
date_enddateEnd of the range in YYYY-MM-DD. Default: today (Brasília time). Must be greater than or equal to date_start.
pageint32Page number. Default: 1. Minimum: 1.
page_sizeint32Items per page. Default: 20. Minimum: 1. Maximum: 100.
Maximum range

The interval between date_start and date_end cannot exceed 180 days.

Tip

net_value, gross_amount and splits_amount are in cents and signed: positive on credit, negative on debit. Direction is in operation_type (credit or debit).

How the statement is built​

Each row is an immutable entry. A refunded or chargedback transaction produces two entries: the original credit and the later debit, each with its own date.

Eventtypeoperation_typeWhen it appears
Paid transactiontransactioncreditOn the date the transaction was paid. Non-anticipated sales include receivables[] on that same credit; the payout day only adds the wd_ row.
Refund or chargebacktransactiondebitOn the refund/chargeback date. The original credit stays. status is refunded or chargedback.
Withdrawal (manual or automatic)withdrawaldebitFor manual withdrawals at request time; for accounts with automatic payout, at transfer time.

Identifiers​

entry_id is deterministic. You can use it to deduplicate pages:

typeentry_id format
transaction (credit)txn_{transaction_id}_credit
transaction (debit)txn_{transaction_id}_debit
withdrawalwd_{withdrawal_id}

Response Object​

AttributeTypeDescription
totalint32Total entries that match the query filter.
pageint32Current page relative to the offset of pages.
offsetint32Total number of pages for page_size divided by the total entries in the query.
statementarrayEntries in the range, ordered by creation date descending.
statement[][entry_id]stringDeterministic entry ID.
statement[][type]stringType. Values: transaction, withdrawal.
statement[][status]stringSource status. Examples: paid, refunded, chargedback, processing, transferred.
statement[][source_id]stringSource ID: transaction or withdrawal.
statement[][date_created]dateTimeEntry date in ISODateTime format.
statement[][date_created_timestamp]int64Epoch milliseconds of date_created, used for ordering.
statement[][date_updated]dateTimeLast update date of the entry in ISODateTime format.
statement[][operation_type]stringEntry direction. Values: credit, debit.
statement[][transaction_id]stringTransaction ID. null on withdrawals.
statement[][withdrawal_id]stringWithdrawal ID. null on transactions. For an automatic payout this is the TED UUID.
statement[][installments]stringTransaction installment count. null on withdrawals.
statement[][payment_method]stringTransaction payment method. null on withdrawals.
statement[][gross_amount]int32Gross amount in cents, signed. Negative on debit.
statement[][rate]numberFee as a percentage. For debit operations: 0.
statement[][rate_value]int32Fee amount in cents. For debit operations: 0.
statement[][splits_amount]int32Signed sum of the transaction split.amount values, in cents. On withdrawal: 0.
statement[][net_value]int32Net amount in cents, signed. Seller: gross_amount - rate_value - splits_amount (on credit). Partner: the split amount. Withdrawal: same as gross_amount.
statement[][acquirer]stringTransaction acquirer. null on withdrawals.
statement[][receivables]arrayPresent on non-anticipated sale credits and refunds. Omitted on anticipated transactions and withdrawals. This endpoint does not return payable_details.
statement[][receivables][][installment]int32Installment number.
statement[][receivables][][gross_amount]int32Installment gross amount, in cents.
statement[][receivables][][net_amount]int32Installment net amount, in cents.
statement[][receivables][][rate]numberInstallment rate as a percentage, two decimal places.
statement[][receivables][][rate_value]int32Installment fee amount, in cents.
statement[][receivables][][expected_settlement_date]dateTimeExpected payout date (Barte execution_date).
statement[][receivables][][effective_settlement_date]dateTimeTED/payout date that settled the installment. null until payout.
Example Response
{
  "total": 2,
  "page": 1,
  "offset": 1,
  "statement": [
    {
      "entry_id": "wd_withdrawal_1234567890",
      "type": "withdrawal",
      "status": "processing",
      "source_id": "withdrawal_1234567890",
      "date_created": "2026-08-20T14:30:00.000Z",
      "date_created_timestamp": 1755700200000,
      "date_updated": "2026-08-20T14:30:00.000Z",
      "operation_type": "debit",
      "transaction_id": null,
      "withdrawal_id": "withdrawal_1234567890",
      "installments": null,
      "payment_method": null,
      "gross_amount": -10000,
      "rate": 0,
      "rate_value": 0,
      "splits_amount": 0,
      "net_value": -10000,
      "acquirer": null
    },
    {
      "entry_id": "txn_HcDscltTIVK3VMAAOj7J_credit",
      "type": "transaction",
      "status": "paid",
      "source_id": "HcDscltTIVK3VMAAOj7J",
      "date_created": "2026-08-18T14:30:00.000Z",
      "date_created_timestamp": 1755527400000,
      "date_updated": "2026-08-18T14:30:00.000Z",
      "operation_type": "credit",
      "transaction_id": "HcDscltTIVK3VMAAOj7J",
      "withdrawal_id": null,
      "installments": "1",
      "payment_method": "credit_card",
      "gross_amount": 90000,
      "rate": 2.49,
      "rate_value": 2241,
      "splits_amount": 86310,
      "net_value": 86310,
      "acquirer": "sample_acquirer"
    }
  ]
}

Error Object​

AttributeTypeDescription
errorsarrayArray with all errors found while processing the request.
errors[][type]stringType of error that occurred.
errors[][message]stringDetailed message of the error that occurred.
Example error
{
  "errors": [
    {
      "type": "date_end",
      "message": "The parameter [ date_end ] must be at most 180 days after date_start."
    }
  ]
}

Examples​

ATTENTION

The values used in the examples below are for illustration only and must not be used to make requests to Marlim APIs.

Request
curl -X GET -G "https://api.marlim.co/v3/financial/statement" \
-H "Content-Type: application/json" \
-H "api_key: api_key_value" \
-d date_start="2026-08-14" \ 
-d date_end="2026-08-20"
Response200
{
  "total": 1,
  "page": 1,
  "offset": 1,
  "statement": [
    {
      "entry_id": "txn_HcDscltTIVK3VMAAOj7J_credit",
      "type": "transaction",
      "status": "paid",
      "source_id": "HcDscltTIVK3VMAAOj7J",
      "date_created": "2026-08-18T14:30:00.000Z",
      "date_created_timestamp": 1755527400000,
      "date_updated": "2026-08-18T14:30:00.000Z",
      "operation_type": "credit",
      "transaction_id": "HcDscltTIVK3VMAAOj7J",
      "withdrawal_id": null,
      "installments": "1",
      "payment_method": "credit_card",
      "gross_amount": 90000,
      "rate": 2.49,
      "rate_value": 2241,
      "splits_amount": 86310,
      "net_value": 86310,
      "acquirer": "sample_acquirer"
    }
  ]
}