card-management-sdk
Version:
The Shell Card Management API is REST-based and employs OAUTH 2.0,Basic and ApiKey authentication. The API endpoints accept JSON-encoded request bodies, return JSON-encoded responses and use standard HTTP response codes. All resources are located in the S
71 lines (70 loc) • 1.99 kB
TypeScript
/**
* Shell Card Management APIsLib
*
* This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
*/
import { Schema } from '../schema';
import { Accounts } from './accounts';
export interface CardGroupRequest {
/**
* Collecting Company Id of the selected payer.
* Optional if ColCoCode is passed else Mandatory.
* Example:
* 1 for Philippines
* 5 for UK
*/
colCoId?: number | null;
/**
* Collecting Company Code (Shell Code) of the selected payer.
* Mandatory for serviced OUs such as Romania, Latvia, Lithuania, Estonia, Ukraine etc. It is optional for other countries if ColCoID is provided.
* Example:
* 86 for Philippines
* 5 for UK
*/
colCoCode?: number | null;
/**
* Payer id of the customer.
* Optional if PayerNumber is passed, else Mandatory.
* This input is a search criterion.
* Example: 123456
*/
payerId?: number | null;
/**
* PayerNumber of the customer.
* Optional if PayerId is passed, else Mandatory.
* This input is a search criterion.
* Example: GB00123456
*/
payerNumber?: string | null;
account?: Accounts[];
/**
* Card Group Name
* Optional.
* Minimum of 2 characters should be provided else not considered.
* CardGroups those have the entered value at any part
*/
cardGroupName?: string | null;
/**
* Card Group Status
* Mandatory
* Allowed values:
* • ALL
* • TERMINATED
* • ACTIVE
*/
status?: string | null;
/**
* Page Number (as shown to the users)
* Optional
* Default value 1
*/
currentPage?: number;
/**
* Page Size – Number of records to show on a page.
* Optional
* Default value 50.
* Return all rows if -1 is supplied as page size.
*/
pageSize?: number;
}
export declare const cardGroupRequestSchema: Schema<CardGroupRequest>;