@mbanq/core-sdk-js / commands / GetCardSettlementById
Function: GetCardSettlementById()
GetCardSettlementById(
params):Command<{params: {settlementId:number; }; }, {accountNumber:string;amount:number;batchDate:string;batchIdentifier:string;cardToken:string;clientId:number;completedInternalClearingId:number;createdAt:string;currency:string;externalAuthId:string;externalCardId:string;externalClearingId:string;externalOriginalAuthId:string;firstName:string;id:number;interchangeFeeAmount:number;internalAuthId:string;internalClearingId:string;lastName:string;mcSequenceCount:number;mcSequenceNumber:number;merchant: {description:string;mcc:string;merchant_location:string;merchant_number:string;merchantId:string; };network:string;requestedAt:string;status:string;type:string; }>
Defined in: src/commands/rest/card.ts:1090
Get Card Settlement By Id
Retrieves detailed information about a specific card settlement by its unique identifier.
This endpoint allows you to fetch specific information related to a card settlement based on the settlement ID, including transaction amounts, dates, merchant information, and transaction status.
Parameters
params
Request parameters including settlement ID
settlementId
number = ...
Returns
Command<{ params: { settlementId: number; }; }, { accountNumber: string; amount: number; batchDate: string; batchIdentifier: string; cardToken: string; clientId: number; completedInternalClearingId: number; createdAt: string; currency: string; externalAuthId: string; externalCardId: string; externalClearingId: string; externalOriginalAuthId: string; firstName: string; id: number; interchangeFeeAmount: number; internalAuthId: string; internalClearingId: string; lastName: string; mcSequenceCount: number; mcSequenceNumber: number; merchant: { description: string; mcc: string; merchant_location: string; merchant_number: string; merchantId: string; }; network: string; requestedAt: string; status: string; type: string; }>
Command object that executes the API request
Example
const command = GetCardSettlementById({
settlementId: 4
});
const result = await client.request(command);
console.log(`Settlement ID: ${result.id}`);
console.log(`Status: ${result.status}`);
console.log(`Merchant: ${result.merchant.description}`);
console.log(`Amount: ${result.amount} ${result.currency}`);