Ctrlk
Integrations HubContact SupportLog In
For the complete documentation index, see llms.txt. This page is also available as Markdown.
Starter EditionEssentials EditionPro EditionEnterprise Edition

Add Credit Card Catalogs as a Brand

A credit card catalog is a data file containing detailed information about the credit card products on your site. Connecting your catalog to impact.com gives partners the data they need to promote your card offers through placements, like comparison shopping engines or product storefronts.

1

Prepare your catalog for upload

Before uploading your file, make sure it meets the following formatting guidelines:

Catalog field guidelines
Column Name
Required
Description
Type
Strongly Recommended for Compliance Agent

CatalogItemId

Yes

An ID which uniquely identifies the item within the catalog. This should correspond to the unique ID used within your feed, e.g. the Card ID.

String

Yes

Name

Yes

Name of the item.

String

Yes

Description

No

A brief description of the item. You can include commas.

String

Yes

MobileDescription

No

A brief description of the item suitable for mobile devices.

String

Bullets

Yes

Additional promotional descriptions for this product. Valid values: Pipe separated values.

PSV string

Yes

Labels

No

A list of terms or approved categories that identify with the card product. Valid values: Comma separated values.

CSV string

Manufacturer

No

The brand of the card product.

String

ProcessingNetwork

No

The network that processes this card's transactions. Valid values: Visa®, MasterCard®, MasterCard® World, MasterCard® World Elite, Discover, American Express.

String

Url

Yes

URL on your website where customers can apply for your card product.

String

Yes

MobileUrl

No

URL on your mobile website where customers can apply for the card product.

String

ImageUrl

No

URL to the item's primary image.

String

CurrentPrice

No

The annual membership fee for the item.

Decimal(8,2)

Yes

CurrentPriceDescription

No

The annual membership fee description for the item.

String

Yes

Currency

No

The 3 character ISO 4217 currency code.

String

LaunchDate

No

The date when the product was first made available, in the format yyyyMMdd.

Date

ExpirationDate

No

The date when the product will no longer be available, in the format yyyyMMdd.

Date

ProductType

No

The card product type. Valid values: Business, Consumer, Student.

String

Yes

CreditRating

No

The levels of customer creditworthiness that the card is associated with.

CSV string

Yes

CreditRatingDescription

No

A description of the levels of customer creditworthiness that the card is associated with.

String

Yes

IntroPurchaseApr

Yes

The introductory Annual Percentage Rate (APR) on purchases.

Decimal(8,2)

Yes

IntroPurchaseAprType

Yes

The type of APR that applies to standard purchases during the introductory period.

String

Yes

IntroPurchaseAprDescription

Yes

The text describing the Intro Purchase APR.

String

Yes

IntroPurchaseAprPeriod

Yes

The introductory Annual Percentage Rate (APR) period on purchases.

Integer

Yes

IntroPurchaseAprPeriodType

Yes

Unit of measure for Intro Purchase APR Period. Valid values: Months, Days, Years.

String

Yes

IntroPurchaseAprPeriodDescription

Yes

The text describing Intro Purchase APR Period.

String

Yes

NonIntroPurchaseApr

Yes

The Annual Percentage Rate (APR) range on standard purchases. Specify as a single value for a constant rate, or as 2 values separated by a semi-colon for a variable rate, e.g. 2.2;3.3.

Decimal(8,2)

Yes

NonIntroPurchaseAprType

Yes

The type of APR that applies to standard purchases during the non-introductory period.

String

Yes

NonIntroPurchaseAprDescription

Yes

The text describing the non-intro Purchase APR.

String

Yes

PurchaseGracePeriod

No

The grace period in days for purchases.

Integer

Yes

IntroTransferApr

No

The introductory Annual Percentage Rate (APR) on balance transfers.

Decimal(8,2)

Yes

IntroTransferAprType

No

The type of APR that applies to balance transfers during the introductory period.

String

Yes

IntroTransferAprDescription

No

The text describing the Intro Transfer APR.

String

Yes

IntroTransferAprPeriod

No

The introductory Annual Percentage Rate period on balance transfers.

Integer

Yes

IntroTransferAprPeriodType

No

The type of APR that applies to balance transfers during the introductory period. Valid values: Months, Days, Years.

String

Yes

IntroTransferAprPeriodDescription

No

The text describing Intro Transfer APR Period.

String

Yes

NonIntroTransferApr

No

The Annual Percentage Rate (APR) range on balance transfers after the introductory period. Specify as a single value for a constant rate, or as 2 values separated by a semi-colon for a variable rate, e.g. 2.2;3.3.

Decimal(8,2)

Yes

NonIntroTransferAprType

No

The type of APR that applies to balance transfers during the introductory period.

String

Yes

NonIntroTransferAprDescription

No

The text describing the non-intro Transfer APR.

String

Yes

TransferGracePeriod

No

The grace period in days for balance transfers.

Integer

Yes

CashAdvanceApr

No

The Annual Percentage Rate (APR) on cash advances taken on the card.

Decimal(8,2)

Yes

CashAdvanceAprDescription

No

The text describing Annual Percentage Rate (APR), conditions, and period on cash advances.

String

Yes

CashGracePeriod

No

The grace period in days for cash advances.

Integer

PenaltyApr

No

The penalty Annual Percentage Rate.

Decimal(8,2)

Yes

PenaltyAprDescription

No

General description of the penalty APR.

String

Yes

BalanceTransferFee

No

The percentage fee for balance transfers.

Decimal(8,2)

Yes

BalanceTransferFeeDescription

No

General description of any fees associated with balance transfers for the product.

String

Yes

CashAdvanceFee

No

The percentage fee for cash advances and the minimum fee amount, i.e. X%;Y. Example: 2.2;3.3.

Decimal(8,2)

Yes

CashAdvanceFeeDescription

No

Any fees required to be paid for cash advance transactions.

String

Yes

LatePaymentFee

No

The late payment fee. Up to this amount may be charged.

Decimal(8,2)

Yes

LatePaymentFeeDescription

No

General description of late payment fee.

String

Yes

ReturnCheckFee

No

The return check fee. Up to this amount may be charged.

Decimal(8,2)

ReturnCheckFeeDescription

No

General description of the return check fee.

String

OverlimitFee

No

The over limit fee amount.

Decimal(8,2)

OverlimitFeeDescription

No

General description of overlimit fee.

String

ForeignTransactionFee

No

Any foreign transaction fees required by this product.

Decimal(8,2)

ForeignTransactionFeeDescription

No

General description of foreign transaction fees associated with this credit product.

String

MinimumDeposit

No

The minimum deposit fee amount.

Decimal(8,2)

Yes

RewardsType

No

The type of rewards program, if applicable. Valid values: Miles, Points, Cashback, Starpoints.

String

Yes

RewardsBonus

No

Describes bonuses associated with rewards.

String

Yes

RewardsRate

No

Rates associated with rewards.

String

Yes

RewardsType2

No

The type of rewards program, if applicable. Valid values: Miles, Points, Cashback, Starpoints.

String

RewardsBonus2

No

Describes bonuses associated with rewards.

String

RewardsRate2

No

Rates associated with rewards.

String

RewardsType3

No

The type of rewards program, if applicable. Valid values: Miles, Points, Cashback, Starpoints.

String

RewardsBonus3

No

Describes bonuses associated with rewards.

String

RewardsRate3

No

Rates associated with rewards.

String

AvailableApplications

No

The set of platforms for which applications are available. Valid values: Comma separated values (Desktop, Mobile, Phone).

CSV string

Terms

No

The terms and conditions of the credit card.

String

BonusOffer

No

Free text field to describe any bonuses you offer (e.g. introductory bonus, sign up bonus, Welcome Bonus).

String

Yes

BonusOfferTerms

No

General text describing the terms for receiving the Welcome Offer Bonus.

String

Yes

ProhibitedCategories

No

A list of prohibited terms or categories that do not identify with the card product.

String

Yes

Text1

No

Your own custom string.

String

Text2

No

Your own custom string.

String

Text3

No

Your own custom string.

String

Numeric1

No

Custom numeric value.

Decimal(8,2)

Numeric2

No

Custom numeric value.

Decimal(8,2)

Numeric3

No

Custom numeric value.

Decimal(8,2)

Money1

No

Custom money value.

Decimal(8,2)

Money2

No

Custom money value.

Decimal(8,2)

Money3

No

Custom money value.

Decimal(8,2)

File extension guidelines

  • When using .txt format, always save the file in UTF-16 encoding.

  • When using .csv format, always save the file in UTF-8 encoding.

  • For .aprx fields, if you prefer using your own text instead of impact.com's specified format, use the Description fields.

  • To open a downloaded file in Microsoft Excel if it's not in .xlsx format, do the following to avoid encoding issues:

    1. Open a blank Microsoft Excel workbook, and in the upper-left corner, select File → Import.

    2. Select the file format, e.g., CSV → Get data → Delimited.

    3. Select the file origin, e.g., Unicode UTF-8 → Comma Separated.

    4. Select Open File.

Here's an example of how you might format your text file:

CatalogItemId,Name,Url,Description,ImageUrl,Bullets,ProductType,CurrentPrice,IntroPurchaseApr,IntroPurchaseAprType,IntroPurchaseAprDescription,IntroPurchaseAprPeriod,IntroPurchaseAprPeriodType,IntroPurchaseAprPeriodDescription,NonIntroPurchaseApr,NonIntroPurchaseAprType,NonIntroPurchaseAprDescription
ACME-001,Acme Gadget Rewards Card,https://acmecorp.example/cards/gadget-rewards,Earn unlimited rewards on every anvil, dynamite stick, and rocket-powered roller skate purchase.,https://acmecorp.example/img/gadget-card.png,Unlimited 3% cashback on gadget purchases|No annual fee|Free shipping on all anvils,Consumer,0.00,0.00,Fixed,0% intro APR on purchases for the first 15 months,15,Months,0% APR applies for 15 months from account opening,19.99,Variable,Variable APR based on the Prime Rate
ACME-002,Acme Inventor Business Card,https://acmecorp.example/cards/inventor-business,Designed for small businesses that need reliable supplies of parachutes, trick gadgets, and whimsical toys.,https://acmecorp.example/img/inventor-card.png,2x points on business supplies|Employee cards at no extra cost|Annual fee waived first year,Business,95.00,0.00,Fixed,0% intro APR on purchases for the first 12 months,12,Months,0% APR applies for 12 months from account opening,21.49,Variable,Variable APR based on the Prime Rate
2

Upload your credit card catalog

Upload your file or create an automatic data feed in your catalog settings:

  1. From the left navigation bar, select Engage → Content → Products → Product Catalogs.

  2. In the upper-right corner, select Create Product Catalog Asset → Credit Card.

  3. Fill in the fields as described in the Catalog settings reference below.

Catalog settings reference
Field
Description

Product Catalog Name

Enter a name for your catalog. This will be visible to partners so that they can identify the catalog. If you have multiple catalogs, they should have unique names.

Labels

Optionally, use labels to make the product catalog searchable by keyword for partners.

Catalog Instructions

Optionally, include a PDF file providing partners with additional catalog usage details. impact.com recommends including this step.

Upload Method

Choose 1 of 3 methods to upload your catalog by selecting the [Radio button] [Radio Button].

Direct upload

  • This option is only available for file sizes < 1 GB.

impact.com FTP server

  • Larger catalogs can be uploaded to impact.com's FTP server. You'll receive login details and instructions once you create your first catalog with this method.

  • The credentials will be emailed to all account users with technical permissions. You can check your account permissions under [User] [User profile] → Settings → Account Users.

  • You can use these same credentials for uploading subsequent product catalogs.

Pull from URL

  • Specify the URL location where impact.com can retrieve the product catalog.

  • For FTP, the URL should be of the FTP directory and the configured filename needs to match the name of the file on the FTP server.

  • The catalog is pulled periodically depending on the configured fetch frequency, which is set to Daily by default.

Service Areas

Use the fields and arrows to select Service Areas for geo-targeting.

Your Available areas are the service areas targeted by your program. You can change this in your program settings as follows:

  1. From the left navigation menu, select [User] [User profile] → Settings.

  2. In the left column, under General, select Manage Programs.

  3. Select the the ID of the program for which you want to adjust Service Area settings.

  4. Under Program Information, navigate to Service Areas.

  5. Use the [Drop-down menu] [Drop-down menu] and [Checked box] [Checked boxes] to select or deselect service areas as needed.

  6. Once you're done, select Save.

Mobile Fallback

Optionally, [Toggle on] [Toggle on] to reroute traffic elsewhere if users don't have your mobile app installed.

Access Product Catalog via API

Optionally, get API access so that you can maintain your product catalogs via API. This will enable you to query, create, update, and delete catalog items. See the API documentation for more info.

Restrict Partner Access

Optionally, [Toggle on] [Toggle on] to permit only specific partners to access the catalog. Use the fields and arrows to restrict access to particular partner groups, and use the search bar to search for individual partners to make the ad only available to them.

Partner Download Options

Optionally, deselect any methods that you don't want partners to use when downloading your catalog. All methods are permitted by default.

  • FTP

  • API

  • Partner Portal Browser Download

  1. Select Save.

  2. Upload your catalog.

    • Ensure that the file name and extension match the details you provided in the Upload Method field.

  3. Select Done.

3

Troubleshoot your upload

After creating and uploading your product catalog, impact.com processes the file for errors. Errors can affect the availability of your catalog to partners as detailed in the following scenarios:

Scenario
Possible reason

Catalog not made accessible at all

• > 10% of records have errors

• The file name doesn't match the file name you provided

• The file is empty

Full catalog made accessible

• < 10 % of records have errors

Note: The catalog may still have minor issues like warnings or duplicates, which you can fix if you wish.

Specific records excluded

• The excluded records have errors, but erroneous records make up < 10%

Common error messages & causes
Error Message
Meaning

No catalog found for the request. Check if the file name of uploaded file is the same as the one registered with the catalog

The uploaded file's name doesn't match the name you provided in the Upload Method field when creating the catalog.

No attributes present in the catalog file

The catalog file is empty.

Catalog item with ID occurs more than once in the catalog, and those after the first will be ignored

There are duplicate product IDs in the catalog.

Record '1' has an error: (line 1) invalid char between encapsulated token and delimiter

Your delimited file contains invalid use of double quotes.

Double quotes within a field's content must be replaced with 2 double quotes. E.g.: 8" Anvil becomes "8"" Anvil".

(startline 1) EOF reached before encapsulated token finished

Your delimited file contains an opening double quote and a new line prior to the closing of the quotes.

Error parsing (catalog type) field: with value: (field)

The product field value cannot be accepted.

Record (recordNumber) has an error: The number of delimited values (FieldsLength) does not match the expected (ColumnNamesLength)

The number of record fields does not match the number of column names in your delimited catalog.

No valid records were found in the catalog file

Your catalog has no records.

More than 10% of the records in the file had errors

More than 10% of records in your catalog records have errors and the file cannot be processed.

To receive email notifications regarding product catalog upload failures, do the following:

  1. From the top navigation bar, select [Notifications] → Settings.

  2. Under the Technical section, navigate to Catalog Uploads and select the notification cadence that suits you from the [Drop-down menu].

  3. Select Save.

PreviousFile Formats for Product Catalogs
NextTroubleshoot Product Catalog Errors & Warnings

Last updated

Was this helpful?