Query Settlement Entries

Return a paginated list of all settlement entries matching the given search criteria. If payoutId is not specified, currency, createdAfter and createdBefore must all be provided.

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

Request

query Parameters

limit	integer <int32> Maximum results per page. Default to 20, must be between 1 and 500.
page	integer <int32> Page number of results to show (starting at page 1).
sort	string Comma-delimited list of fields to sort by with sort priority from first to last. Fields are sorted by their natural ordering unless prefixed with a `-` character.
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-11-21T01:51:59.646757153Z
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

Request samples

Curl
JavaScript

Response samples

application/json

{"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_Zz6SN_8bIUK88SSq",
"merchantId": "mcht_Zz6SN_8bIUK88SSm",
"merchantName": "string",
"transactionId": "tran_Zz6SN_8bIUK88SSp",
"transactionAmount": 0,
"refundId": "rfnd_Zz6SOf8bIUK88SS5",
"payoutId": "payout_Zz6SOP8bIUK88SSz",
"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_Zz6SOP8bIUK88SSz",
"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"
}