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 (IsoCurrency) Currency of entries Enum: "AFN" "DZD" "ARS" "AMD" "AWG" "AUD" "AZN" "BSD" "BHD" "THB" "PAB" "BBD" "BYR" "BZD" "BMD" "VEF" "BOB" "BRL" "BND" "BGN" "BIF" "CAD" "CVE" "KYD" "XOF" "XAF" "XPF" "CLP" "COP" "KMF" "CDF" "BAM" "NIO" "CRC" "HRK" "CUP" "CZK" "GMD" "DKK" "MKD" "DJF" "STD" "DOP" "VND" "XCD" "EGP" "SVC" "ETB" "EUR" "FKP" "FJD" "HUF" "GHS" "GIP" "HTG" "PYG" "GNF" "GYD" "HKD" "UAH" "ISK" "INR" "IRR" "IQD" "JMD" "JOD" "KES" "PGK" "LAK" "KWD" "MWK" "AOA" "MMK" "GEL" "LBP" "ALL" "HNL" "SLL" "LRD" "LYD" "SZL" "LSL" "MGA" "MYR" "MUR" "MXN" "MXV" "MDL" "MAD" "MZN" "BOV" "NGN" "ERN" "NAD" "NPR" "ANG" "ILS" "TWD" "NZD" "BTN" "KPW" "NOK" "PEN" "MRU" "PKR" "MOP" "TOP" "CUC" "UYU" "PHP" "GBP" "BWP" "QAR" "GTQ" "ZAR" "OMR" "KHR" "RON" "MVR" "IDR" "RUB" "RWF" "SHP" "SAR" "RSD" "SCR" "SGD" "SBD" "KGS" "SOS" "TJS" "SSP" "LKR" "SDG" "SRD" "SEK" "CHF" "SYP" "BDT" "WST" "TZS" "KZT" "TTD" "MNT" "TND" "TRY" "TMT" "AED" "UGX" "COU" "CLF" "UYI" "USD" "USN" "USS" "UZS" "VUV" "CHE" "CHW" "KRW" "YER" "JPY" "CNY" "ZMW" "ZWL" "PLN" Example: currency=AUD
createdAfter	string <date-time> Return settlement entries that were created at or after this timestamp in ISO-8601 format Example: createdAfter=2025-05-30T10:57:27.658298683Z
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": "AFN",
"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_aDmPET9N1VI_bLUu",
"merchantId": "mcht_aDmPET9N1VI_bLUq",
"merchantName": "string",
"transactionId": "tran_aDmPET9N1VI_bLUt",
"transactionAmount": 0,
"billingCategory": "string",
"refundId": "rfnd_aDmPEz9N1VI_bLU8",
"payoutId": "payout_aDmPEj9N1VI_bLU2",
"currency": "AFN",
"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_aDmPEj9N1VI_bLU2",
"currency": "AFN",
"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"
}