@mbanq/core-sdk-js / commands / GetPrepaidCardById
Function: GetPrepaidCardById()
GetPrepaidCardById(
params):Command<{params: {prepaidCardId:number;primaryAccountId:number; }; }, {accountNo:string;allowOverdraft:boolean;allowPrepaidCard:boolean;bankDetails?: {address:string;city:string;name:string;postcode:string;routingNumber:string;swiftCode:string; };blockedCountries:string[];card: {accountId:number;activatedAt?: {date:number[];time: {hour:number;minute:number;nano:number;second:number; }; };atmWithdrawalsEnabled:boolean;bid:number;businessCardIDEnabled:boolean;cardProcessorName:string;cardType:string;contactlessPaymentEnabled:boolean;digitalFirst:boolean;embossedNames:string[];expiresOn:number[];fulfillmentStatus:string;id:number;internationalPaymentsEnabled:boolean;mergedVelocityRules:any[];network:string;onlinePaymentEnabled:boolean;physicalCardActivated:boolean;posPaymentEnabled:boolean;primaryAccountNumber:string;printAccountNickname:boolean;registeredOn:number[];replacedDamageCount:number;status:string;token:string;updatedStatusAt?:string;virtual:boolean; };cardRestricted:boolean;clientId:number;clientName:string;currency: {code:string;currencyCodeInDigit?:number;decimalPlaces:number;displayLabel:string;displaySymbol:string;inMultiplesOf:number;isBaseCurrency?:boolean;name:string;nameCode:string; };currentFloatingInterestPeriod?: {fromDate:number[];interestRate:number;isDifferentialToBLR:boolean; };depositType: {code:string;id:number;value:string; };enforceMinRequiredBalance:boolean;fieldOfficerId:number;fieldOfficerName:string;floatingRateDifferential:number;floatingRateId:number;floatingRateName?:string;id:number;interestCalculationDaysInYearType: {code:string;id:number;value:string; };interestCalculationType: {code:string;id:number;value:string; };interestCompoundingPeriodType: {code:string;id:number;value:string; };interestPostingPeriodType: {code:string;id:number;value:string; };interestRateDifferential:number;isBaseLendingRate:boolean;isDormancyTrackingActive:boolean;isFloatingInterestRateCalculationAllowed:boolean;isLinkedToFloatingInterestRates:boolean;lastActiveTransactionDate:number[];lockinPeriodFrequency:number;lockinPeriodFrequencyType: {code:string;id:number;value:string; };minBalanceForInterestCalculation:number;minOverdraftForInterestCalculation:number;minRequiredBalance:number;minRequiredOpeningBalance:number;nominalAnnualInterestRate:number;nominalAnnualInterestRateOverdraft:number;onHoldFunds:number;overdraftInterestRateDifferential:number;overdraftLimit:number;overdraftMinimumDue:number;parentAccount?: {allowOverdraft:boolean;allowPrepaidCard:boolean;cardRestricted:boolean;enforceMinRequiredBalance:boolean;isBaseLendingRate:boolean;isDormancyTrackingActive:boolean;isLinkedToFloatingInterestRates:boolean;prepaidAccount:boolean;skipCollectTransferCharge:boolean;withdrawalFeeForTransfers:boolean;withHoldTax:boolean; };prepaidAccount:boolean;prepaidLimitAmount:number;remainingAllocatedFunds:number;savingsAmountOnHold:number;savingsProductId:number;savingsProductName:string;skipCollectTransferCharge:boolean;status: {active:boolean;approved:boolean;closed:boolean;code:string;id:number;matured:boolean;prematureClosed:boolean;rejected:boolean;submittedAndPendingApproval:boolean;transferInProgress:boolean;transferOnHold:boolean;value:string;withdrawnByApplicant:boolean; };subStatus: {block:boolean;blockCredit:boolean;blockDebit:boolean;code:string;dormant:boolean;escheat:boolean;id:number;inactive:boolean;none:boolean;value:string; };summary: {accountBalance:number;availableBalance:number;currency: {code:string;currencyCodeInDigit?:number;decimalPlaces:number;displayLabel:string;displaySymbol:string;inMultiplesOf:number;isBaseCurrency?:boolean;name:string;nameCode:string; };interestNotPosted:number;lastInterestCalculationDate?:number[];totalDeposits:number;totalInterestEarned:number;totalInterestPosted:number;totalOverdraftInterestDerived:number; };timeline: {activatedByFirstname?:string;activatedByLastname?:string;activatedByUsername?:string;activatedOnDate?:number[];approvedByFirstname?:string;approvedByLastname?:string;approvedByUsername?:string;approvedOnDate?:number[];submittedByFirstname:string;submittedByLastname:string;submittedByUsername:string;submittedOnDate:number[]; };withdrawalFeeForTransfers:boolean;withHoldTax:boolean; }>
Defined in: src/commands/rest/prepaidCard.ts:163
Get Prepaid Card By Id
Obtains detailed information about a specific prepaid card by providing both the associated account Id and the card Id. This allows you to retrieve precise data concerning the designated prepaid card, enabling better management and tracking of card-related information.
Parameters
params
The parameters object
prepaidCardId
number = ...
The associated prepaid card id
primaryAccountId
number = ...
The associated primary account id
Returns
Command<{ params: { prepaidCardId: number; primaryAccountId: number; }; }, { accountNo: string; allowOverdraft: boolean; allowPrepaidCard: boolean; bankDetails?: { address: string; city: string; name: string; postcode: string; routingNumber: string; swiftCode: string; }; blockedCountries: string[]; card: { accountId: number; activatedAt?: { date: number[]; time: { hour: number; minute: number; nano: number; second: number; }; }; atmWithdrawalsEnabled: boolean; bid: number; businessCardIDEnabled: boolean; cardProcessorName: string; cardType: string; contactlessPaymentEnabled: boolean; digitalFirst: boolean; embossedNames: string[]; expiresOn: number[]; fulfillmentStatus: string; id: number; internationalPaymentsEnabled: boolean; mergedVelocityRules: any[]; network: string; onlinePaymentEnabled: boolean; physicalCardActivated: boolean; posPaymentEnabled: boolean; primaryAccountNumber: string; printAccountNickname: boolean; registeredOn: number[]; replacedDamageCount: number; status: string; token: string; updatedStatusAt?: string; virtual: boolean; }; cardRestricted: boolean; clientId: number; clientName: string; currency: { code: string; currencyCodeInDigit?: number; decimalPlaces: number; displayLabel: string; displaySymbol: string; inMultiplesOf: number; isBaseCurrency?: boolean; name: string; nameCode: string; }; currentFloatingInterestPeriod?: { fromDate: number[]; interestRate: number; isDifferentialToBLR: boolean; }; depositType: { code: string; id: number; value: string; }; enforceMinRequiredBalance: boolean; fieldOfficerId: number; fieldOfficerName: string; floatingRateDifferential: number; floatingRateId: number; floatingRateName?: string; id: number; interestCalculationDaysInYearType: { code: string; id: number; value: string; }; interestCalculationType: { code: string; id: number; value: string; }; interestCompoundingPeriodType: { code: string; id: number; value: string; }; interestPostingPeriodType: { code: string; id: number; value: string; }; interestRateDifferential: number; isBaseLendingRate: boolean; isDormancyTrackingActive: boolean; isFloatingInterestRateCalculationAllowed: boolean; isLinkedToFloatingInterestRates: boolean; lastActiveTransactionDate: number[]; lockinPeriodFrequency: number; lockinPeriodFrequencyType: { code: string; id: number; value: string; }; minBalanceForInterestCalculation: number; minOverdraftForInterestCalculation: number; minRequiredBalance: number; minRequiredOpeningBalance: number; nominalAnnualInterestRate: number; nominalAnnualInterestRateOverdraft: number; onHoldFunds: number; overdraftInterestRateDifferential: number; overdraftLimit: number; overdraftMinimumDue: number; parentAccount?: { allowOverdraft: boolean; allowPrepaidCard: boolean; cardRestricted: boolean; enforceMinRequiredBalance: boolean; isBaseLendingRate: boolean; isDormancyTrackingActive: boolean; isLinkedToFloatingInterestRates: boolean; prepaidAccount: boolean; skipCollectTransferCharge: boolean; withdrawalFeeForTransfers: boolean; withHoldTax: boolean; }; prepaidAccount: boolean; prepaidLimitAmount: number; remainingAllocatedFunds: number; savingsAmountOnHold: number; savingsProductId: number; savingsProductName: string; skipCollectTransferCharge: boolean; status: { active: boolean; approved: boolean; closed: boolean; code: string; id: number; matured: boolean; prematureClosed: boolean; rejected: boolean; submittedAndPendingApproval: boolean; transferInProgress: boolean; transferOnHold: boolean; value: string; withdrawnByApplicant: boolean; }; subStatus: { block: boolean; blockCredit: boolean; blockDebit: boolean; code: string; dormant: boolean; escheat: boolean; id: number; inactive: boolean; none: boolean; value: string; }; summary: { accountBalance: number; availableBalance: number; currency: { code: string; currencyCodeInDigit?: number; decimalPlaces: number; displayLabel: string; displaySymbol: string; inMultiplesOf: number; isBaseCurrency?: boolean; name: string; nameCode: string; }; interestNotPosted: number; lastInterestCalculationDate?: number[]; totalDeposits: number; totalInterestEarned: number; totalInterestPosted: number; totalOverdraftInterestDerived: number; }; timeline: { activatedByFirstname?: string; activatedByLastname?: string; activatedByUsername?: string; activatedOnDate?: number[]; approvedByFirstname?: string; approvedByLastname?: string; approvedByUsername?: string; approvedOnDate?: number[]; submittedByFirstname: string; submittedByLastname: string; submittedByUsername: string; submittedOnDate: number[]; }; withdrawalFeeForTransfers: boolean; withHoldTax: boolean; }>
Command object that executes the API request and returns prepaid card account details
Example
const command = GetPrepaidCardById({ primaryAccountId: 234, prepaidCardId: 565 });
const cardDetails = await client.request(command);
console.log(cardDetails.card.status); // 'ACTIVE'
console.log(cardDetails.accountBalance); // 10002.47