Report Settlement Entries

Return a list of all settlement entries matching the given search criteria. If payoutId is not specified, currency, createdAfter and createdBefore must all be provided. Use Accept request header to specify either application/json or text/csv responses. The JSON variant includes an aggregated summary of the matching entries.

SecurityMarketplace API Key | Merchant Secret Token | Admin JWT | Merchant JWT | Marketplace JWT

Request

query Parameters

column	Array of strings (SettlementCsvColumn) List of columns to include in the report. If not specified, default column list is used. Items Enum: "EntryDate" "EntryTimestamp" "EntryType" "EntryDescription" "SettlementDate" "TransactionType" "OrderType" "OrderId" "OrderDescription" "MerchantOrderId" "MerchantId" "MerchantName" "TransactionId" "TransactionAmount" "RefundId" "PayoutId" "Currency" "NetAmount" "GrossAmount" "PlatformFeesInclTax" "PlatformFeesTax"
merchantId required	string System identifier for merchant to show entries for
currency	string Currency of entries Example: currency=AUD
createdAfter	string <date-time> Return settlement entries that were created at or after this timestamp in ISO-8601 format Example: createdAfter=2024-12-22T23:12:06.403178139Z
createdBefore	string <date-time> Return settlement entries that were created at or before this timestamp in ISO-8601 format
settlementType	string (SettlementType) Default: "Net" Include both payment and fee entries (Net) or just payment entries (Gross). Enum: "Net" "Gross"
payoutId	string Filter by payout identifier
invoiceId	string Filter by merchant invoice identifier

Responses

200

400

401

403

404

405

406

409

422

429

500

503

get/transactions/settlement/report

Request samples

Curl
JavaScript

Response samples

{"currency": "AUD",
"items": [{"entryDate": "2019-08-24",
"entryTimestamp": "2019-08-24T14:15:22Z",
"entryType": "Payment",
"entryDescription": "string",
"settlementDate": "2019-08-24",
"transactionType": "string",
"orderType": "online",
"orderId": "string",
"orderDescription": "string",
"orderMetadata": { },
"merchantOrderId": "ordr_Z2icv3UXMhzzOEVl",
"merchantId": "mcht_Z2icvnUXMhzzOEVh",
"merchantName": "string",
"transactionId": "tran_Z2icv3UXMhzzOEVk",
"transactionAmount": 0,
"refundId": "rfnd_Z2icwHUXMhzzOEV0",
"payoutId": "payout_Z2icv3UXMhzzOEVu",
"currency": "AUD",
"netAmount": 0,
"grossAmount": 0,
"platformFeesInclTax": 0,
"platformFeesTax": 0,
"customFieldValues": {"property1": "string",
"property2": "string"
}
}
],
"totalPages": 0,
"totalRecords": 0,
"platformFeesInclTax": 0,
"platformFeesTax": 0,
"netAmount": 0,
"grossAmount": 0,
"payoutSummary": {"payoutId": "payout_Z2icv3UXMhzzOEVu",
"currency": "AUD",
"activeFrom": "2019-08-24T14:15:22Z",
"activeTo": "2019-08-24T14:15:22Z",
"paidOn": "2019-08-24",
"status": "paid",
"settlementType": "Net",
"failureReason": "string",
"openingBalance": 0,
"closingBalance": 0,
"payoutAmount": 0
},
"created": "2019-08-24T14:15:22Z"
}