/
35 minute read
August 10, 2022

Credit Products

Hidden
Important
The credit products feature is about to be 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 (Beta).

The Marqeta platform’s credit products feature 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.

This page includes reference documentation on the credit product transition events sent to your webhook endpoint, and the credit product endpoints for creating and retrieving a credit products and its lineage.

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
Fields Description

token

string
Optional

Unique identifier of the credit product.

Allowable Values:

36 char max

card_product_tokens

array of strings
Required

List of associated card product tokens.

Allowable Values:

name

string
Required

Name of the credit product.

Allowable Values:

description

string
Optional

Description of the credit product.

Allowable Values:

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

Class to which the credit product belongs.

CONSUMER - The credit product is intended for individual consumers.

Allowable Values:

CONSUMER

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.

Allowable Values:

CREDIT_CARD

currency_code

string
Required

A valid three-digit ISO 4217 currency code

Allowable Values:

USD

credit_line

object
Required

Information about the credit line range.

Allowable Values:

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

List of 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

Information used to calculate the minimum payment amount.

Allowable Values:

min_payment_calculation.include_past_due_amount

boolean
Required

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

Allowable Values:

min_payment_calculation.min_payment_percentage

object
Required

Information used to calculate the minimum payment percentage.

Allowable Values:

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

List of fee types to include when calculating the minimum payment.

Allowable Values:

LATE_PAYMENT_FEE, RETURNED_PAYMENT_FEE

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

Definitions for interest calculation characteristics.

Allowable Values:

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

Balance type 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.application_of_credits

object
Required

Cycle type and day that credits are applied in the daily balance calculation.

Allowable Values:

interest_calculation.application_of_credits.cycle_type

string
Required

Type of cycle.

  • BEGINNING_REVOLVING - Account is beginning to revolve and just started carrying a balance from the previous month.

  • REVOLVING - Account is revolving and has been carrying a balance from month to month for more than one month.

  • END_REVOLVING - Account is no longer revolving and the previous month’s balance is paid off.

  • TRANSACTING - Account is not revolving and being paid off each month.

Allowable Values:

BEGINNING_REVOLVING, REVOLVING, END_REVOLVING, TRANSACTING

interest_calculation.application_of_credits.day

integer
Required

Day of the billing cycle when credits are applied.

Allowable Values:

1–31

interest_calculation.exclude_tran_types

array of strings
Optional

List of transactions that are excluded from current billing period’s interest charge, but included in next.

Allowable Values:

LATE_PAYMENT_FEE, ANNUAL_FEE, CASH_BACK_STATEMENT_CREDIT, RETURNED_PAYMENT_FEE

config

object
Required

Information on configurations for billing cycle day, payment due day, and fees.

Allowable Values:

config.billing_cycle_day

integer
Required

Day of month the billing cycle starts.

Allowable Values:

1

config.payment_due_day

integer
Required

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

Allowable Values:

31

config.fees

array of strings
Optional

List of fee types associated with the product.

Allowable Values:

LATE_PAYMENT_FEE, RETURNED_PAYMENT_FEE

Sample request body
JSON
Copied

Is this helpful?

Yes
No
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

List of associated card product tokens.

Allowable Values:

name

string
Conditionally returned

Name of the credit product.

Allowable Values:

description

string
Conditionally returned

Description of the credit product.

Allowable Values:

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 the Marqeta platform.

Allowable Values:

updated_time

datetime
Conditionally returned

Date and time when the credit product was last updated on the Marqeta platform.

Allowable Values:

classification

string
Conditionally returned

Class to which the credit product belongs.

CONSUMER - The credit product is intended for individual consumers.

Allowable Values:

CONSUMER

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.

Allowable Values:

CREDIT_CARD

currency_code

string
Conditionally returned

A valid three-digit ISO 4217 currency code

Allowable Values:

USD

credit_line

object
Conditionally returned

Information about the credit line range.

Allowable Values:

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

List of 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

Information used to calculate the minimum payment amount.

Allowable Values:

min_payment_calculation.include_past_due_amount

boolean
Returned

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

Allowable Values:

min_payment_calculation.min_payment_percentage

object
Returned

Information used to calculate the minimum payment percentage.

Allowable Values:

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

List of fee types to include when calculating the minimum payment.

Allowable Values:

LATE_PAYMENT_FEE, RETURNED_PAYMENT_FEE

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

Definitions for interest calculation characteristics.

Allowable Values:

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

Balance type 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.application_of_credits

object
Returned

Cycle type and day that credits are applied in the daily balance calculation.

Allowable Values:

interest_calculation.application_of_credits.cycle_type

string
Returned

Type of cycle.

  • BEGINNING_REVOLVING - Account is beginning to revolve and just started carrying a balance from the previous month.

  • REVOLVING - Account is revolving and has been carrying a balance from month to month for more than one month.

  • END_REVOLVING - Account is no longer revolving and the previous month’s balance is paid off.

  • TRANSACTING - Account is not revolving and being paid off each month.

Allowable Values:

BEGINNING_REVOLVING, REVOLVING, END_REVOLVING, TRANSACTING

interest_calculation.application_of_credits.day

integer
Returned

Day of the billing cycle when credits are applied.

Allowable Values:

1–31

interest_calculation.exclude_tran_types

array of strings
Conditionally returned

List of transactions that are excluded from current billing period’s interest charge, but included in next.

Allowable Values:

LATE_PAYMENT_FEE, ANNUAL_FEE, CASH_BACK_STATEMENT_CREDIT, RETURNED_PAYMENT_FEE

config

object
Conditionally returned

Information on configurations for billing cycle day, payment due day, and fees.

Allowable Values:

config.billing_cycle_day

integer
Returned

Day of month the billing cycle starts.

Allowable Values:

1

config.payment_due_day

integer
Returned

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

Allowable Values:

31

config.fees

array of strings
Conditionally returned

List of fee types associated with the product.

Allowable Values:

LATE_PAYMENT_FEE, RETURNED_PAYMENT_FEE

Sample response body
JSON
Copied

Is this helpful?

Yes
No

List credit products

Action: GET
Endpoint: /credit/products

Retrieve an array of credit products.

This endpoint supports sorting and pagination.

URL query parameters
Fields Description

status

array of strings
Optional

Filter products returned by specified status, allows multiple statuses to be included.

Allowable Values:

DRAFT, PENDING_APPROVAL, SENT_FOR_REVISION, ACTIVE, REJECTED, ARCHIVED

count

integer
Optional

The number of resources to retrieve.

Allowable Values:

1–100

start_index

integer
Optional

The 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
Fields Description

count

integer
Returned

The number of resources returned.

Allowable Values:

start_index

integer
Returned

The sort order index of the first resource in the returned array.

Allowable Values:

Any integer

end_index

integer
Returned

The 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

List of credit products.

Allowable Values:

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

List of associated card product tokens.

Allowable Values:

data[].name

string
Conditionally returned

Name of the credit product.

Allowable Values:

data[].description

string
Conditionally returned

Description of the credit product.

Allowable Values:

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 the Marqeta platform.

Allowable Values:

data[].updated_time

datetime
Conditionally returned

Date and time when the credit product was last updated on the Marqeta platform.

Allowable Values:

data[].classification

string
Conditionally returned

Class to which the credit product belongs.

CONSUMER - The credit product is intended for individual consumers.

Allowable Values:

CONSUMER

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.

Allowable Values:

CREDIT_CARD

data[].currency_code

string
Conditionally returned

A valid three-digit ISO 4217 currency code

Allowable Values:

USD

data[].credit_line

object
Conditionally returned

Information about the credit line range.

Allowable Values:

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

List of 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

Information used to calculate the minimum payment amount.

Allowable Values:

data[].min_payment_calculation.include_past_due_amount

boolean
Returned

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

Allowable Values:

data[].min_payment_calculation.min_payment_percentage

object
Returned

Information used to calculate the minimum payment percentage.

Allowable Values:

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

List of fee types to include when calculating the minimum payment.

Allowable Values:

LATE_PAYMENT_FEE, RETURNED_PAYMENT_FEE

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

Definitions for interest calculation characteristics.

Allowable Values:

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

Balance type 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.application_of_credits

object
Returned

Cycle type and day that credits are applied in the daily balance calculation.

Allowable Values:

data[].interest_calculation.application_of_credits.cycle_type

string
Returned

Type of cycle.

  • BEGINNING_REVOLVING - Account is beginning to revolve and just started carrying a balance from the previous month.

  • REVOLVING - Account is revolving and has been carrying a balance from month to month for more than one month.

  • END_REVOLVING - Account is no longer revolving and the previous month’s balance is paid off.

  • TRANSACTING - Account is not revolving and being paid off each month.

Allowable Values:

BEGINNING_REVOLVING, REVOLVING, END_REVOLVING, TRANSACTING

data[].interest_calculation.application_of_credits.day

integer
Returned

Day of the billing cycle when credits are applied.

Allowable Values:

1–31

data[].interest_calculation.exclude_tran_types

array of strings
Conditionally returned

List of transactions that are excluded from current billing period’s interest charge, but included in next.

Allowable Values:

LATE_PAYMENT_FEE, ANNUAL_FEE, CASH_BACK_STATEMENT_CREDIT, RETURNED_PAYMENT_FEE

data[].config

object
Conditionally returned

Information on configurations for billing cycle day, payment due day, and fees.

Allowable Values:

data[].config.billing_cycle_day

integer
Returned

Day of month the billing cycle starts.

Allowable Values:

1

data[].config.payment_due_day

integer
Returned

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

Allowable Values:

31

data[].config.fees

array of strings
Conditionally returned

List of fee types associated with the product.

Allowable Values:

LATE_PAYMENT_FEE, RETURNED_PAYMENT_FEE

Sample response body
JSON
Copied

Is this helpful?

Yes
No

Retrieve credit product

Action: GET
Endpoint: /credit/products/{token}

Retrieve a credit product.

URL path parameters
Fields Description

token

string
Required

The unique identifier of the credit product to retrieve.

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

Allowable Values:

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

List of associated card product tokens.

Allowable Values:

name

string
Conditionally returned

Name of the credit product.

Allowable Values:

description

string
Conditionally returned

Description of the credit product.

Allowable Values:

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 the Marqeta platform.

Allowable Values:

updated_time

datetime
Conditionally returned

Date and time when the credit product was last updated on the Marqeta platform.

Allowable Values:

classification

string
Conditionally returned

Class to which the credit product belongs.

CONSUMER - The credit product is intended for individual consumers.

Allowable Values:

CONSUMER

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.

Allowable Values:

CREDIT_CARD

currency_code

string
Conditionally returned

A valid three-digit ISO 4217 currency code

Allowable Values:

USD

credit_line

object
Conditionally returned

Information about the credit line range.

Allowable Values:

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

List of 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

Information used to calculate the minimum payment amount.

Allowable Values:

min_payment_calculation.include_past_due_amount

boolean
Returned

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

Allowable Values:

min_payment_calculation.min_payment_percentage

object
Returned

Information used to calculate the minimum payment percentage.

Allowable Values:

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

List of fee types to include when calculating the minimum payment.

Allowable Values:

LATE_PAYMENT_FEE, RETURNED_PAYMENT_FEE

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

Definitions for interest calculation characteristics.

Allowable Values:

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

Balance type 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.application_of_credits

object
Returned

Cycle type and day that credits are applied in the daily balance calculation.

Allowable Values:

interest_calculation.application_of_credits.cycle_type

string
Returned

Type of cycle.

  • BEGINNING_REVOLVING - Account is beginning to revolve and just started carrying a balance from the previous month.

  • REVOLVING - Account is revolving and has been carrying a balance from month to month for more than one month.

  • END_REVOLVING - Account is no longer revolving and the previous month’s balance is paid off.

  • TRANSACTING - Account is not revolving and being paid off each month.

Allowable Values:

BEGINNING_REVOLVING, REVOLVING, END_REVOLVING, TRANSACTING

interest_calculation.application_of_credits.day

integer
Returned

Day of the billing cycle when credits are applied.

Allowable Values:

1–31

interest_calculation.exclude_tran_types

array of strings
Conditionally returned

List of transactions that are excluded from current billing period’s interest charge, but included in next.

Allowable Values:

LATE_PAYMENT_FEE, ANNUAL_FEE, CASH_BACK_STATEMENT_CREDIT, RETURNED_PAYMENT_FEE

config

object
Conditionally returned

Information on configurations for billing cycle day, payment due day, and fees.

Allowable Values:

config.billing_cycle_day

integer
Returned

Day of month the billing cycle starts.

Allowable Values:

1

config.payment_due_day

integer
Returned

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

Allowable Values:

31

config.fees

array of strings
Conditionally returned

List of fee types associated with the product.

Allowable Values:

LATE_PAYMENT_FEE, RETURNED_PAYMENT_FEE

Sample response body
JSON
Copied

Is this helpful?

Yes
No

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
Fields Description

token

string
Required

The 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:

URL query parameters
Fields Description

status

array of strings
Optional

The statuses of the credit products to return.

Allowable Values:

DRAFT, PENDING_APPROVAL, SENT_FOR_REVISION, ACTIVE, REJECTED, ARCHIVED

count

integer
Optional

The number of resources to retrieve.

Allowable Values:

1–100

start_index

integer
Optional

The 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
Fields Description

count

integer
Returned

The number of resources returned.

Allowable Values:

start_index

integer
Returned

The sort order index of the first resource in the returned array.

Allowable Values:

Any integer

end_index

integer
Returned

The 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

List of credit products.

Allowable Values:

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

List of associated card product tokens.

Allowable Values:

data[].name

string
Conditionally returned

Name of the credit product.

Allowable Values:

data[].description

string
Conditionally returned

Description of the credit product.

Allowable Values:

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 the Marqeta platform.

Allowable Values:

data[].updated_time

datetime
Conditionally returned

Date and time when the credit product was last updated on the Marqeta platform.

Allowable Values:

data[].classification

string
Conditionally returned

Class to which the credit product belongs.

CONSUMER - The credit product is intended for individual consumers.

Allowable Values:

CONSUMER

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.

Allowable Values:

CREDIT_CARD

data[].currency_code

string
Conditionally returned

A valid three-digit ISO 4217 currency code

Allowable Values:

USD

data[].credit_line

object
Conditionally returned

Information about the credit line range.

Allowable Values:

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

List of 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

Information used to calculate the minimum payment amount.

Allowable Values:

data[].min_payment_calculation.include_past_due_amount

boolean
Returned

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

Allowable Values:

data[].min_payment_calculation.min_payment_percentage

object
Returned

Information used to calculate the minimum payment percentage.

Allowable Values:

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

List of fee types to include when calculating the minimum payment.

Allowable Values:

LATE_PAYMENT_FEE, RETURNED_PAYMENT_FEE

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

Definitions for interest calculation characteristics.

Allowable Values:

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

Balance type 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.application_of_credits

object
Returned

Cycle type and day that credits are applied in the daily balance calculation.

Allowable Values:

data[].interest_calculation.application_of_credits.cycle_type

string
Returned

Type of cycle.

  • BEGINNING_REVOLVING - Account is beginning to revolve and just started carrying a balance from the previous month.

  • REVOLVING - Account is revolving and has been carrying a balance from month to month for more than one month.

  • END_REVOLVING - Account is no longer revolving and the previous month’s balance is paid off.

  • TRANSACTING - Account is not revolving and being paid off each month.

Allowable Values:

BEGINNING_REVOLVING, REVOLVING, END_REVOLVING, TRANSACTING

data[].interest_calculation.application_of_credits.day

integer
Returned

Day of the billing cycle when credits are applied.

Allowable Values:

1–31

data[].interest_calculation.exclude_tran_types

array of strings
Conditionally returned

List of transactions that are excluded from current billing period’s interest charge, but included in next.

Allowable Values:

LATE_PAYMENT_FEE, ANNUAL_FEE, CASH_BACK_STATEMENT_CREDIT, RETURNED_PAYMENT_FEE

data[].config

object
Conditionally returned

Information on configurations for billing cycle day, payment due day, and fees.

Allowable Values:

data[].config.billing_cycle_day

integer
Returned

Day of month the billing cycle starts.

Allowable Values:

1

data[].config.payment_due_day

integer
Returned

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

Allowable Values:

31

data[].config.fees

array of strings
Conditionally returned

List of fee types associated with the product.

Allowable Values:

LATE_PAYMENT_FEE, RETURNED_PAYMENT_FEE

Sample response body
JSON
Copied

Is this helpful?

Yes
No

Credit product transition events

Credit product transition events include activities such as a credit product being activated, pending approval, sent for revision, or rejected. These activities transition a credit product’s status.

Credit product transition notifications contain detailed information about the events. They are sent as credit product transition events occur.

Each notification contains a status field that categorizes the credit product transition event. The following table describes each credit product status. Values in the Status column are the literal values of the notification’s status field. Values in the Type field are the literal webhook event type.

When configuring a webhook to subscribe to credit events, set the type value to credit.*. This enables Marqeta to send notifications for all credit events, including credit product transition events. For more on webhooks, see Webhooks Management

Status Type Description

ACTIVE

status.activated

Credit product was activated.

PENDING APPROVAL

status.pendingapproval

Credit product was created and is now pending approval.

SENT FOR REVISION

status.sentforrevision

Credit product was sent for revision.

REJECTED

status.rejected

Credit product was rejected.

The following example shows a credit.producttransition.state.activated event.

JSON
Copied

Is this helpful?

Yes
No
Join our developer newsletter