@mbanq/core-sdk-js / commands / GetCharges
Function: GetCharges()
GetCharges(
params?):Command<{params?: {chargeStatus?:ALL|ACTIVE|INACTIVE; }; },object[]>
Defined in: src/commands/rest/chargeSetup.ts:100
Get a list of charge definitions
This endpoint allows retrieving a list of charge definitions, optionally filtered by status.
Parameters
params?
The charge retrieval parameters
chargeStatus?
ALL | ACTIVE | INACTIVE = ...
Filter by charge status ('ALL', 'ACTIVE', 'INACTIVE')
Returns
Command<{ params?: { chargeStatus?: ALL | ACTIVE | INACTIVE; }; }, object[]>
Command object for getting a list of charges
Example
typescript
const command = GetCharges({ chargeStatus: 'ACTIVE' });
const result = await client.request(command);
console.log(result);