@mbanq/core-sdk-js / commands / GetCardSettlements
Function: GetCardSettlements()
GetCardSettlements(
params):Command<{params: {dateFormat?:string;endDate?:string;internalClearingId?:string;isCardSettlementOnly?:boolean;limit?:number;offset?:number;orderBy?:string;sortOrder?:"asc"|"desc";startDate?:string;status?:"COMPLETED"|"REJECTED"|"PENDING"; }; }, {pageItems:object[];totalFilteredRecords:number; }>
Defined in: src/commands/rest/card.ts:1026
Get Card Settlements
Retrieves a list of all card settlements with comprehensive filtering, pagination, and sorting options.
A card settlement is the process where a card transaction is finalized and funds are officially transferred from the cardholder's account to the merchant's account.
Parameters
params
Request parameters for filtering and pagination
dateFormat?
string = ...
endDate?
string = ...
internalClearingId?
string = ...
isCardSettlementOnly?
boolean = ...
limit?
number = ...
offset?
number = ...
orderBy?
string = ...
sortOrder?
"asc" | "desc" = ...
startDate?
string = ...
status?
"COMPLETED" | "REJECTED" | "PENDING" = ...
Returns
Command<{ params: { dateFormat?: string; endDate?: string; internalClearingId?: string; isCardSettlementOnly?: boolean; limit?: number; offset?: number; orderBy?: string; sortOrder?: "asc" | "desc"; startDate?: string; status?: "COMPLETED" | "REJECTED" | "PENDING"; }; }, { pageItems: object[]; totalFilteredRecords: number; }>
Command object that executes the API request
Example
// Get settlements within a date range
const command = GetCardSettlements({
startDate: '10 May 2024',
endDate: '10 June 2024',
dateFormat: 'dd MM yyyy',
limit: 15,
status: 'COMPLETED',
orderBy: 'created_at',
sortOrder: 'desc'
});
const result = await client.request(command);
console.log(`Total settlements: ${result.totalFilteredRecords}`);
console.log(`Settlements:`, result.pageItems);