Overview

Finance shows the seller's money in each marketplace: what came in, the fees charged, what was paid out and the balance. Use it for reconciliation. Do not use it as an operational source: an order's price and fees come from the order.

Where finance fits in the journey: Grow and track.

EndpointsCopy Anchor Link

All require Authorization: Bearer mk_your_api_key. See Authentication.

TransactionCopy Anchor Link

Each transaction has a normalized type: sale, refund, fee, shipping, adjustment, chargeback, payout, advertising, tax, promotion or other. The marketplace's original type is always kept in externalType. On fee transactions, feeType tells which fee.

status is pending, available, settled or cancelled. When possible, the transaction points to the order (orderId) and to the settlement (settlementId).

The sign of the amountCopy Anchor Link

amountInCents is signed: credit is positive, debit is negative. A sale of R$ 100.00 is 10000. Its commission is, for example, -1200.

LagCopy Anchor Link

Data is read from the marketplace once a day. What happened today may show up only tomorrow. A transaction can arrive before its order: the orderId link is retried on every round.

Settlements, statements and balancesCopy Anchor Link

• Settlement (Settlement): status scheduled, in_transit, paid, failed or cancelled.
• Fee statement (FeeStatement): status open, closed, paid, overdue or unknown, with a breakdown per fee and documents (invoices and credit notes).
• Balance (FinancialBalance): availableInCents, pendingInCents and blockedInCents, per currency.

RulesCopy Anchor Link

• Transactions come newest first, by occurredAt.
• Filter by connectionId. Without it, the list covers every Connection of the account.
• An inverted period (from after to) returns 400. A resource from another account returns 404.
• Not every marketplace offers all four reads. When the Connection does not, the response is 422.
• The transaction description carries no personal data.