Skip to main content
Important
This feature is deprecated and replaced by credit product policies, which is part of the bundles feature. For more on policies and bundles in a credit program, see Managing Credit Programs in the Marqeta Dashboard.
The credit products feature on Marqeta’s credit platform enables you to create and manage a credit product and customize its characteristics, such as the credit line range and required fees or APRs. Credit product characteristics determine the behaviors and attributes of associated credit accounts. For more on credit products, see About Credit Products. To receive webhook notifications when product transition events occur, see Credit product transition events in Event Types.
Important
To create and manage credit products, you must use the Marqeta Dashboard. For more, see Managing Credit Products in the Marqeta Dashboard.
 The following endpoints are displayed for reference purposes only.

Create credit product

Action: POST
Endpoint: /credit/products
Create a credit product.

Request body

FieldsDescription
token

string

Optional
Unique identifier of the credit product.

Allowable Values:

36 char max
card_product_tokens

array of strings

Required
One or more associated card product tokens.

Allowable Values:

Existing card product tokens
name

string

Required
Name of the credit product.

Allowable Values:

255 char max
description

string

Optional
Description of the credit product.

Allowable Values:

255 char max
status

string

Optional
Status of the credit product.

- DRAFT - The credit product is in the process of being created.
- PENDING_APPROVAL - The credit product has been created and is awaiting approval.
- SENT_FOR_REVISION - The credit product has been returned for revision.
- ACTIVE - The credit product is active.
- REJECTED - The credit product has been rejected; this status cannot be changed.
- ARCHIVED - The previously active credit product has been archived.

Allowable Values:

DRAFT, PENDING_APPROVAL, SENT_FOR_REVISION, ACTIVE, REJECTED, ARCHIVED
classification

string

Required
Specifies for whom the credit product is intended.

- CONSUMER - The credit product is intended for individual consumers.
- SMALL_AND_MEDIUM_BUSINESS - The credit product is intended for small and medium business.

Allowable Values:

CONSUMER, SMALL_AND_MEDIUM_BUSINESS
product_type

string

Required
Type of credit product.

REVOLVING - Allows users to continuously borrow and pay debts up to the credit limit.

Allowable Values:

REVOLVING
product_sub_type

string

Required
Subtype of the credit product type.

- CREDIT_CARD - Card that enables the cardholder to make purchases on credit.
- SECURED_CARD - Card backed by a user-funded deposit that enables the cardholder to make purchases on credit.

Allowable Values:

CREDIT_CARD, SECURED_CARD
currency_code

string

Required
Valid three-digit ISO 4217 currency code.

Allowable Values:

USD
credit_line

object

Required
Contains information on the credit line range.

Allowable Values:

Existing credit_line object
credit_line.min

decimal

Required
Minimum credit limit.

Allowable Values:

0–999999999999.99
credit_line.max

decimal

Required
Maximum credit limit.

Allowable Values:

0–999999999999.99
usage

array of strings

Required
One or more usage types for the credit product.

Allowable Values:

PURCHASE
min_payment_percentage

decimal

Required
Minimum payment, expressed as a percentage of the total statement balance, due on the payment due day.

Allowable Values:

0.0001–100
min_payment_flat_amount

decimal

Required
Minimum payment, expressed as a flat amount, due on the payment due day.

Allowable Values:

0.01 min
min_payment_calculation

object

Optional
Contains information used to calculate the minimum payment amount.

Allowable Values:

Existing min_payment_calculation object
min_payment_calculation.include_past_due_amount

boolean

Required
Whether to include the past due amount when calculating the minimum payment.

Allowable Values:

true, false
min_payment_calculation.min_payment_percentage

object

Required
Contains information used to calculate the minimum payment percentage.

Allowable Values:

Existing min_payment_percentage object
min_payment_calculation.min_payment_percentage.percentage_of_balance

decimal

Required
Minimum payment, expressed as a percentage of the total statement balance, due on the payment due day.

Allowable Values:

0.0001–100
min_payment_calculation.min_payment_percentage.include_fees_charged

array of strings

Required
One or more fee types to include when calculating the minimum payment.

Allowable Values:

LATE_PAYMENT_FEE, RETURNED_PAYMENT_FEE, FOREIGN_TRANSACTION_FEE
min_payment_calculation.min_payment_percentage.include_all_fees_charged

boolean

Optional
Whether to include all fees charged when calculating the minimum payments.

Allowable Values:

true, false
min_payment_calculation.min_payment_flat_amount

decimal

Required
Minimum payment, expressed as a flat amount, due on the payment due day.

Allowable Values:

0.01 min
payment_allocation_order

array of strings

Required
Ordered list of balance types to which payments are allocated, from first to last.

Allowable Values:

INTEREST, FEES, PRINCIPAL
interest_calculation

object

Required
Contains the configurations for interest calculation.

Allowable Values:

Existing interest_calculation object
interest_calculation.method

string

Required
Method of interest calculation.

Allowable Values:

AVG_DAILY_BALANCE_WITH_NEW_TRANSACTIONS
interest_calculation.day_count

string

Required
Day-count convention.

Allowable Values:

ACTUAL
interest_calculation.interest_application

array of strings

Required
One or more balance types on which interest is applied.

Allowable Values:

PRINCIPAL, FEES, INTEREST
interest_calculation.minimum_interest

decimal

Required
When interest is applied, this value determines the minimum amount of interest that can be charged.

Allowable Values:

0–999999999999.99
interest_calculation.interest_on_grace_reactivation

string

Required
Determines whether to charge or waive interest for the billing period when the balance is paid off.

Allowable Values:

ACCRUE_FULL_CYCLE, ACCRUE_PAYMENT_DATE, WAIVE
interest_calculation.grace_days_application

string

Required
Determines the last day of grace period based on which interest charges are calculated.

Allowable Values:

NEXT_CYCLE_DATE
interest_calculation.exclude_tran_types

array of strings

Optional
One or more transactions that are excluded from current billing period’s interest charge, but included in next.

Allowable Values:

LATE_PAYMENT_FEE, ANNUAL_FEE, MONTHLY_FEE, CASH_BACK_STATEMENT_CREDIT, RETURNED_PAYMENT_FEE, FOREIGN_TRANSACTION_FEE
config

object

Required
Contains information on configurations for billing cycle day, payment due day, and fees.

Allowable Values:

Existing config object
config.billing_cycle_day

integer

Required
Day of the month when the billing cycle starts.

Allowable Values:

1–28
config.payment_due_day

integer

Optional
Day of month the payment for the previous billing cycle is due.

This field is deprecated. Use the product.payment_due_interval field instead. To retrieve payment_due_interval, see Retrieve credit product, config.payment_due_interval.

Allowable Values:

31
config.billing_cycle_frequency

string

Optional
Frequency at which the account is billed.

Allowable Values:

MONTHLY
config.payment_due_interval

integer

Optional
Specifies the payment due interval that is used to determine the payment due date for a billing cycle. A value of -1 indicates one day prior to the next billing cycle date.

For consumer programs, a minimum gap of 21 days is required between when a statement is delivered and the payment due date.

Allowable Values:

-1 min

Positive integers greater than 0; -1 is the default value
config.billing_cycle_day_strategy

string

Optional
Determines if the billing cycle day is manually set or determined dynamically during account creation based on cycling logic.

Allowable Values:

MANUAL
config.fees

array of strings

Optional
One or more fee types.

Allowable Values:

LATE_PAYMENT_FEE, RETURNED_PAYMENT_FEE, FOREIGN_TRANSACTION_FEE
config.periodic_fees

array of objects

Optional
Contains one or more periodic fees.

Allowable Values:

One or more periodic_fees objects
config.periodic_fees[].frequency

string

Required
How frequently the fee is charged.

Allowable Values:

ANNUAL, MONTHLY
config.periodic_fees[].number_of_days_post_activation

integer

Required
Number of days after an account is activated that the initial fee is charged. For example, if the value in this field is 30, then the initial fee is charged 30 days after an account is activated.

Allowable Values:

1–1000

Sample request body

JSON
{
  "card_product_tokens": [
    "my_card_product1234"
  ],
  "name": "my_credit_product1234",
  "status": "ACTIVE",
  "classification": "CONSUMER",
  "product_type": "REVOLVING",
  "product_sub_type": "CREDIT_CARD",
  "currency_code": "USD",
  "credit_line": {
    "min": 25,
    "max": 200000
  },
  "usage": [
    "PURCHASE"
  ],
  "min_payment_percentage": 1,
  "min_payment_flat_amount": 25,
  "min_payment_calculation": {
    "include_past_due_amount": true,
    "include_overlimit_amount": true,
    "min_payment_percentage": {
      "percentage_of_balance": 1,
      "include_interest_charged": false,
      "include_fees_charged": [
        "LATE_PAYMENT_FEE"
      ]
    },
    "min_payment_flat_amount": 25
  },
  "payment_allocation_order": [
    "INTEREST",
    "FEES",
    "PRINCIPAL"
  ],
  "interest_calculation": {
    "method": "AVG_DAILY_BALANCE_WITH_NEW_TRANSACTIONS",
    "day_count": "ACTUAL",
    "interest_application": [
      "PRINCIPAL",
      "FEES"
    ],
    "minimum_interest": 1,
    "interest_on_grace_reactivation": "ACCRUE_FULL_CYCLE",
    "grace_days_application": "NEXT_CYCLE_DATE",
    "exclude_tran_types": [
      "ANNUAL_FEE",
      "LATE_PAYMENT_FEE",
      "CASH_BACK_STATEMENT_CREDIT"
    ]
  },
  "config": {
    "billing_cycle_day": 1,
    "payment_due_day": 31,
    "fees": [
      "LATE_PAYMENT_FEE"
    ],
    "periodic_fees": []
  }
}

Response body

FieldsDescription
token

string

Conditionally returned
Unique identifier of the credit product.

Allowable Values:

36 char max
parent_product_token

string

Conditionally returned
Unique identifier of the parent credit product.

Allowable Values:

Existing credit product token
card_product_tokens

array of strings

Conditionally returned
One or more associated card product tokens.

Allowable Values:

Existing card product tokens
name

string

Conditionally returned
Name of the credit product.

Allowable Values:

255 char max
description

string

Conditionally returned
Description of the credit product.

Allowable Values:

255 char max
status

string

Conditionally returned
Status of the credit product.

- DRAFT - The credit product is in the process of being created.
- PENDING_APPROVAL - The credit product has been created and is awaiting approval.
- SENT_FOR_REVISION - The credit product has been returned for revision.
- ACTIVE - The credit product is active.
- REJECTED - The credit product has been rejected; this status cannot be changed.
- ARCHIVED - The previously active credit product has been archived.

Allowable Values:

DRAFT, PENDING_APPROVAL, SENT_FOR_REVISION, ACTIVE, REJECTED, ARCHIVED
created_time

datetime

Conditionally returned
Date and time when the credit product was created on Marqeta’s credit platform, in UTC.

Allowable Values:

Format: yyyy-MM-ddThh:mm:ssZ
updated_time

datetime

Conditionally returned
Date and time when the credit product was last updated on Marqeta’s credit platform, in UTC.

Allowable Values:

Format: yyyy-MM-ddThh:mm:ssZ
classification

string

Conditionally returned
Specifies for whom the credit product is intended.

- CONSUMER - The credit product is intended for individual consumers.
- SMALL_AND_MEDIUM_BUSINESS - The credit product is intended for small and medium business.

Allowable Values:

CONSUMER, SMALL_AND_MEDIUM_BUSINESS
product_type

string

Conditionally returned
Type of credit product.

REVOLVING - Allows users to continuously borrow and pay debts up to the credit limit.

Allowable Values:

REVOLVING
product_sub_type

string

Conditionally returned
Subtype of the credit product type.

- CREDIT_CARD - Card that enables the cardholder to make purchases on credit.
- SECURED_CARD - Card backed by a user-funded deposit that enables the cardholder to make purchases on credit.

Allowable Values:

CREDIT_CARD, SECURED_CARD
currency_code

string

Conditionally returned
Valid three-digit ISO 4217 currency code.

Allowable Values:

USD
credit_line

object

Conditionally returned
Contains information on the credit line range.

Allowable Values:

Existing credit_line object
credit_line.min

decimal

Returned
Minimum credit limit.

Allowable Values:

0–999999999999.99
credit_line.max

decimal

Returned
Maximum credit limit.

Allowable Values:

0–999999999999.99
usage

array of strings

Conditionally returned
One or more usage types for the credit product.

Allowable Values:

PURCHASE
min_payment_percentage

decimal

Conditionally returned
Minimum payment, expressed as a percentage of the total statement balance, due on the payment due day.

Allowable Values:

0.0001–100
min_payment_flat_amount

decimal

Conditionally returned
Minimum payment, expressed as a flat amount, due on the payment due day.

Allowable Values:

0.01 min
min_payment_calculation

object

Conditionally returned
Contains information used to calculate the minimum payment amount.

Allowable Values:

Existing min_payment_calculation object
min_payment_calculation.include_past_due_amount

boolean

Returned
Whether to include the past due amount when calculating the minimum payment.

Allowable Values:

true, false
min_payment_calculation.min_payment_percentage

object

Returned
Contains information used to calculate the minimum payment percentage.

Allowable Values:

Existing min_payment_percentage object
min_payment_calculation.min_payment_percentage.percentage_of_balance

decimal

Returned
Minimum payment, expressed as a percentage of the total statement balance, due on the payment due day.

Allowable Values:

0.0001–100
min_payment_calculation.min_payment_percentage.include_fees_charged

array of strings

Returned
One or more fee types to include when calculating the minimum payment.

Allowable Values:

LATE_PAYMENT_FEE, RETURNED_PAYMENT_FEE, FOREIGN_TRANSACTION_FEE
min_payment_calculation.min_payment_percentage.include_all_fees_charged

boolean

Conditionally returned
Whether to include all fees charged when calculating the minimum payments.

Allowable Values:

true, false
min_payment_calculation.min_payment_flat_amount

decimal

Returned
Minimum payment, expressed as a flat amount, due on the payment due day.

Allowable Values:

0.01 min
payment_allocation_order

array of strings

Conditionally returned
Ordered list of balance types to which payments are allocated, from first to last.

Allowable Values:

INTEREST, FEES, PRINCIPAL
interest_calculation

object

Conditionally returned
Contains the configurations for interest calculation.

Allowable Values:

Existing interest_calculation object
interest_calculation.method

string

Returned
Method of interest calculation.

Allowable Values:

AVG_DAILY_BALANCE_WITH_NEW_TRANSACTIONS
interest_calculation.day_count

string

Returned
Day-count convention.

Allowable Values:

ACTUAL
interest_calculation.interest_application

array of strings

Returned
One or more balance types on which interest is applied.

Allowable Values:

PRINCIPAL, FEES, INTEREST
interest_calculation.minimum_interest

decimal

Returned
When interest is applied, this value determines the minimum amount of interest that can be charged.

Allowable Values:

0–999999999999.99
interest_calculation.interest_on_grace_reactivation

string

Returned
Determines whether to charge or waive interest for the billing period when the balance is paid off.

Allowable Values:

ACCRUE_FULL_CYCLE, ACCRUE_PAYMENT_DATE, WAIVE
interest_calculation.grace_days_application

string

Returned
Determines the last day of grace period based on which interest charges are calculated.

Allowable Values:

NEXT_CYCLE_DATE
interest_calculation.exclude_tran_types

array of strings

Conditionally returned
One or more transactions that are excluded from current billing period’s interest charge, but included in next.

Allowable Values:

LATE_PAYMENT_FEE, ANNUAL_FEE, MONTHLY_FEE, CASH_BACK_STATEMENT_CREDIT, RETURNED_PAYMENT_FEE, FOREIGN_TRANSACTION_FEE
config

object

Conditionally returned
Contains information on configurations for billing cycle day, payment due day, and fees.

Allowable Values:

Existing config object
config.billing_cycle_day

integer

Returned
Day of the month when the billing cycle starts.

Allowable Values:

1–28
config.payment_due_day

integer

Conditionally returned
Day of month the payment for the previous billing cycle is due.

This field is deprecated. Use the product.payment_due_interval field instead. To retrieve payment_due_interval, see Retrieve credit product, config.payment_due_interval.

Allowable Values:

31
config.billing_cycle_frequency

string

Conditionally returned
Frequency at which the account is billed.

Allowable Values:

MONTHLY
config.payment_due_interval

integer

Conditionally returned
Specifies the payment due interval that is used to determine the payment due date for a billing cycle. A value of -1 indicates one day prior to the next billing cycle date.

For consumer programs, a minimum gap of 21 days is required between when a statement is delivered and the payment due date.

Allowable Values:

-1 min

Positive integers greater than 0; -1 is the default value
config.billing_cycle_day_strategy

string

Conditionally returned
Determines if the billing cycle day is manually set or determined dynamically during account creation based on cycling logic.

Allowable Values:

MANUAL
config.fees

array of strings

Conditionally returned
One or more fee types.

Allowable Values:

LATE_PAYMENT_FEE, RETURNED_PAYMENT_FEE, FOREIGN_TRANSACTION_FEE
config.periodic_fees

array of objects

Conditionally returned
Contains one or more periodic fees.

Allowable Values:

One or more periodic_fees objects
config.periodic_fees[].frequency

string

Returned
How frequently the fee is charged.

Allowable Values:

ANNUAL, MONTHLY
config.periodic_fees[].number_of_days_post_activation

integer

Returned
Number of days after an account is activated that the initial fee is charged. For example, if the value in this field is 30, then the initial fee is charged 30 days after an account is activated.

Allowable Values:

1–1000

Sample response body

JSON
{
  "token": "my_credit_product_token1234",
  "card_product_tokens": [
    "my_card_product1234"
  ],
  "name": "Gold Card",
  "description": "Description of credit product",
  "status": "ACTIVE",
  "created_time": "2021-09-03T19:03:21.035Z",
  "updated_time": "2021-09-03T19:03:21.035Z",
  "classification": "CONSUMER",
  "product_type": "REVOLVING",
  "product_sub_type": "CREDIT_CARD",
  "currency_code": "USD",
  "credit_line": {
    "min": 25,
    "max": 200000
  },
  "usage": [
    "PURCHASE"
  ],
  "min_payment_percentage": 1,
  "min_payment_flat_amount": 25,
  "min_payment_calculation": {
    "include_past_due_amount": false,
    "include_overlimit_amount": false,
    "min_payment_percentage": {
      "percentage_of_balance": 1,
      "include_interest_charged": false,
      "include_fees_charged": []
    },
    "min_payment_flat_amount": 25
  },
  "payment_allocation_order": [
    "INTEREST",
    "FEES",
    "PRINCIPAL"
  ],
  "interest_calculation": {
    "method": "AVG_DAILY_BALANCE_WITH_NEW_TRANSACTIONS",
    "day_count": "ACTUAL",
    "interest_application": [
      "PRINCIPAL",
      "FEES"
    ],
    "minimum_interest": 1,
    "interest_on_grace_reactivation": "ACCRUE_FULL_CYCLE",
    "grace_days_application": "NEXT_CYCLE_DATE",
    "exclude_tran_types": [
      "ANNUAL_FEE",
      "LATE_PAYMENT_FEE",
      "CASH_BACK_STATEMENT_CREDIT"
    ]
  },
  "config": {
    "billing_cycle_day": 1,
    "payment_due_day": 31,
    "fees": [
      "LATE_PAYMENT_FEE"
    ],
    "periodic_fees": [],
    "fees_config": [],
    "rewards_config": []
  }
}

List credit products

Action: GET
Endpoint: /credit/products
Retrieve an array of credit products. This endpoint supports sorting and pagination.

URL query parameters

FieldsDescription
status

array of strings

Optional
An array of statuses by which to filter credit products.

Allowable Values:

DRAFT, PENDING_APPROVAL, SENT_FOR_REVISION, ACTIVE, REJECTED, ARCHIVED
count

integer

Optional
Number of credit product resources to retrieve.

Allowable Values:

1–100
start_index

integer

Optional
Sort order index of the first resource in the returned array.

Allowable Values:

0 min
sort_by

string

Optional
Field on which to sort. Prefix the field name with a hyphen (-) to sort in descending order. Omit the hyphen to sort in ascending order.

NOTE: You must sort using system field names such as lastModifiedTime, and not by the field names appearing in response bodies such as last_modified_time.

Allowable Values:

lastModifiedTime, -lastModifiedTime

Response body

FieldsDescription
count

integer

Returned
Number of resources returned.

Allowable Values:

1-10
start_index

integer

Returned
Sort order index of the first resource in the returned array.

Allowable Values:

Any integer
end_index

integer

Returned
Sort order index of the last resource in the returned array.

Allowable Values:

Any integer
is_more

boolean

Returned
A value of true indicates that more unreturned resources exist.

Allowable Values:

true, false
data

array of objects

Returned
Contains one or more credit product objects.

Allowable Values:

One or more credit product objects
data[].token

string

Conditionally returned
Unique identifier of the credit product.

Allowable Values:

36 char max
data[].parent_product_token

string

Conditionally returned
Unique identifier of the parent credit product.

Allowable Values:

Existing credit product token
data[].card_product_tokens

array of strings

Conditionally returned
One or more associated card product tokens.

Allowable Values:

Existing card product tokens
data[].name

string

Conditionally returned
Name of the credit product.

Allowable Values:

255 char max
data[].description

string

Conditionally returned
Description of the credit product.

Allowable Values:

255 char max
data[].status

string

Conditionally returned
Status of the credit product.

- DRAFT - The credit product is in the process of being created.
- PENDING_APPROVAL - The credit product has been created and is awaiting approval.
- SENT_FOR_REVISION - The credit product has been returned for revision.
- ACTIVE - The credit product is active.
- REJECTED - The credit product has been rejected; this status cannot be changed.
- ARCHIVED - The previously active credit product has been archived.

Allowable Values:

DRAFT, PENDING_APPROVAL, SENT_FOR_REVISION, ACTIVE, REJECTED, ARCHIVED
data[].created_time

datetime

Conditionally returned
Date and time when the credit product was created on Marqeta’s credit platform, in UTC.

Allowable Values:

Format: yyyy-MM-ddThh:mm:ssZ
data[].updated_time

datetime

Conditionally returned
Date and time when the credit product was last updated on Marqeta’s credit platform, in UTC.

Allowable Values:

Format: yyyy-MM-ddThh:mm:ssZ
data[].classification

string

Conditionally returned
Specifies for whom the credit product is intended.

- CONSUMER - The credit product is intended for individual consumers.
- SMALL_AND_MEDIUM_BUSINESS - The credit product is intended for small and medium business.

Allowable Values:

CONSUMER, SMALL_AND_MEDIUM_BUSINESS
data[].product_type

string

Conditionally returned
Type of credit product.

REVOLVING - Allows users to continuously borrow and pay debts up to the credit limit.

Allowable Values:

REVOLVING
data[].product_sub_type

string

Conditionally returned
Subtype of the credit product type.

- CREDIT_CARD - Card that enables the cardholder to make purchases on credit.
- SECURED_CARD - Card backed by a user-funded deposit that enables the cardholder to make purchases on credit.

Allowable Values:

CREDIT_CARD, SECURED_CARD
data[].currency_code

string

Conditionally returned
Valid three-digit ISO 4217 currency code.

Allowable Values:

USD
data[].credit_line

object

Conditionally returned
Contains information on the credit line range.

Allowable Values:

Existing credit_line object
data[].credit_line.min

decimal

Returned
Minimum credit limit.

Allowable Values:

0–999999999999.99
data[].credit_line.max

decimal

Returned
Maximum credit limit.

Allowable Values:

0–999999999999.99
data[].usage

array of strings

Conditionally returned
One or more usage types for the credit product.

Allowable Values:

PURCHASE
data[].min_payment_percentage

decimal

Conditionally returned
Minimum payment, expressed as a percentage of the total statement balance, due on the payment due day.

Allowable Values:

0.0001–100
data[].min_payment_flat_amount

decimal

Conditionally returned
Minimum payment, expressed as a flat amount, due on the payment due day.

Allowable Values:

0.01 min
data[].min_payment_calculation

object

Conditionally returned
Contains information used to calculate the minimum payment amount.

Allowable Values:

Existing min_payment_calculation object
data[].min_payment_calculation.include_past_due_amount

boolean

Returned
Whether to include the past due amount when calculating the minimum payment.

Allowable Values:

true, false
data[].min_payment_calculation.min_payment_percentage

object

Returned
Contains information used to calculate the minimum payment percentage.

Allowable Values:

Existing min_payment_percentage object
data[].min_payment_calculation.min_payment_percentage.percentage_of_balance

decimal

Returned
Minimum payment, expressed as a percentage of the total statement balance, due on the payment due day.

Allowable Values:

0.0001–100
data[].min_payment_calculation.min_payment_percentage.include_fees_charged

array of strings

Returned
One or more fee types to include when calculating the minimum payment.

Allowable Values:

LATE_PAYMENT_FEE, RETURNED_PAYMENT_FEE, FOREIGN_TRANSACTION_FEE
data[].min_payment_calculation.min_payment_percentage.include_all_fees_charged

boolean

Conditionally returned
Whether to include all fees charged when calculating the minimum payments.

Allowable Values:

true, false
data[].min_payment_calculation.min_payment_flat_amount

decimal

Returned
Minimum payment, expressed as a flat amount, due on the payment due day.

Allowable Values:

0.01 min
data[].payment_allocation_order

array of strings

Conditionally returned
Ordered list of balance types to which payments are allocated, from first to last.

Allowable Values:

INTEREST, FEES, PRINCIPAL
data[].interest_calculation

object

Conditionally returned
Contains the configurations for interest calculation.

Allowable Values:

Existing interest_calculation object
data[].interest_calculation.method

string

Returned
Method of interest calculation.

Allowable Values:

AVG_DAILY_BALANCE_WITH_NEW_TRANSACTIONS
data[].interest_calculation.day_count

string

Returned
Day-count convention.

Allowable Values:

ACTUAL
data[].interest_calculation.interest_application

array of strings

Returned
One or more balance types on which interest is applied.

Allowable Values:

PRINCIPAL, FEES, INTEREST
data[].interest_calculation.minimum_interest

decimal

Returned
When interest is applied, this value determines the minimum amount of interest that can be charged.

Allowable Values:

0–999999999999.99
data[].interest_calculation.interest_on_grace_reactivation

string

Returned
Determines whether to charge or waive interest for the billing period when the balance is paid off.

Allowable Values:

ACCRUE_FULL_CYCLE, ACCRUE_PAYMENT_DATE, WAIVE
data[].interest_calculation.grace_days_application

string

Returned
Determines the last day of grace period based on which interest charges are calculated.

Allowable Values:

NEXT_CYCLE_DATE
data[].interest_calculation.exclude_tran_types

array of strings

Conditionally returned
One or more transactions that are excluded from current billing period’s interest charge, but included in next.

Allowable Values:

LATE_PAYMENT_FEE, ANNUAL_FEE, MONTHLY_FEE, CASH_BACK_STATEMENT_CREDIT, RETURNED_PAYMENT_FEE, FOREIGN_TRANSACTION_FEE
data[].config

object

Conditionally returned
Contains information on configurations for billing cycle day, payment due day, and fees.

Allowable Values:

Existing config object
data[].config.billing_cycle_day

integer

Returned
Day of the month when the billing cycle starts.

Allowable Values:

1–28
data[].config.payment_due_day

integer

Conditionally returned
Day of month the payment for the previous billing cycle is due.

This field is deprecated. Use the product.payment_due_interval field instead. To retrieve payment_due_interval, see Retrieve credit product, config.payment_due_interval.

Allowable Values:

31
data[].config.billing_cycle_frequency

string

Conditionally returned
Frequency at which the account is billed.

Allowable Values:

MONTHLY
data[].config.payment_due_interval

integer

Conditionally returned
Specifies the payment due interval that is used to determine the payment due date for a billing cycle. A value of -1 indicates one day prior to the next billing cycle date.

For consumer programs, a minimum gap of 21 days is required between when a statement is delivered and the payment due date.

Allowable Values:

-1 min

Positive integers greater than 0; -1 is the default value
data[].config.billing_cycle_day_strategy

string

Conditionally returned
Determines if the billing cycle day is manually set or determined dynamically during account creation based on cycling logic.

Allowable Values:

MANUAL
data[].config.fees

array of strings

Conditionally returned
One or more fee types.

Allowable Values:

LATE_PAYMENT_FEE, RETURNED_PAYMENT_FEE, FOREIGN_TRANSACTION_FEE
data[].config.periodic_fees

array of objects

Conditionally returned
Contains one or more periodic fees.

Allowable Values:

One or more periodic_fees objects
data[].config.periodic_fees[].frequency

string

Returned
How frequently the fee is charged.

Allowable Values:

ANNUAL, MONTHLY
data[].config.periodic_fees[].number_of_days_post_activation

integer

Returned
Number of days after an account is activated that the initial fee is charged. For example, if the value in this field is 30, then the initial fee is charged 30 days after an account is activated.

Allowable Values:

1–1000

Sample response body

JSON
{
  "count": 2,
  "start_index": 0,
  "end_index": 0,
  "is_more": true,
  "data": [
    {
      "token": "my_credit_product_token1234",
      "card_product_tokens": [
        "my_card_product1234"
      ],
      "name": "Gold Card",
      "description": "Description of credit product",
      "status": "ACTIVE",
      "created_time": "2023-09-03T19:03:21.035Z",
      "updated_time": "2023-09-03T19:03:21.035Z",
      "classification": "CONSUMER",
      "product_type": "REVOLVING",
      "product_sub_type": "CREDIT_CARD",
      "currency_code": "USD",
      "credit_line": {
        "min": 25,
        "max": 200000
      },
      "usage": [
        "PURCHASE"
      ],
      "min_payment_percentage": 1,
      "min_payment_flat_amount": 25,
      "min_payment_calculation": {
        "include_past_due_amount": false,
        "include_overlimit_amount": false,
        "min_payment_percentage": {
          "percentage_of_balance": 1,
          "include_interest_charged": false,
          "include_fees_charged": []
        },
        "min_payment_flat_amount": 25
      },
      "payment_allocation_order": [
        "INTEREST",
        "FEES",
        "PRINCIPAL"
      ],
      "interest_calculation": {
        "method": "AVG_DAILY_BALANCE_WITH_NEW_TRANSACTIONS",
        "day_count": "ACTUAL",
        "interest_application": [
          "PRINCIPAL",
          "FEES"
        ],
        "minimum_interest": 1,
        "interest_on_grace_reactivation": "ACCRUE_FULL_CYCLE",
        "grace_days_application": "NEXT_CYCLE_DATE",
        "exclude_tran_types": [
          "ANNUAL_FEE",
          "LATE_PAYMENT_FEE",
          "CASH_BACK_STATEMENT_CREDIT"
        ]
      },
      "config": {
        "billing_cycle_day": 1,
        "payment_due_day": 31,
        "fees": [
          "LATE_PAYMENT_FEE"
        ],
        "periodic_fees": [
          {
            "frequency": "ANNUAL",
            "number_of_days_post_activation": 5
          },
          {
            "frequency": "MONTHLY",
            "number_of_days_post_activation": 28
          }
        ],
        "fees_config": [],
        "rewards_config": []
      }
    },
    {
      "token": "credit-product-token-9163",
      "card_product_tokens": [
        "card-product-token-d308",
        "card-product-token-cc10"
      ],
      "name": "My Platinum Credit Product",
      "description": "Platinum consumer product",
      "status": "ACTIVE",
      "created_time": "2023-10-26T14:46:26.678Z",
      "updated_time": "2023-10-26T16:45:19.908Z",
      "classification": "CONSUMER",
      "product_type": "REVOLVING",
      "product_sub_type": "CREDIT_CARD",
      "currency_code": "USD",
      "credit_line": {
        "min": 200,
        "max": 20000
      },
      "usage": [
        "PURCHASE"
      ],
      "min_payment_percentage": 2,
      "min_payment_flat_amount": 22,
      "payment_allocation_order": [
        "INTEREST",
        "FEES",
        "PRINCIPAL"
      ],
      "interest_calculation": {
        "method": "AVG_DAILY_BALANCE_WITH_NEW_TRANSACTIONS",
        "day_count": "ACTUAL",
        "interest_application": [
          "PRINCIPAL",
          "FEES"
        ],
        "minimum_interest": 1,
        "interest_on_grace_reactivation": "ACCRUE_FULL_CYCLE",
        "grace_days_application": "NEXT_CYCLE_DATE",
        "exclude_tran_types": [
          "LATE_PAYMENT_FEE",
          "ANNUAL_FEE",
          "CASH_BACK_STATEMENT_CREDIT"
        ]
      },
      "config": {
        "billing_cycle_day": 1,
        "payment_due_day": 31,
        "fees": [
          "LATE_PAYMENT_FEE"
        ],
        "periodic_fees": [
          {
            "frequency": "ANNUAL",
            "number_of_days_post_activation": 5
          },
          {
            "frequency": "MONTHLY",
            "number_of_days_post_activation": 28
          }
        ],
        "fees_config": [],
        "rewards_config": []
      }
    }
  ]
}

Retrieve credit product

Action: GET
Endpoint: /credit/products/{token}
Retrieve a credit product.

URL path parameters

FieldsDescription
token

string

Required
Unique identifier of the credit product to retrieve.

Send a GET request to /credit/products to retrieve existing credit product tokens.

Allowable Values:

Existing credit product token

Response body

FieldsDescription
token

string

Conditionally returned
Unique identifier of the credit product.

Allowable Values:

36 char max
parent_product_token

string

Conditionally returned
Unique identifier of the parent credit product.

Allowable Values:

Existing credit product token
card_product_tokens

array of strings

Conditionally returned
One or more associated card product tokens.

Allowable Values:

Existing card product tokens
name

string

Conditionally returned
Name of the credit product.

Allowable Values:

255 char max
description

string

Conditionally returned
Description of the credit product.

Allowable Values:

255 char max
status

string

Conditionally returned
Status of the credit product.

- DRAFT - The credit product is in the process of being created.
- PENDING_APPROVAL - The credit product has been created and is awaiting approval.
- SENT_FOR_REVISION - The credit product has been returned for revision.
- ACTIVE - The credit product is active.
- REJECTED - The credit product has been rejected; this status cannot be changed.
- ARCHIVED - The previously active credit product has been archived.

Allowable Values:

DRAFT, PENDING_APPROVAL, SENT_FOR_REVISION, ACTIVE, REJECTED, ARCHIVED
created_time

datetime

Conditionally returned
Date and time when the credit product was created on Marqeta’s credit platform, in UTC.

Allowable Values:

Format: yyyy-MM-ddThh:mm:ssZ
updated_time

datetime

Conditionally returned
Date and time when the credit product was last updated on Marqeta’s credit platform, in UTC.

Allowable Values:

Format: yyyy-MM-ddThh:mm:ssZ
classification

string

Conditionally returned
Specifies for whom the credit product is intended.

- CONSUMER - The credit product is intended for individual consumers.
- SMALL_AND_MEDIUM_BUSINESS - The credit product is intended for small and medium business.

Allowable Values:

CONSUMER, SMALL_AND_MEDIUM_BUSINESS
product_type

string

Conditionally returned
Type of credit product.

REVOLVING - Allows users to continuously borrow and pay debts up to the credit limit.

Allowable Values:

REVOLVING
product_sub_type

string

Conditionally returned
Subtype of the credit product type.

- CREDIT_CARD - Card that enables the cardholder to make purchases on credit.
- SECURED_CARD - Card backed by a user-funded deposit that enables the cardholder to make purchases on credit.

Allowable Values:

CREDIT_CARD, SECURED_CARD
currency_code

string

Conditionally returned
Valid three-digit ISO 4217 currency code.

Allowable Values:

USD
credit_line

object

Conditionally returned
Contains information on the credit line range.

Allowable Values:

Existing credit_line object
credit_line.min

decimal

Returned
Minimum credit limit.

Allowable Values:

0–999999999999.99
credit_line.max

decimal

Returned
Maximum credit limit.

Allowable Values:

0–999999999999.99
usage

array of strings

Conditionally returned
One or more usage types for the credit product.

Allowable Values:

PURCHASE
min_payment_percentage

decimal

Conditionally returned
Minimum payment, expressed as a percentage of the total statement balance, due on the payment due day.

Allowable Values:

0.0001–100
min_payment_flat_amount

decimal

Conditionally returned
Minimum payment, expressed as a flat amount, due on the payment due day.

Allowable Values:

0.01 min
min_payment_calculation

object

Conditionally returned
Contains information used to calculate the minimum payment amount.

Allowable Values:

Existing min_payment_calculation object
min_payment_calculation.include_past_due_amount

boolean

Returned
Whether to include the past due amount when calculating the minimum payment.

Allowable Values:

true, false
min_payment_calculation.min_payment_percentage

object

Returned
Contains information used to calculate the minimum payment percentage.

Allowable Values:

Existing min_payment_percentage object
min_payment_calculation.min_payment_percentage.percentage_of_balance

decimal

Returned
Minimum payment, expressed as a percentage of the total statement balance, due on the payment due day.

Allowable Values:

0.0001–100
min_payment_calculation.min_payment_percentage.include_fees_charged

array of strings

Returned
One or more fee types to include when calculating the minimum payment.

Allowable Values:

LATE_PAYMENT_FEE, RETURNED_PAYMENT_FEE, FOREIGN_TRANSACTION_FEE
min_payment_calculation.min_payment_percentage.include_all_fees_charged

boolean

Conditionally returned
Whether to include all fees charged when calculating the minimum payments.

Allowable Values:

true, false
min_payment_calculation.min_payment_flat_amount

decimal

Returned
Minimum payment, expressed as a flat amount, due on the payment due day.

Allowable Values:

0.01 min
payment_allocation_order

array of strings

Conditionally returned
Ordered list of balance types to which payments are allocated, from first to last.

Allowable Values:

INTEREST, FEES, PRINCIPAL
interest_calculation

object

Conditionally returned
Contains the configurations for interest calculation.

Allowable Values:

Existing interest_calculation object
interest_calculation.method

string

Returned
Method of interest calculation.

Allowable Values:

AVG_DAILY_BALANCE_WITH_NEW_TRANSACTIONS
interest_calculation.day_count

string

Returned
Day-count convention.

Allowable Values:

ACTUAL
interest_calculation.interest_application

array of strings

Returned
One or more balance types on which interest is applied.

Allowable Values:

PRINCIPAL, FEES, INTEREST
interest_calculation.minimum_interest

decimal

Returned
When interest is applied, this value determines the minimum amount of interest that can be charged.

Allowable Values:

0–999999999999.99
interest_calculation.interest_on_grace_reactivation

string

Returned
Determines whether to charge or waive interest for the billing period when the balance is paid off.

Allowable Values:

ACCRUE_FULL_CYCLE, ACCRUE_PAYMENT_DATE, WAIVE
interest_calculation.grace_days_application

string

Returned
Determines the last day of grace period based on which interest charges are calculated.

Allowable Values:

NEXT_CYCLE_DATE
interest_calculation.exclude_tran_types

array of strings

Conditionally returned
One or more transactions that are excluded from current billing period’s interest charge, but included in next.

Allowable Values:

LATE_PAYMENT_FEE, ANNUAL_FEE, MONTHLY_FEE, CASH_BACK_STATEMENT_CREDIT, RETURNED_PAYMENT_FEE, FOREIGN_TRANSACTION_FEE
config

object

Conditionally returned
Contains information on configurations for billing cycle day, payment due day, and fees.

Allowable Values:

Existing config object
config.billing_cycle_day

integer

Returned
Day of the month when the billing cycle starts.

Allowable Values:

1–28
config.payment_due_day

integer

Conditionally returned
Day of month the payment for the previous billing cycle is due.

This field is deprecated. Use the product.payment_due_interval field instead. To retrieve payment_due_interval, see Retrieve credit product, config.payment_due_interval.

Allowable Values:

31
config.billing_cycle_frequency

string

Conditionally returned
Frequency at which the account is billed.

Allowable Values:

MONTHLY
config.payment_due_interval

integer

Conditionally returned
Specifies the payment due interval that is used to determine the payment due date for a billing cycle. A value of -1 indicates one day prior to the next billing cycle date.

For consumer programs, a minimum gap of 21 days is required between when a statement is delivered and the payment due date.

Allowable Values:

-1 min

Positive integers greater than 0; -1 is the default value
config.billing_cycle_day_strategy

string

Conditionally returned
Determines if the billing cycle day is manually set or determined dynamically during account creation based on cycling logic.

Allowable Values:

MANUAL
config.fees

array of strings

Conditionally returned
One or more fee types.

Allowable Values:

LATE_PAYMENT_FEE, RETURNED_PAYMENT_FEE, FOREIGN_TRANSACTION_FEE
config.periodic_fees

array of objects

Conditionally returned
Contains one or more periodic fees.

Allowable Values:

One or more periodic_fees objects
config.periodic_fees[].frequency

string

Returned
How frequently the fee is charged.

Allowable Values:

ANNUAL, MONTHLY
config.periodic_fees[].number_of_days_post_activation

integer

Returned
Number of days after an account is activated that the initial fee is charged. For example, if the value in this field is 30, then the initial fee is charged 30 days after an account is activated.

Allowable Values:

1–1000

Sample response body

JSON
{
  "token": "credit-product-token1111",
  "card_product_tokens": [
    "card-product-token-2222"
  ],
  "name": "Gold Product",
  "description": "Description of Gold Product",
  "status": "DRAFT",
  "created_time": "2020-12-17T00:11:46Z",
  "updated_time": "2020-12-17T00:11:46Z",
  "classification": "CONSUMER",
  "product_type": "REVOLVING",
  "product_sub_type": "CREDIT_CARD",
  "currency_code": "USD",
  "credit_line": {
    "min": 1500,
    "max": 3500
  },
  "usage": [
    "PURCHASE"
  ],
  "min_payment_percentage": 0.0001,
  "min_payment_flat_amount": 0.01,
  "payment_allocation_order": [
    "INTEREST",
    "FEES",
    "PRINCIPAL"
  ],
  "interest_calculation": {
    "method": "AVG_DAILY_BALANCE_WITH_NEW_TRANSACTIONS",
    "day_count": "ACTUAL",
    "interest_application": [
      "PRINCIPAL",
      "FEES"
    ],
    "minimum_interest": 1,
    "interest_on_grace_reactivation": "ACCRUE_FULL_CYCLE",
    "grace_days_application": "NEXT_CYCLE_DATE",
    "exclude_tran_types": [
      "ANNUAL_FEE",
      "LATE_PAYMENT_FEE",
      "CASH_BACK_STATEMENT_CREDIT"
    ]
  },
  "config": {
    "billing_cycle_day": 1,
    "payment_due_day": 31,
    "fees": [
      "LATE_PAYMENT_FEE"
    ],
    "periodic_fees": [
      {
        "frequency": "ANNUAL",
        "number_of_days_post_activation": 5
      },
      {
        "frequency": "MONTHLY",
        "number_of_days_post_activation": 28
      }
    ]
  }
}

Retrieve credit product lineage

Action: GET
Endpoint: /credit/products/{token}/lineage
Retrieve the lineage of a credit product, which is an array of related credit products whose lineage can be traced back to the same original credit product. This endpoint supports sorting and pagination.

URL path parameters

FieldsDescription
token

string

Required
Unique identifier of the credit product whose lineage you want to retrieve.

Send a GET request to /credit/products to retrieve existing credit product tokens.

Allowable Values:

Existing credit product token

URL query parameters

FieldsDescription
status

array of strings

Optional
An array of statuses by which to filter credit products.

Allowable Values:

DRAFT, PENDING_APPROVAL, SENT_FOR_REVISION, ACTIVE, REJECTED, ARCHIVED
count

integer

Optional
Number of credit product resources to retrieve.

Allowable Values:

1–100
start_index

integer

Optional
Sort order index of the first resource in the returned array.

Allowable Values:

0 min
sort_by

string

Optional
Field on which to sort. Prefix the field name with a hyphen (-) to sort in descending order. Omit the hyphen to sort in ascending order.

NOTE: You must sort using system field names such as lastModifiedTime, and not by the field names appearing in response bodies such as last_modified_time.

Allowable Values:

lastModifiedTime, -lastModifiedTime

Response body

FieldsDescription
count

integer

Returned
Number of resources returned.

Allowable Values:

1-10
start_index

integer

Returned
Sort order index of the first resource in the returned array.

Allowable Values:

Any integer
end_index

integer

Returned
Sort order index of the last resource in the returned array.

Allowable Values:

Any integer
is_more

boolean

Returned
A value of true indicates that more unreturned resources exist.

Allowable Values:

true, false
data

array of objects

Returned
Contains one or more credit product objects.

Allowable Values:

One or more credit product objects
data[].token

string

Conditionally returned
Unique identifier of the credit product.

Allowable Values:

36 char max
data[].parent_product_token

string

Conditionally returned
Unique identifier of the parent credit product.

Allowable Values:

Existing credit product token
data[].card_product_tokens

array of strings

Conditionally returned
One or more associated card product tokens.

Allowable Values:

Existing card product tokens
data[].name

string

Conditionally returned
Name of the credit product.

Allowable Values:

255 char max
data[].description

string

Conditionally returned
Description of the credit product.

Allowable Values:

255 char max
data[].status

string

Conditionally returned
Status of the credit product.

- DRAFT - The credit product is in the process of being created.
- PENDING_APPROVAL - The credit product has been created and is awaiting approval.
- SENT_FOR_REVISION - The credit product has been returned for revision.
- ACTIVE - The credit product is active.
- REJECTED - The credit product has been rejected; this status cannot be changed.
- ARCHIVED - The previously active credit product has been archived.

Allowable Values:

DRAFT, PENDING_APPROVAL, SENT_FOR_REVISION, ACTIVE, REJECTED, ARCHIVED
data[].created_time

datetime

Conditionally returned
Date and time when the credit product was created on Marqeta’s credit platform, in UTC.

Allowable Values:

Format: yyyy-MM-ddThh:mm:ssZ
data[].updated_time

datetime

Conditionally returned
Date and time when the credit product was last updated on Marqeta’s credit platform, in UTC.

Allowable Values:

Format: yyyy-MM-ddThh:mm:ssZ
data[].classification

string

Conditionally returned
Specifies for whom the credit product is intended.

- CONSUMER - The credit product is intended for individual consumers.
- SMALL_AND_MEDIUM_BUSINESS - The credit product is intended for small and medium business.

Allowable Values:

CONSUMER, SMALL_AND_MEDIUM_BUSINESS
data[].product_type

string

Conditionally returned
Type of credit product.

REVOLVING - Allows users to continuously borrow and pay debts up to the credit limit.

Allowable Values:

REVOLVING
data[].product_sub_type

string

Conditionally returned
Subtype of the credit product type.

- CREDIT_CARD - Card that enables the cardholder to make purchases on credit.
- SECURED_CARD - Card backed by a user-funded deposit that enables the cardholder to make purchases on credit.

Allowable Values:

CREDIT_CARD, SECURED_CARD
data[].currency_code

string

Conditionally returned
Valid three-digit ISO 4217 currency code.

Allowable Values:

USD
data[].credit_line

object

Conditionally returned
Contains information on the credit line range.

Allowable Values:

Existing credit_line object
data[].credit_line.min

decimal

Returned
Minimum credit limit.

Allowable Values:

0–999999999999.99
data[].credit_line.max

decimal

Returned
Maximum credit limit.

Allowable Values:

0–999999999999.99
data[].usage

array of strings

Conditionally returned
One or more usage types for the credit product.

Allowable Values:

PURCHASE
data[].min_payment_percentage

decimal

Conditionally returned
Minimum payment, expressed as a percentage of the total statement balance, due on the payment due day.

Allowable Values:

0.0001–100
data[].min_payment_flat_amount

decimal

Conditionally returned
Minimum payment, expressed as a flat amount, due on the payment due day.

Allowable Values:

0.01 min
data[].min_payment_calculation

object

Conditionally returned
Contains information used to calculate the minimum payment amount.

Allowable Values:

Existing min_payment_calculation object
data[].min_payment_calculation.include_past_due_amount

boolean

Returned
Whether to include the past due amount when calculating the minimum payment.

Allowable Values:

true, false
data[].min_payment_calculation.min_payment_percentage

object

Returned
Contains information used to calculate the minimum payment percentage.

Allowable Values:

Existing min_payment_percentage object
data[].min_payment_calculation.min_payment_percentage.percentage_of_balance

decimal

Returned
Minimum payment, expressed as a percentage of the total statement balance, due on the payment due day.

Allowable Values:

0.0001–100
data[].min_payment_calculation.min_payment_percentage.include_fees_charged

array of strings

Returned
One or more fee types to include when calculating the minimum payment.

Allowable Values:

LATE_PAYMENT_FEE, RETURNED_PAYMENT_FEE, FOREIGN_TRANSACTION_FEE
data[].min_payment_calculation.min_payment_percentage.include_all_fees_charged

boolean

Conditionally returned
Whether to include all fees charged when calculating the minimum payments.

Allowable Values:

true, false
data[].min_payment_calculation.min_payment_flat_amount

decimal

Returned
Minimum payment, expressed as a flat amount, due on the payment due day.

Allowable Values:

0.01 min
data[].payment_allocation_order

array of strings

Conditionally returned
Ordered list of balance types to which payments are allocated, from first to last.

Allowable Values:

INTEREST, FEES, PRINCIPAL
data[].interest_calculation

object

Conditionally returned
Contains the configurations for interest calculation.

Allowable Values:

Existing interest_calculation object
data[].interest_calculation.method

string

Returned
Method of interest calculation.

Allowable Values:

AVG_DAILY_BALANCE_WITH_NEW_TRANSACTIONS
data[].interest_calculation.day_count

string

Returned
Day-count convention.

Allowable Values:

ACTUAL
data[].interest_calculation.interest_application

array of strings

Returned
One or more balance types on which interest is applied.

Allowable Values:

PRINCIPAL, FEES, INTEREST
data[].interest_calculation.minimum_interest

decimal

Returned
When interest is applied, this value determines the minimum amount of interest that can be charged.

Allowable Values:

0–999999999999.99
data[].interest_calculation.interest_on_grace_reactivation

string

Returned
Determines whether to charge or waive interest for the billing period when the balance is paid off.

Allowable Values:

ACCRUE_FULL_CYCLE, ACCRUE_PAYMENT_DATE, WAIVE
data[].interest_calculation.grace_days_application

string

Returned
Determines the last day of grace period based on which interest charges are calculated.

Allowable Values:

NEXT_CYCLE_DATE
data[].interest_calculation.exclude_tran_types

array of strings

Conditionally returned
One or more transactions that are excluded from current billing period’s interest charge, but included in next.

Allowable Values:

LATE_PAYMENT_FEE, ANNUAL_FEE, MONTHLY_FEE, CASH_BACK_STATEMENT_CREDIT, RETURNED_PAYMENT_FEE, FOREIGN_TRANSACTION_FEE
data[].config

object

Conditionally returned
Contains information on configurations for billing cycle day, payment due day, and fees.

Allowable Values:

Existing config object
data[].config.billing_cycle_day

integer

Returned
Day of the month when the billing cycle starts.

Allowable Values:

1–28
data[].config.payment_due_day

integer

Conditionally returned
Day of month the payment for the previous billing cycle is due.

This field is deprecated. Use the product.payment_due_interval field instead. To retrieve payment_due_interval, see Retrieve credit product, config.payment_due_interval.

Allowable Values:

31
data[].config.billing_cycle_frequency

string

Conditionally returned
Frequency at which the account is billed.

Allowable Values:

MONTHLY
data[].config.payment_due_interval

integer

Conditionally returned
Specifies the payment due interval that is used to determine the payment due date for a billing cycle. A value of -1 indicates one day prior to the next billing cycle date.

For consumer programs, a minimum gap of 21 days is required between when a statement is delivered and the payment due date.

Allowable Values:

-1 min

Positive integers greater than 0; -1 is the default value
data[].config.billing_cycle_day_strategy

string

Conditionally returned
Determines if the billing cycle day is manually set or determined dynamically during account creation based on cycling logic.

Allowable Values:

MANUAL
data[].config.fees

array of strings

Conditionally returned
One or more fee types.

Allowable Values:

LATE_PAYMENT_FEE, RETURNED_PAYMENT_FEE, FOREIGN_TRANSACTION_FEE
data[].config.periodic_fees

array of objects

Conditionally returned
Contains one or more periodic fees.

Allowable Values:

One or more periodic_fees objects
data[].config.periodic_fees[].frequency

string

Returned
How frequently the fee is charged.

Allowable Values:

ANNUAL, MONTHLY
data[].config.periodic_fees[].number_of_days_post_activation

integer

Returned
Number of days after an account is activated that the initial fee is charged. For example, if the value in this field is 30, then the initial fee is charged 30 days after an account is activated.

Allowable Values:

1–1000

Sample response body

JSON
{
  "count": 3,
  "start_index": 0,
  "end_index": 2,
  "is_more": false,
  "data": [
    {
      "token": "credit-product-token-9163",
      "parent_product_token": "credit-product-token-366b",
      "card_product_tokens": [
        "card-product-token-d308",
        "card-product-token-cc10"
      ],
      "name": "My Platinum Credit Product",
      "description": "Platinum consumer product",
      "status": "ACTIVE",
      "created_time": "2023-10-26T14:46:26.678Z",
      "updated_time": "2023-10-26T16:45:19.908Z",
      "classification": "CONSUMER",
      "product_type": "REVOLVING",
      "product_sub_type": "CREDIT_CARD",
      "currency_code": "USD",
      "credit_line": {
        "min": 200,
        "max": 20000
      },
      "usage": [
        "PURCHASE"
      ],
      "min_payment_percentage": 2,
      "min_payment_flat_amount": 22,
      "min_payment_calculation": {
        "include_past_due_amount": true,
        "include_overlimit_amount": false,
        "min_payment_percentage": {
          "percentage_of_balance": 2,
          "include_interest_charged": false,
          "include_fees_charged": []
        },
        "min_payment_flat_amount": 22
      },
      "payment_allocation_order": [
        "INTEREST",
        "FEES",
        "PRINCIPAL"
      ],
      "interest_calculation": {
        "method": "AVG_DAILY_BALANCE_WITH_NEW_TRANSACTIONS",
        "day_count": "ACTUAL",
        "interest_application": [
          "PRINCIPAL",
          "FEES"
        ],
        "minimum_interest": 1,
        "interest_on_grace_reactivation": "ACCRUE_FULL_CYCLE",
        "grace_days_application": "NEXT_CYCLE_DATE",
        "exclude_tran_types": [
          "LATE_PAYMENT_FEE",
          "ANNUAL_FEE",
          "CASH_BACK_STATEMENT_CREDIT"
        ]
      },
      "config": {
        "billing_cycle_day": 1,
        "payment_due_day": 31
      }
    },
    {
      "token": "credit-product-token-366b",
      "card_product_tokens": [
        "card-product-token-d308"
      ],
      "name": "My Platinum Credit Product",
      "description": "Platinum consumer product",
      "status": "ARCHIVED",
      "created_time": "2023-10-26T14:43:11.187Z",
      "updated_time": "2023-10-26T16:45:19.907Z",
      "classification": "CONSUMER",
      "product_type": "REVOLVING",
      "product_sub_type": "CREDIT_CARD",
      "currency_code": "USD",
      "credit_line": {
        "min": 200,
        "max": 20000
      },
      "usage": [
        "PURCHASE"
      ],
      "min_payment_percentage": 2,
      "min_payment_flat_amount": 22,
      "min_payment_calculation": {
        "include_past_due_amount": false,
        "include_overlimit_amount": false,
        "min_payment_percentage": {
          "percentage_of_balance": 2,
          "include_interest_charged": false,
          "include_fees_charged": []
        },
        "min_payment_flat_amount": 22
      },
      "payment_allocation_order": [
        "INTEREST",
        "FEES",
        "PRINCIPAL"
      ],
      "interest_calculation": {
        "method": "AVG_DAILY_BALANCE_WITH_NEW_TRANSACTIONS",
        "day_count": "ACTUAL",
        "interest_application": [
          "PRINCIPAL",
          "FEES"
        ],
        "minimum_interest": 1,
        "interest_on_grace_reactivation": "ACCRUE_FULL_CYCLE",
        "grace_days_application": "NEXT_CYCLE_DATE",
        "exclude_tran_types": [
          "LATE_PAYMENT_FEE",
          "ANNUAL_FEE",
          "CASH_BACK_STATEMENT_CREDIT"
        ]
      },
      "config": {
        "billing_cycle_day": 1,
        "payment_due_day": 31
      }
    },
    {
      "token": "credit-product-token-4373",
      "parent_product_token": "credit-product-token-366b",
      "card_product_tokens": [
        "card-product-token-d308",
        "card-product-token-cc10"
      ],
      "name": "My Platinum Credit Product",
      "description": "Platinum consumer product",
      "status": "REJECTED",
      "created_time": "2023-10-26T14:44:54.770Z",
      "updated_time": "2023-10-26T14:45:26.015Z",
      "classification": "CONSUMER",
      "product_type": "REVOLVING",
      "product_sub_type": "CREDIT_CARD",
      "currency_code": "USD",
      "credit_line": {
        "min": 200,
        "max": 20000
      },
      "usage": [
        "PURCHASE"
      ],
      "min_payment_percentage": 2,
      "min_payment_flat_amount": 22,
      "min_payment_calculation": {
        "include_past_due_amount": false,
        "include_overlimit_amount": false,
        "min_payment_percentage": {
          "percentage_of_balance": 2,
          "include_interest_charged": false,
          "include_fees_charged": []
        },
        "min_payment_flat_amount": 22
      },
      "payment_allocation_order": [
        "INTEREST",
        "FEES",
        "PRINCIPAL"
      ],
      "interest_calculation": {
        "method": "AVG_DAILY_BALANCE_WITH_NEW_TRANSACTIONS",
        "day_count": "ACTUAL",
        "interest_application": [
          "PRINCIPAL",
          "FEES"
        ],
        "minimum_interest": 1,
        "interest_on_grace_reactivation": "ACCRUE_FULL_CYCLE",
        "grace_days_application": "NEXT_CYCLE_DATE",
        "exclude_tran_types": [
          "LATE_PAYMENT_FEE",
          "ANNUAL_FEE",
          "CASH_BACK_STATEMENT_CREDIT"
        ]
      },
      "config": {
        "billing_cycle_day": 1,
        "payment_due_day": 31
      }
    }
  ]
}