Skip to content

@mbanq/core-sdk-js v0.50.0


@mbanq/core-sdk-js / commands / GetPrepaidCardsByAccountId

Function: GetPrepaidCardsByAccountId()

GetPrepaidCardsByAccountId(primaryAccountId, status?): Command<{ primaryAccountId: number; status?: "ACTIVE" | "REJECTED" | "EXPIRED" | "PENDING" | "ORDER_IN_PROGRESS" | "ORDER_FAILED" | "CREATED" | "ORDERED" | "INACTIVE" | "SUSPENDED" | "TERMINATED" | "REPLACED" | "RENEWED" | "LOST_STOLEN" | "RETURNED" | "DELETED"; }, object[]>

Defined in: src/commands/rest/prepaidCard.ts:110

Get Prepaid Cards By Primary Account Id

Retrieves a comprehensive list of all prepaid cards associated with a specified primary account Id. You can also apply additional filters to refine the request parameters, allowing for a more targeted search based on specific criteria.

Parameters

primaryAccountId

number

The associated primary account id

status?

"ACTIVE" | "REJECTED" | "EXPIRED" | "PENDING" | "ORDER_IN_PROGRESS" | "ORDER_FAILED" | "CREATED" | "ORDERED" | "INACTIVE" | "SUSPENDED" | "TERMINATED" | "REPLACED" | "RENEWED" | "LOST_STOLEN" | "RETURNED" | "DELETED"

Optional status filter

Returns

Command<{ primaryAccountId: number; status?: "ACTIVE" | "REJECTED" | "EXPIRED" | "PENDING" | "ORDER_IN_PROGRESS" | "ORDER_FAILED" | "CREATED" | "ORDERED" | "INACTIVE" | "SUSPENDED" | "TERMINATED" | "REPLACED" | "RENEWED" | "LOST_STOLEN" | "RETURNED" | "DELETED"; }, object[]>

Command object that executes the API request and returns list of prepaid card accounts

Example

typescript
// Get all prepaid cards for an account
const command = GetPrepaidCardsByAccountId(234);
const cards = await client.request(command);

// Get only active prepaid cards
const activeCommand = GetPrepaidCardsByAccountId(
  primaryAccountId: 234,
  status: 'ACTIVE'
});
const activeCards = await client.request(activeCommand);

Released under the MIT License.