/**
* Shell Card Management APIsLib
*
* This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
*/
import { Schema } from '../schema';
import { SearchCard } from './searchCard';
/**
* Encapsulates the details of a Summary Request.
* Summary Request fields are same as the Search Request base class and no new fields are required.
*/
export interface SummaryRequest {
/** Account ID of the customer.
Optional.
This input is a search criterion, if given. */
accountId?: number | null;
/** Account Number of the customer.
Optional.
This input is a search criterion, if given. */
accountNumber?: string | null;
/**
* Collecting Company Code (Shell Code) of the selected payer.
* Optional If ColCo Id or ColCoCountryCode is passed else Mandatory.
*/
colCoCode?: number | null;
/**
* The 2 character ISO Code for the customer and card owning country.
* Optional If ColCoId or ColCoCode is passed else Mandatory.
*/
colCoCountryCode?: string | null;
/**
* Collecting Company Id (in ) of the selected payer.
* Optional If ColCo Codeor ColCoCountryCode is passed else Mandatory
*/
colCoId?: number | null;
/**
* Payer Id (i.e. Customer Id of the Payment Customer ) of the selected payer.
* Optional if PayerNumber is passed else Mandatory
*/
payerId?: number | null;
/**
* Payer Number of the selected payer.
* Optional if PayerId is passed else Mandatory
*/
payerNumber?: string | null;
/**
* Card group id.
* Optional.
* This input is a search criterion, if given.
* When -1 is passed, those cards that does not belong to any card group will be returned.
*/
cardGroupId?: number | null;
/**
* Card group name.
* Optional.
* This input is a search criterion, if given.
* If CardGroupId is provided then this search criterion will be ignored, else, those cards that have the card group name completely matching with the entered value will be returned
*/
cardGroupName?: string | null;
/**
* Status of the card.
* Mandatory.
* Multiple statuses are allowed to be included in the search criteria.
* CardStatus filter accepts either of the two values for each status as described below. However, the output field “StatusDescription” is aligned with second value highlighted in italics.
* Below are the possible allowed statuses:
* • ACTIVE or Active – Cards at status Active (The result will include all the cards having the following intermediate statuses as defined s, if the IncludeIntermediateStatus flag is true: Active (Block in progress), Active (Cancel in progress), Active (Marked as damaged)), New (Cancel in progress).
* • ON_ORDER or New – Cards at status New
* • EXPIRED or Expired – Cards at status Expired
* • BLOCKED or Blocked Card – Cards at status Block (The result will include all cards having the following intermediate status as defined, if the IncludeIntermediateStatus flag is true: Blocked card (Unblock in progress))
* • TEMP_BLOCKED_CUSTOMER or Temporary Block(Customer) – Cards at status Temporary Blocked By Customer
* • TEMP_BLOCKED_SHELL or Temporary Block (Shell) – Cards at Status Temporary Blocked by Shell
* • CANCELLED or Cancelled – Cards at status Cancelled
* • PENDING_RENEWAL or Pending Renewal - Cards that are in renewal process
* • REPLACED or Replaced – Cards at Status Replaced
* • FRAUD or Fraud – Cards at Status FRAUD
* • ALL
*/
cardStatus: string[] | null;
/**
* Cards active and expiring in given number of days.
* Optional
* Note: When a value is passed in this parameter, only active cards will be considered while searching.
*/
expiringInDays?: number | null;
/**
* If provided, only list cards issued after the given date
* Optional
* Format: yyyyMMdd
* Note: Clients to convert this to appropriate DateTime type.
*/
issuedAfter?: string | null;
/**
* Last digits of the PAN number
* Minimum 4 last digits of the card should be sent for this field to be considered as part of the search criteria.
* Optional
* Max Length: 50
*/
pANEndsWith?: string | null;
/**
* Driver Name embossed on the card
* Optional
* Up to 10 driver names could be passed in the parameter.
* Minimum of 4 characters should be provided for each driver name else not considered.
* Those cards will be returned when part of the driver name matches with any of the string passed in the list.
* Max Length for each Driver name: 50
*/
driverName?: string[];
/**
* Vehicle Registration embossed on the card
* Optional
* Up to 10 vehicle registration numbers could be passed in the parameter.
* Minimum of 4 characters should be provided for each VRN else not considered
* Those cards will be returned when part of the VRN matches with any of the string passed in the list.
* Max Length for each VRN: 50
*/
vehicleRegistrationNumber?: string[];
/**
* List of SearchCard entity i.e., Card Id or PAN, which needs to be included in the response.
* Details of the SerachCard entity are given below.
*/
includeCards?: SearchCard[];
/**
* List of SearchCard entity i.e., Card Id or PAN, which needs to be excluded in the response.
* Details of the SerachCard entity are given below.
*/
excludeCards?: SearchCard[];
/**
* Bundle Id for the Card, which needs to be excluded in the response.
* Optional
*/
excludeBundleId?: string | null;
/**
* Market segment to which card belongs to.
* Optional.
* Allowed values
* • CRT
* • Fleet
*/
cardSegment?: string | null;
/**
* Purchase category code of the card.
* Optional.
*/
purchaseCategoryCode?: string | null;
/**
* ISO code of the card i.e. first 7 digits of the PAN
* Optional.
*/
cardTypeCode?: string | null;
/**
* Default value is True.
* When true, the API will not return cards that are at Pending Renewal Status in Cards Platform
*/
excludePendingRenewalCards?: boolean;
/**
* Default value is True.
* When true, the API will not return cards that are at Cancelled Status in Cards Platform
*/
excludeCancelledCards?: boolean;
/**
* Default value is False.
* When true, the API will not return cards that are at Replaced Status in Cards Platform
*/
excludeReplacedCards?: boolean;
/**
* Default value is False.
* When true, the API will not return cards that are at Fraud Status in Cards Platform
*/
excludeFraudCards?: boolean;
/**
* Optional
* When passed, the API will not return cards that are currently in the Card Group specified
*/
excludeCardGroupId?: number | null;
/**
* Optional
* When passed, the API will not return cards that are currently in the Card Group specified
*/
excludeCardGroupName?: string | null;
/**
* Card Creation Date
* Optional
* Format: yyyyMMdd
*/
creationDate?: string | null;
/**
* Effective date for the Card
* Optional
* Format: yyyyMMdd
*/
effectiveDate?: string | null;
/**
* Cards allowed to be used in site.
* Optional.
* Allowed values
* • ShellSitesOnly
* • PartnersSitesIncluded
*/
network?: string | null;
/**
* Cards allowed to used nationally/internationally.
* Optional.
* Allowed values
* -National
* -International
*/
coverage?: string | null;
/**
* Month in which the card is expiring.
* Optional.
* Format: MMYYYY
*/
expiryMonth?: string | null;
/**
* Default Value: False
* When this field is set to True, cards with below status 2 years (configurable) ago and earlier are excluded from the result
* -Blocked Card
* -Expired
* -Cancelled
* -Suspended
* -Blocked
* -Expired and Cancelled
* -Replaced
* -Replaced By
* -Closed
* -Fraud
*/
excludeOldCards?: boolean;
/**
* Default Value: All
* Optional
* This option is used to filter the list of cards with ‘ReissueSetting’.
* If ‘True’, the API will return cards with ReIssueSetting value is true.
* If ‘False’, the API will return cards with ReIsssueSetting value is false.
* If ‘ALL’, API will return cards with ReIssueSetting value True & False both.
* Allowed Values:
* 1. All
* 2. True
* 3. False
*/
reissueSetting?: string | null;
requestId: string | null;
}
export declare const summaryRequestSchema: Schema;