Skip to content

Portfolio

Available Actions

HTTP Action Endpoint Request Parameters Request Model Response Model
GET /v2/institution/{id}/portfolio id – institution id ~ Portfolio[]
GET /v2/portfolio/{id} id – institution id ~ Portfolio
POST /v2/portfolio ~ CreatePortfolio Portfolio
PATCH /v2/portfolio/{id} id – institution id UpdatePortfolio Portfolio

Models

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
export interface Portfolio {
    id: number;
    sourcePortfolioId: string;
    organizationId: number;
    name: string;
    isActive: boolean;
    rewardType: RewardType;
    rewardDisplayName: string;
    rewardToCurrencyConversionRate: number;
    createdBy: string;
    updatedBy: string;
    createdAt: Date;
    updatedAt: Date;
}

1
2
3
4
5
6
7
8
9
export interface CreatePortfolio {
    sourcePortfolioId: string;
    organizationId: number;
    name: string;
    isActive?: boolean;
    rewardType: RewardType;
    rewardDisplayName: string;
    rewardToCurrencyConversionRate: number;
}

1
2
3
4
5
6
7
8
export interface UpdatePortfolio {
    id: number;
    name?: string;
    isActive?: boolean;
    rewardType?: RewardType;
    rewardDisplayName?: string;
    rewardToCurrencyConversionRate?: number;
}

Enums

1
2
3
4
export enum RewardType {
    CASHBACK = 'CashBack',
    POINTS = 'Points',
}