GET///
Retrieve a credit product.
URL path parameters
| Fields | Description |
|---|---|
| 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
| Fields | Description |
|---|---|
| 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
}
]
}
}