openapi: 3.2.0 info: title: Public Config Configuration API version: '1.0' servers: - url: '{corename}.config-api.{env}.gpsrv.com/config/1.0/' tags: - name: Configuration paths: /getProductConfig: parameters: - $ref: '#/components/parameters/AuthorizationHeaderParam' post: tags: - Configuration summary: Get Product Config description: Use the Get Product Config endpoint to retrieve the product configuration according to the specified `section`. operationId: pubconfig_post_getproductconfig requestBody: content: application/json: schema: properties: prod_id: type: integer title: Prod Id description: 'System-generated identifier for a product. Pattern: Integer Example: `50031`' examples: - 50031 section: type: string enum: - auth_limits - product_limits - load_limits - trans_limits - mcc_blocks - mcc_upcharges - mcc_expirations - country_blocks - parameters - fees - card_features - account_features - info - emboss_stocks - emboss_partners title: Section description: 'The section of the product configuration to retrieve. See [Valid `section` values](#valid-section-values). You can input only one section at a time. Pattern: String Example: `auth_limits`' examples: - auth_limits limit: type: integer title: Limit description: 'The maximum number of records to return. Default: 20 Pattern: Integer Example: `15`' default: 20 examples: - 15 offset: type: integer title: Offset description: 'Which record to return as the first record. Default: 0 (start with the first) Pattern: Integer Example: `5`' default: 0 examples: - 5 type: object required: - prod_id - section title: ProductConfigRequest required: true responses: '200': description: Successful Response content: application/json: schema: properties: description: type: string title: Description description: Description of the status code data: anyOf: - anyOf: - properties: prod_id: type: integer title: Prod Id description: System-generated product ID limits: items: properties: prod_id: type: integer title: Prod Id description: System-generated product ID period: type: string title: Period description: 'Timespan of the control: [integer][period] where `period` is `T` (single transaction); `D` (calendar day); `M` (calendar month)' amt: type: float title: Amt description: Amount of the control cnt: type: integer title: Cnt description: Transaction count of the control velocity_id: type: integer title: Velocity Id description: Identifier for the product-level control, also called "Control ID" limit_cat: type: string title: Limit Cat description: Descriptor of the limit domestic_flag: type: string title: Domestic Flag description: 'Whether the control applies only to domestic transactions: `Y` (domestic only), `N` (international only), `A` (both domestic and international)' has_pin_flag: type: string title: Has Pin Flag description: 'Whether the control applies only to PIN transactions: `Y` (PIN only), `N` (signature only), `A` (both PIN and signature)' contactless_flag: type: string title: Contactless Flag description: 'Whether the control applies only to contactless transactions: `Y` (contactless only), `N` (non-contactless only), `A` (both contactless and non-contactless)' type: object required: - prod_id - period title: AuthLimit type: array title: Limits description: List of authorization controls. See Auth limits on the _Product Settings_ page for details. limit: type: integer title: Limit description: Maximum pages to return offset: type: integer title: Offset description: Page number retrieved total_count: type: integer title: Total Count description: Total number of pages type: object required: - prod_id - limits - limit - offset - total_count title: AuthLimitResp - properties: prod_id: type: integer title: Prod Id description: System-generated product ID product_limits: items: properties: active: type: string title: Active description: Whether this IVR limit is active amt: type: number title: Amt description: IVR limit amount, if set ceiling: type: integer title: Ceiling description: Limit maximum floor: type: integer title: Floor description: Limit minimum pct: type: integer title: Pct description: IVR limit percentage, if set prod_id: type: integer title: Prod Id description: System-generated product ID prod_limit_id: type: integer title: Prod Limit Id description: Identifier for the product limit sh_desc: type: string title: Sh Desc description: 'One of these values: `CSD` (Days after activation that an account holder can call a live agent for free), `CSM` (Free live-agent calls per month), `IVD` (Days an account holder can call the automated service for free), `IVM` (Free automated service calls per month)' type: object required: - active - amt - prod_id - prod_limit_id - sh_desc title: ProductLimit type: array title: Product Limits description: List of <> limits limit: type: integer title: Limit description: Maximum pages to return offset: type: integer title: Offset description: Page number retrieved total_count: type: integer title: Total Count description: Total number of pages type: object required: - prod_id - product_limits - limit - offset - total_count title: ProductLimitResp - properties: prod_id: type: integer title: Prod Id description: System-generated product ID load_limits: items: properties: load_limit_id: type: integer title: Load Limit Id description: ID of the load limit prod_id: type: integer title: Prod Id description: System-generated product ID limit_type: type: integer title: Limit Type description: Load-limit type value: type: float title: Value description: Amount or count of the load limit load_type: type: string title: Load Type description: The load otype active: type: string title: Active description: Whether the limit is active period: type: integer title: Period description: Number of days for the limit reject: type: string title: Reject description: 'Whether to reject or pend a load after the limit is reached: `Yes` = reject the load; `No` = pend the load' type: object required: - load_limit_id - prod_id - limit_type - value - load_type - active - period - reject title: LoadLimitModel type: array title: Load Limits description: List of load limits. See Load limits on the _Product Settings_ page for details. limit: type: integer title: Limit description: Maximum pages to return offset: type: integer title: Offset description: Page number retrieved total_count: type: integer title: Total Count description: Total number of pages type: object required: - prod_id - load_limits - limit - offset - total_count title: LoadLimitResp - properties: prod_id: type: integer title: Prod Id description: System-generated product ID trans_limits: items: properties: active: type: string title: Active description: Whether the limit is active limit_type: type: integer title: Limit Type description: Transfer-limit type period: type: string title: Period description: Timespan for the limit prod_id: type: integer title: Prod Id description: System-generated product ID trans_act_type: type: string title: Trans Act Type description: Transfer activity type trans_limit_id: type: integer title: Trans Limit Id description: Transfer limit ID trans_type: type: string title: Trans Type description: Transfer type or otype that the limit applies to trans_type_cats: items: {} type: array title: Trans Type Cats description: 'List of transfer-type categories: `act_type` + `otype`' value: type: number title: Value description: Transfer count limit type: object required: - active - limit_type - prod_id - trans_act_type - trans_limit_id - trans_type - trans_type_cats - value title: TransLimit type: array title: Trans Limits description: List of transfer limits. See Transfer limits on the _Product Settings_ page for details. limit: type: integer title: Limit description: Maximum pages to return offset: type: integer title: Offset description: Page number retrieved total_count: type: integer title: Total Count description: Total number of pages type: object required: - prod_id - trans_limits - limit - offset - total_count title: TransLimitResp - properties: prod_id: type: integer title: Prod Id description: System-generated product ID params: items: properties: param_id: type: string title: Param Id description: Parameter name value: type: string title: Value description: Current parameter setting type: object required: - param_id - value title: ProdParam type: array title: Params description: List of parameter settings. See the Parameters reference page for details. limit: type: integer title: Limit description: Maximum pages to return offset: type: integer title: Offset description: Page number retrieved total_count: type: integer title: Total Count description: Total number of pages type: object required: - prod_id - params - limit - offset - total_count title: ProdParamResp - properties: prod_id: type: integer title: Prod Id description: System-generated product ID fees: items: properties: prod_fee_id: type: integer title: Prod Fee Id description: Identifier for the fee prod_id: type: integer title: Prod Id description: System-generated product ID sh_desc: type: string title: Sh Desc description: Short description of the fee. amt: type: number title: Amt description: Fee amount, if set default: 0 pct: type: number title: Pct description: Fee percentage, if set default: 0 floor: type: number title: Floor description: Fee minimum default: 0 ceiling: type: number title: Ceiling description: Fee maximum default: 0 otype: type: integer title: Otype description: Transaction type that the fee is applied to. See system fee values for valid values active: type: string title: Active description: Whether the fee is active fee_method: type: string title: Fee Method description: 'Insufficient funds action: `P` (retry fee daily), `N` (drive balance negative)' exp_days: type: integer title: Exp Days description: Number of expiry days for the fee excl_acct_status: type: string title: Excl Acct Status description: Account statuses that are excluded from fee assessment. fee_info: description: Information about the fee properties: code: type: integer title: Code description: Three-character fee code. See system fee values for valid values code_desc: type: string title: Code Desc description: Description for `code` type: object required: - code - code_desc title: FeeInfo type: object required: - prod_fee_id - prod_id - sh_desc - otype - active - fee_method - exp_days - fee_info title: ProductFee type: array title: Fees description: List of fees. See Fees on the _Product Settings_ page for details. limit: type: integer title: Limit description: Maximum pages to return offset: type: integer title: Offset description: Page number retrieved total_count: type: integer title: Total Count description: Total number of pages type: object required: - prod_id - fees - limit - offset - total_count title: ProductFeeResp - properties: prod_id: type: integer title: Prod Id description: System-generated product ID mcc_blocks: items: properties: beg_mcc: type: integer title: Beg Mcc description: First MCC in the range deny_allow: type: string title: Deny Allow description: Whether to deny or allow the MCC range end_mcc: type: integer title: End Mcc description: Last MCC in the range online_only: type: string title: Online Only description: Whether the control applies only to card-not-present transactions prod_id: type: integer title: Prod Id description: System-generated product ID type: object required: - beg_mcc - deny_allow - end_mcc - online_only - prod_id title: MccBlock type: array title: Mcc Blocks description: List of <> controls. See MCC blocks on the _Product Settings_ page for details. limit: type: integer title: Limit description: Maximum pages to return offset: type: integer title: Offset description: Page number retrieved total_count: type: integer title: Total Count description: Total number of pages type: object required: - prod_id - mcc_blocks - limit - offset - total_count title: MccBlockResp - properties: prod_id: type: integer title: Prod Id description: System-generated product ID mcc_upcharges: items: properties: amt: type: integer title: Amt description: Flat amount of the upcharge beg_mcc: type: integer title: Beg Mcc description: First <> in the range cps_level: type: string title: Cps Level description: Visa Chargeback Protection Service level dscr: type: string title: Dscr description: Upcharge description end_mcc: type: integer title: End Mcc description: Last MCC in the range mcc_id: type: integer title: Mcc Id description: ID of the upcharge pct: type: number title: Pct description: Upcharge percentage prod_id: type: integer title: Prod Id description: System-generated product ID replace_flag: type: string title: Replace Flag description: Whether to replace the request amount with the upcharge; else, add to it. req_amt_limit: type: integer title: Req Amt Limit description: Whether to apply the upcharge when the amount is less than or equal to a threshold. type: object required: - amt - beg_mcc - cps_level - dscr - end_mcc - mcc_id - pct - prod_id - replace_flag title: MccUpcharge type: array title: Mcc Upcharges description: List of upcharges per MCC. See Upcharges on the _Product Settings_ page for details. limit: type: integer title: Limit description: Maximum pages to return offset: type: integer title: Offset description: Page number retrieved total_count: type: integer title: Total Count description: Total number of pages type: object required: - prod_id - mcc_upcharges - limit - offset - total_count title: MccUpchargeResp - properties: prod_id: type: integer title: Prod Id description: System-generated product ID mcc_expirations: items: properties: expire_param_id: type: integer title: Expire Param Id description: ID for the auth expiry prod_id: type: integer title: Prod Id description: System-generated product ID dscr: type: string title: Dscr description: Description of the auth expiry mcc: type: integer title: Mcc description: MCC of the auth expiry, if set mcc_group: type: string title: Mcc Group description: '<> group for the auth expiry, if set: `AL` (airlines), `HT` (hotels), `RC` (rental cars)' amt: type: integer title: Amt description: Minimum amount for the auth expiry exp_days: type: integer title: Exp Days description: Number of days before auth expiry param_type: type: string title: Param Type description: 'Matching criteria: `A` (amount), `M` (amount and MCC), `T` (amount and MCC group), `D` (product ID)' auth_type: type: string title: Auth Type description: The otype of the authorization type: object required: - expire_param_id - prod_id - amt - exp_days - param_type title: MccExpiration type: array title: Mcc Expirations description: List of auth expiries. See Customized auth expiries on the _Product Settings_ page for details. limit: type: integer title: Limit description: Maximum pages to return offset: type: integer title: Offset description: Page number retrieved total_count: type: integer title: Total Count description: Total number of pages type: object required: - prod_id - mcc_expirations - limit - offset - total_count title: MccExpirationResp - properties: prod_id: type: integer title: Prod Id description: System-generated product ID country_blocks: items: properties: cash_block: type: string title: Cash Block description: 'Whether cash withdrawal is blocked ' cnp_block: type: string title: Cnp Block description: Whether card-not-present transactions are blocked cntry_cd: type: string title: Cntry Cd description: Country code pos_block: type: string title: Pos Block description: Whether point-of-sale transactions are blocked prod_id: type: integer title: Prod Id description: System-generated product ID type: object required: - cash_block - cnp_block - cntry_cd - pos_block - prod_id title: CountryBlock type: array title: Country Blocks description: List of blocked countries. See Country blocks on the _Product Settings_ page for details. limit: type: integer title: Limit description: Maximum pages to return offset: type: integer title: Offset description: Page number retrieved total_count: type: integer title: Total Count description: Total number of pages type: object required: - prod_id - country_blocks - limit - offset - total_count title: CountryBlockResp - properties: prod_id: type: integer title: Prod Id description: System-generated product ID emboss_stocks: items: properties: denom: type: float title: Denom description: Deprecated dscr: type: string title: Dscr description: Description of the card stock filename: type: string title: Filename description: Deprecated prod_id: type: integer title: Prod Id description: System-generated product ID production_type: type: string title: Production Type description: 'One of these codes: `01` (New issuance), `02` (Replacement issuance), `03` (PIN mailer only), `04` (Welcome pack only)' stock_no: type: string title: Stock No description: Embosser-provided stock number stock_type: type: string title: Stock Type description: 'One of these codes: `CC` (Card carrier), `CS` (Card stock), `PM` (PIN mailer), `WP` (Welcome pack)' type: object required: - prod_id - production_type - stock_no - stock_type title: EmbossStock type: array title: Emboss Stocks description: List of card stocks. See Emboss stock on the _Product Settings_ page for details. limit: type: integer title: Limit description: Maximum pages to return offset: type: integer title: Offset description: Page number retrieved total_count: type: integer title: Total Count description: Total number of pages type: object required: - prod_id - emboss_stocks - limit - offset - total_count title: EmbossStockResp - properties: prod_id: type: integer title: Prod Id description: System-generated product ID emboss_partners: items: properties: fl_mask: type: string title: Fl Mask description: File mask for the emboss partner partner_id: type: integer title: Partner Id description: System-generated partner ID prod_id: type: integer title: Prod Id description: System-generated product ID status: type: string title: Status description: Emboss partner status type: object required: - fl_mask - partner_id - prod_id - status title: EmbossPartner type: array title: Emboss Partners description: List of emboss partners. See Emboss partners on the _Product Settings_ page for details. limit: type: integer title: Limit description: Maximum pages to return offset: type: integer title: Offset description: Page number retrieved total_count: type: integer title: Total Count description: Total number of pages type: object required: - prod_id - emboss_partners - limit - offset - total_count title: EmbossPartnerResp - properties: card_features: items: properties: prod_card_feature_id: type: integer title: Prod Card Feature Id description: Identifier for the `fet_id` + `value` combination prod_id: type: integer title: Prod Id description: System-generated product ID fet_id: type: integer title: Fet Id description: Feature ID number value: type: string title: Value description: Value for the feature ID type: object required: - prod_card_feature_id - prod_id - fet_id - value title: CardFeature type: array title: Card Features description: List of card features. See Card features on the _Product Settings_ page for details. limit: type: integer title: Limit description: Maximum pages to return offset: type: integer title: Offset description: Page number retrieved total_count: type: integer title: Total Count description: Total number of pages type: object required: - card_features - limit - offset - total_count title: CardFeatureResp - properties: prod_id: type: integer title: Prod Id description: System-generated product ID account_features: items: properties: fet_id: type: integer title: Fet Id description: Feature ID number prod_acct_feature_id: type: integer title: Prod Acct Feature Id description: Identifier for the `fet_id` + `value` combination prod_id: type: integer title: Prod Id description: System-generated product ID value: type: string title: Value description: Value of the feature ID type: object required: - fet_id - prod_acct_feature_id - prod_id - value title: AccountFeature type: array title: Account Features description: List of account features. See Account features on the _Product Settings_ page for details. limit: type: integer title: Limit description: Maximum pages to return offset: type: integer title: Offset description: Page number retrieved total_count: type: integer title: Total Count description: Total number of pages type: object required: - prod_id - account_features - limit - offset - total_count title: AccountFeatureResp - properties: prod_id: type: integer title: Prod Id description: Product ID info: description: Product information. See Product info on the _Product Settings_ page for details. properties: product_id: type: integer title: Product Id description: System-generated product ID name: type: string title: Name description: Name of the product program_id: type: integer title: Program Id description: System-generated ID for the program base_bin: type: string title: Base Bin description: Base <> associated with the product auth_days_to_expire: type: integer title: Auth Days To Expire description: Number of days before a general auth expires db: type: string title: Db description: Name of the core where the product data is stored gas_auth_amt: type: integer title: Gas Auth Amt description: Amount limit at gas pumps (MCC 5542) in cents. hold_days: type: integer title: Hold Days description: ACH hold days ica: type: string title: Ica description: _Mastercard only_. Interbank Card Association number max_pin_retries: type: integer title: Max Pin Retries description: PIN-fail count min_act_amt: type: number title: Min Act Amt description: Minimum balance required to activate the account product_type: type: integer title: Product Type description: Product otype product_category: type: integer title: Product Category description: Category of the product svc_code: type: string title: Svc Code description: 'Properties of the physical card: `101` (Magstripe U.S.), `201` (EMV and/or contactless U.S.), `121` (Magstripe Canada), `221` (EMV Canada), `502` (Contactless Canada)' yrs_card_is_valid: type: integer title: Yrs Card Is Valid description: Number of years before the card expires issuer_card_art_id: type: string title: Issuer Card Art Id description: Default designator for the product's card art is_business_product: type: string title: Is Business Product description: Whether the product is a business product bins: anyOf: - items: properties: base_bin: type: string title: Base Bin description: Base <> associated with the product product_id: type: integer title: Product Id description: System-generated product ID generating_pans: type: string enum: - Y - N title: Generating Pans description: Whether new PANs are being generated from the BIN type: object required: - base_bin - product_id - generating_pans title: BinInfo type: array - type: 'null' title: Bins description: List of BINs associated with the product, in the case of a product with multiple BINs type: object required: - product_id - name - program_id - base_bin - auth_days_to_expire - db - gas_auth_amt - hold_days - ica - max_pin_retries - min_act_amt - product_type - product_category - svc_code - yrs_card_is_valid - issuer_card_art_id - is_business_product - bins title: ProductInfo type: object required: - prod_id - info title: ProductInfoResp title: ProductConfigResponseContent - type: 'null' description: Data returned from the operation, present only if successful rtoken: type: string title: Rtoken description: Token associated with the request errors: anyOf: - items: {} type: array - type: 'null' title: Errors description: List of errors that occurred during the request processing type: object required: - description - rtoken title: ResponseContent examples: response: value: "{\n \"description\": \"Success\", \n \"data\": {\n \"prod_id\": 5048, \n \"limits\": [\n {\n \"prod_id\": 5048, \n \"period\": \"1D\", \n \"amt\": 2500.0, \n \"cnt\": None, \n \"velocity_id\": None, \n \"limit_cat\": \"PCL Daily Limit\", \n \"domestic_flag\": \"A\", \n \"has_pin_flag\": \"A\", \n \"contactless_flag\": None\n }, \n {\n \"prod_id\": 5048, \n \"period\": \"1T\", \n \"amt\": 515.0, \n \"cnt\": None, \n \"velocity_id\": None, \n \"limit_cat\": \"TAT Per Transaction Limit\", \n \"domestic_flag\": \"A\", \n \"has_pin_flag\": \"A\", \n \"contactless_flag\": None\n }, \n {\n \"prod_id\": 5048, \n \"period\": \"1T\", \n \"amt\": 515.0, \n \"cnt\": None, \n \"velocity_id\": None, \n \"limit_cat\": \"TCA Per Transaction Limit\", \n \"domestic_flag\": \"A\", \n \"has_pin_flag\": \"A\", \n \"contactless_flag\": None\n }, \n {\n \"prod_id\": 5048, \n \"period\": \"1D\", \n \"amt\": 1030.0, \n \"cnt\": None, \n \"velocity_id\": None, \n \"limit_cat\": \"TOL Daily Limit\", \n \"domestic_flag\": \"A\", \n \"has_pin_flag\": \"A\", \n \"contactless_flag\": None\n }, \n { \n \"prod_id\": 5048, \n \"period\": \"1D\", \n \"amt\": 515.0, \n \"cnt\": None, \n \"velocity_id\": None, \n \"limit_cat\": \"ATL Daily Limit\", \n \"domestic_flag\": \"A\", \n \"has_pin_flag\": \"A\", \n \"contactless_flag\": None\n }, \n {\n \"prod_id\": 5048, \n \"period\": \"1D\", \n \"amt\": 515.0, \n \"cnt\": None, \n \"velocity_id\": None, \n \"limit_cat\": \"CAL Daily Limit\", \n \"domestic_flag\": \"A\", \n \"has_pin_flag\": \"A\", \n \"contactless_flag\": None\n }, \n {\n \"prod_id\": 5048, \n \"period\": \"1D\", \n \"amt\": 2500.0, \n \"cnt\": None, \n \"velocity_id\": None, \n \"limit_cat\": \"POL Daily Limit\", \n \"domestic_flag\": \"A\", \n \"has_pin_flag\": \"A\", \n \"contactless_flag\": None\n }\n ], \n \"limit\": 20, \n \"offset\": 0, \n \"total_count\": 7\n }, \n \"rtoken\": \"79b94bf4-0f94-4ad0-8532-e8a7f8e6f048\"\n }" '422': description: Validation Error content: application/json: schema: properties: detail: items: properties: loc: items: anyOf: - type: string - type: integer type: array title: Location msg: type: string title: Message type: type: string title: Error Type type: object required: - loc - msg - type title: ValidationError type: array title: Detail type: object title: HTTPValidationError components: parameters: AuthorizationHeaderParam: name: Authorization in: header description: For `{token}` insert base64-encoded `apilogin:transkey` schema: type: string default: Basic {token} x-readme: samples-languages: - curl - python - node - java - go - ruby - javascript explorer-enabled: true proxy-enabled: true