/
205 minute read
September 6, 2023

Bundles (Beta)

Note
This feature is currently in limited-availability beta and subject to change. To learn more about the beta program for this feature, contact your Marqeta Customer Service representative.

The bundles feature on Marqeta’s credit platform enables you to create and manage bundles by choosing the specific policies that make up a bundle. A bundle must contain one document policy, credit product policy, fee policy, APR policy, and an optional reward policy. The configurations of each policy in a bundle determine the characteristics and attributes of the bundle’s associated credit accounts, reward programs, disclosures, and more. For more on how to configure a policy, see Policies.

Important

To create and manage bundles, you must use the Marqeta Dashboard. For more on bundles in the dashboard, see Credit Programs in the Marqeta Dashboard.

 

The following endpoints are displayed for reference purposes only.

Create bundle

Action: POST
Endpoint: /credit/bundles

Create a bundle.

Request body

Fields Description

token

string
Optional

Unique identifier of the bundle.

Allowable Values:

36 char max

name

string
Required

Name of the bundle.

Allowable Values:

255 char max

description

string
Required

Description of the bundle.

Allowable Values:

255 char max

status

string
Required

Status of the bundle.

  • DRAFT - The bundle is in the process of being created.

  • PENDING_APPROVAL - The bundle has been created and is awaiting approval.

  • SENT_FOR_REVISION - The bundle has been returned for revision.

  • ACTIVE - The bundle is active.

  • REJECTED - The bundle has been rejected; this status cannot be changed.

  • ARCHIVED - The previously active bundle has been archived.

  • APPROVED - The bundle has been approved (after having been sent for approval).

Allowable Values:

DRAFT, PENDING_APPROVAL, SENT_FOR_REVISION, ACTIVE, REJECTED, ARCHIVED, APPROVED

credit_product_policy_token

string
Required

Unique identifier of the credit product policy.

Allowable Values:

36 char max

apr_policy_token

string
Required

Unique identifier of the APR policy.

Allowable Values:

36 char max

document_policy_token

string
Required

Unique identifier of the document policy.

Allowable Values:

36 char max

fee_policy_token

string
Required

Unique identifier of the fee policy.

Allowable Values:

36 char max

reward_policy_token

string
Optional

Unique identifier of the reward policy.

Allowable Values:

36 char max

offer_policy_token

string
Optional

Unique identifier of the offer policy.

Allowable Values:

36 char max

Sample request body

JSON
Copied

Is this helpful?

Yes
No

Response body

Fields Description

token

string
Conditionally returned

Unique identifier of the bundle.

Allowable Values:

36 char max

name

string
Conditionally returned

Name of the bundle.

Allowable Values:

255 char max

status

string
Conditionally returned

Status of the bundle.

  • DRAFT - The bundle is in the process of being created.

  • PENDING_APPROVAL - The bundle has been created and is awaiting approval.

  • SENT_FOR_REVISION - The bundle has been returned for revision.

  • ACTIVE - The bundle is active.

  • REJECTED - The bundle has been rejected; this status cannot be changed.

  • ARCHIVED - The previously active bundle has been archived.

  • APPROVED - The bundle has been approved (after having been sent for approval).

Allowable Values:

DRAFT, PENDING_APPROVAL, SENT_FOR_REVISION, ACTIVE, REJECTED, ARCHIVED, APPROVED

description

string
Conditionally returned

Description of the bundle.

Allowable Values:

255 char max

credit_product_policy_token

string
Conditionally returned

Unique identifier of the bundle’s credit product policy.

Allowable Values:

36 char max

credit_product_policy_detail

object
Conditionally returned

Contains information on the credit product policy.

Allowable Values:

Existing credit_product_policy_detail object

credit_product_policy_detail.token

string
Conditionally returned

Unique identifier of the credit product policy.

Allowable Values:

36 char max

credit_product_policy_detail.card_products

array of objects
Conditionally returned

One or more card products associated with the credit product policy.

Allowable Values:

One or more card_products objects

credit_product_policy_detail.card_products[].token

string
Conditionally returned

Unique identifier of the card product.

Allowable Values:

36 char max

credit_product_policy_detail.card_products[].level

string
Conditionally returned

Level of the card product.

Allowable Values:

PREMIUM, TRADITIONAL

credit_product_policy_detail.card_products[].network

string
Conditionally returned

Name of the card network.

Allowable Values:

VISA, MASTERCARD, SANDBOX

credit_product_policy_detail.name

string
Conditionally returned

Name of the credit product policy.

Allowable Values:

1 char min

credit_product_policy_detail.description

string
Conditionally returned

Description of the credit product policy.

Allowable Values:

255 char max

credit_product_policy_detail.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

credit_product_policy_detail.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

credit_product_policy_detail.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

credit_product_policy_detail.currency_code

string
Conditionally returned

A valid three-digit ISO 4217 currency code

Allowable Values:

USD

credit_product_policy_detail.credit_line

object
Conditionally returned

Contains information on the credit line range.

Allowable Values:

Existing credit_line object

credit_product_policy_detail.credit_line.min

decimal
Returned

Minimum credit limit.

Allowable Values:

0–999999999999.99

credit_product_policy_detail.credit_line.max

decimal
Returned

Maximum credit limit.

Allowable Values:

0–999999999999.99

credit_product_policy_detail.usage

array of strings
Conditionally returned

One or more usage types for the credit product policy.

Allowable Values:

PURCHASE

Valid usage array

credit_product_policy_detail.interest_calculation

object
Conditionally returned

Contains the configurations for interest calculation.

Allowable Values:

Existing interest_calculation object

credit_product_policy_detail.interest_calculation.method

string
Returned

Method of interest calculation.

Allowable Values:

AVG_DAILY_BALANCE_WITH_NEW_TRANSACTIONS

credit_product_policy_detail.interest_calculation.day_count

string
Returned

Day-count convention.

Allowable Values:

ACTUAL

credit_product_policy_detail.interest_calculation.interest_application

array of strings
Returned

One or more balance types on which interest is applied.

Allowable Values:

PRINCIPAL, FEES, INTEREST

credit_product_policy_detail.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

credit_product_policy_detail.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

credit_product_policy_detail.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

credit_product_policy_detail.interest_calculation.application_of_credits

object
Returned

Contains information on the cycle type and billing cycle day when credits are applied in the daily balance calculation.

Allowable Values:

Existing application_of_credits object

credit_product_policy_detail.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 the balance is paid off each month.

Allowable Values:

BEGINNING_REVOLVING, REVOLVING, END_REVOLVING, TRANSACTING

When creating or updating an account, only TRANSACTING is allowed.

credit_product_policy_detail.interest_calculation.application_of_credits.day

integer
Returned

Day of the billing cycle when credits are applied.

Allowable Values:

1–31

credit_product_policy_detail.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

credit_product_policy_detail.payments

object
Conditionally returned

Contains the configurations for billing cycle day, payment due day, and fees.

Allowable Values:

Existing payments object

credit_product_policy_detail.payments.billing_cycle_day

integer
Returned

Day of month the billing cycle starts.

Allowable Values:

1

credit_product_policy_detail.payments.due_day

integer
Returned

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

Allowable Values:

31

credit_product_policy_detail.payments.allocation_order

array of strings
Returned

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

Allowable Values:

INTEREST, FEES, PRINCIPAL

credit_product_policy_detail.payments.min_payment_calculation

object
Returned

Contains information used to calculate the minimum payment amount on a credit product policy.

Allowable Values:

Existing min_payment_calculation object

credit_product_policy_detail.payments.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

credit_product_policy_detail.payments.min_payment_calculation.include_overlimit_amount

boolean
Returned

Whether to include the overlimit amount when calculating the minimum payment.

Allowable Values:

true, false

credit_product_policy_detail.payments.min_payment_calculation.min_payment_flat_amount

decimal
Conditionally returned

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

Allowable Values:

Format: 0.00

credit_product_policy_detail.payments.min_payment_calculation.min_payment_percentage

object
Conditionally returned

Contains information used to calculate the minimum payment amount when expressed as a percentage.

Allowable Values:

Existing min_payment_percentage object

credit_product_policy_detail.payments.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

credit_product_policy_detail.payments.min_payment_calculation.min_payment_percentage.include_interest_charged

boolean
Returned

Whether to include the amount of interest charged when calculating the minimum payment.

Allowable Values:

true, false

credit_product_policy_detail.payments.min_payment_calculation.min_payment_percentage.include_fees_charged

array of strings
Conditionally returned

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

Allowable Values:

LATE_PAYMENT_FEE, RETURNED_PAYMENT_FEE

credit_product_policy_detail.created_time

datetime
Conditionally returned

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

Allowable Values:

Format: yyyy-MM-ddThh:mm:ssZ

credit_product_policy_detail.updated_time

datetime
Conditionally returned

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

Allowable Values:

Format: yyyy-MM-ddThh:mm:ssZ

apr_policy_token

string
Conditionally returned

Unique identifier of the bundle’s APR policy.

Allowable Values:

36 char max

apr_policy_detail

object
Conditionally returned

Contains information on an APR policy.

Allowable Values:

Existing apr_policy_detail object

apr_policy_detail.token

string
Conditionally returned

Unique identifier of the APR policy.

Allowable Values:

36 char max

apr_policy_detail.name

string
Conditionally returned

Name of the APR policy.

Allowable Values:

255 char max

apr_policy_detail.description

string
Conditionally returned

Description of the APR policy.

Allowable Values:

255 char max

apr_policy_detail.purchases

object
Conditionally returned

Contains information on the pricing strategy for purchases.

Allowable Values:

Existing purchases object

apr_policy_detail.purchases.name

string
Conditionally returned

Name of the pricing strategy.

Allowable Values:

255 char max

apr_policy_detail.purchases.external_token

string
Conditionally returned

Unique identifier of the pricing strategy on a credit program.

Allowable Values:

36 char max

apr_policy_detail.purchases.tiers

array of objects
Conditionally returned

One or more risk tiers for a pricing strategy.

Allowable Values:

One or more tiers objects

apr_policy_detail.purchases.tiers[].margin_rate

decimal
Conditionally returned

Margin rate for the risk tier for a pricing strategy.

Allowable Values:

Format: 0.00

apr_policy_detail.purchases.tiers[].apr

decimal
Conditionally returned

The value of the APR.

Allowable Values:

Format: 0.00

apr_policy_detail.effective_date

date
Conditionally returned

Date the APR goes into effect, in UTC.

Allowable Values:

Format: yyyy-MM-dd

apr_policy_detail.created_time

datetime
Conditionally returned

Date and time when the APR policy was created on Marqeta’s credit platform, in UTC.

Allowable Values:

Format: yyyy-MM-ddThh:mm:ssZ

apr_policy_detail.updated_time

datetime
Conditionally returned

Date and time when the APR policy was last updated on Marqeta’s credit platform, in UTC.

Allowable Values:

Format: yyyy-MM-ddThh:mm:ssZ

document_policy_token

string
Conditionally returned

Unique identifier of the bundle’s document policy.

Allowable Values:

36 char max

document_policy_detail

object
Conditionally returned

Contains information on a document policy.

Allowable Values:

Existing document_policy_detail object

document_policy_detail.token

string
Conditionally returned

Unique identifier of the document policy.

Allowable Values:

36 char max

document_policy_detail.name

string
Conditionally returned

Name of the document policy.

Allowable Values:

255 char max

document_policy_detail.summary_of_credit_terms

object
Conditionally returned

Contains information on the Summary of Credit Terms (SOCT), which is a pre- and post-application disclosure that outlines the terms of an account, such as the interest rates, interest charges, associated fees, and more.

Allowable Values:

Existing summary_of_credit_terms object

document_policy_detail.summary_of_credit_terms.asset_token

string
Conditionally returned

Unique identifier of the asset, which is the version of a document that is based on the template and contains finalized values. The values are finalized when the bundle containing the document is created.

Allowable Values:

Existing asset token for the SOCT or Rewards Disclosure

document_policy_detail.summary_of_credit_terms.asset_urls

object
Conditionally returned

Contains one or more URLs for an asset.

Allowable Values:

One or more asset_urls objects

document_policy_detail.summary_of_credit_terms.asset_urls.pdf

string
Returned

URL to the PDF version of the asset.

Allowable Values:

A valid URL

document_policy_detail.summary_of_credit_terms.asset_urls.png

string
Returned

URL to the PNG version of the asset.

Allowable Values:

A valid URL

document_policy_detail.summary_of_credit_terms.asset_urls.html

string
Returned

URL to the HTML version of the asset.

Allowable Values:

A valid URL

document_policy_detail.summary_of_credit_terms.asset_created_time

datetime
Conditionally returned

Date and time when the asset was created.

Allowable Values:

Format: yyyy-MM-ddThh:mm:ssZ

document_policy_detail.summary_of_credit_terms.template_token

string
Conditionally returned

Unique identifier of the template, which is the version of a document that serves as an initial disclosure but does not contain finalized values. Values are finalized in the asset version of the document.

Allowable Values:

Existing template token for the SOCT or Rewards Disclosure

document_policy_detail.summary_of_credit_terms.template_urls

object
Conditionally returned

Contains one or more URLs for a template.

Allowable Values:

One or more template_urls objects

document_policy_detail.summary_of_credit_terms.template_urls.html

string
Returned

URL to the HTML version of the document template.

Allowable Values:

A valid URL

document_policy_detail.summary_of_credit_terms.template_created_time

datetime
Conditionally returned

Date and time when the template was created.

Allowable Values:

Format: yyyy-MM-ddThh:mm:ssZ

document_policy_detail.rewards_disclosure

object
Conditionally returned

Contains information on the Rewards Disclosure, which is a pre- and post-application disclosure that provides details about the rewards program for a bundle.

Allowable Values:

Existing rewards_disclosure object

document_policy_detail.rewards_disclosure.asset_token

string
Conditionally returned

Unique identifier of the asset, which is the version of a document that is based on the template and contains finalized values. The values are finalized when the bundle containing the document is created.

Allowable Values:

Existing asset token for the SOCT or Rewards Disclosure

document_policy_detail.rewards_disclosure.asset_urls

object
Conditionally returned

Contains one or more URLs for an asset.

Allowable Values:

One or more asset_urls objects

document_policy_detail.rewards_disclosure.asset_urls.pdf

string
Returned

URL to the PDF version of the asset.

Allowable Values:

A valid URL

document_policy_detail.rewards_disclosure.asset_urls.png

string
Returned

URL to the PNG version of the asset.

Allowable Values:

A valid URL

document_policy_detail.rewards_disclosure.asset_urls.html

string
Returned

URL to the HTML version of the asset.

Allowable Values:

A valid URL

document_policy_detail.rewards_disclosure.asset_created_time

datetime
Conditionally returned

Date and time when the asset was created.

Allowable Values:

Format: yyyy-MM-ddThh:mm:ssZ

document_policy_detail.rewards_disclosure.template_token

string
Conditionally returned

Unique identifier of the template, which is the version of a document that serves as an initial disclosure but does not contain finalized values. Values are finalized in the asset version of the document.

Allowable Values:

Existing template token for the SOCT or Rewards Disclosure

document_policy_detail.rewards_disclosure.template_urls

object
Conditionally returned

Contains one or more URLs for a template.

Allowable Values:

One or more template_urls objects

document_policy_detail.rewards_disclosure.template_urls.html

string
Returned

URL to the HTML version of the document template.

Allowable Values:

A valid URL

document_policy_detail.rewards_disclosure.template_created_time

datetime
Conditionally returned

Date and time when the template was created.

Allowable Values:

Format: yyyy-MM-ddThh:mm:ssZ

document_policy_detail.terms_schedule

object
Conditionally returned

Contains information on the Terms Schedule, which is a post-application disclosure that contains the terms of credit for an account, including the interest rate details.

Allowable Values:

Existing terms_schedule object

document_policy_detail.terms_schedule.template_token

string
Conditionally returned

Unique identifier of a template, which is a document that serves as an initial disclosure but does not contain finalized values.

Allowable Values:

Existing template token for the Terms Schedule, Account Statement, or NOAA

document_policy_detail.terms_schedule.template_urls

object
Conditionally returned

Contains one or more URLs for a template.

Allowable Values:

One or more template_urls objects

document_policy_detail.terms_schedule.template_urls.html

string
Returned

URL to the HTML version of the document template.

Allowable Values:

A valid URL

document_policy_detail.terms_schedule.template_created_time

datetime
Conditionally returned

Date and time when the template was created.

Allowable Values:

Format: yyyy-MM-ddThh:mm:ssZ

document_policy_detail.benefits_disclosure_traditional

object
Conditionally returned

Contains information on the Benefits Disclosure (Traditional), which is a post-application disclosure that outlines the network benefits of a traditional Mastercard or Visa card.

Allowable Values:

Existing benefits_disclosure_traditional object

document_policy_detail.benefits_disclosure_traditional.asset_token

string
Conditionally returned

Unique identifier of the asset, which is a type of document that contains finalized values. The values are finalized when the bundle containing the document is created.

Allowable Values:

Existing asset token for the Benefits Disclosure (Traditional), Benefits Disclosure (Premium), Privacy Policy, eDisclosure, or Card Member Agreement

document_policy_detail.benefits_disclosure_traditional.asset_urls

object
Conditionally returned

Contains one or more URLs for an asset.

Allowable Values:

One or more asset_urls objects

document_policy_detail.benefits_disclosure_traditional.asset_urls.pdf

string
Returned

URL to the PDF version of the asset.

Allowable Values:

A valid URL

document_policy_detail.benefits_disclosure_traditional.asset_urls.png

string
Returned

URL to the PNG version of the asset.

Allowable Values:

A valid URL

document_policy_detail.benefits_disclosure_traditional.asset_urls.html

string
Returned

URL to the HTML version of the asset.

Allowable Values:

A valid URL

document_policy_detail.benefits_disclosure_traditional.asset_created_time

datetime
Conditionally returned

Date and time when the asset was created.

Allowable Values:

Format: yyyy-MM-ddThh:mm:ssZ

document_policy_detail.benefits_disclosure_premium

object
Conditionally returned

Contains information on the Benefits Disclosure (Premium), which is a post-application disclosure that outlines the network benefits of a Mastercard World or Visa Signature card.

Allowable Values:

Existing benefits_disclosure_premium object

document_policy_detail.benefits_disclosure_premium.asset_token

string
Conditionally returned

Unique identifier of the asset, which is a type of document that contains finalized values. The values are finalized when the bundle containing the document is created.

Allowable Values:

Existing asset token for the Benefits Disclosure (Traditional), Benefits Disclosure (Premium), Privacy Policy, eDisclosure, or Card Member Agreement

document_policy_detail.benefits_disclosure_premium.asset_urls

object
Conditionally returned

Contains one or more URLs for an asset.

Allowable Values:

One or more asset_urls objects

document_policy_detail.benefits_disclosure_premium.asset_urls.pdf

string
Returned

URL to the PDF version of the asset.

Allowable Values:

A valid URL

document_policy_detail.benefits_disclosure_premium.asset_urls.png

string
Returned

URL to the PNG version of the asset.

Allowable Values:

A valid URL

document_policy_detail.benefits_disclosure_premium.asset_urls.html

string
Returned

URL to the HTML version of the asset.

Allowable Values:

A valid URL

document_policy_detail.benefits_disclosure_premium.asset_created_time

datetime
Conditionally returned

Date and time when the asset was created.

Allowable Values:

Format: yyyy-MM-ddThh:mm:ssZ

document_policy_detail.privacy_policy

object
Conditionally returned

Contains information on the Privacy Policy, which is a pre-application disclosure that explains how an applicant’s data is used and managed.

Allowable Values:

Existing privacy_policy object

document_policy_detail.privacy_policy.asset_token

string
Conditionally returned

Unique identifier of the asset, which is a type of document that contains finalized values. The values are finalized when the bundle containing the document is created.

Allowable Values:

Existing asset token for the Benefits Disclosure (Traditional), Benefits Disclosure (Premium), Privacy Policy, eDisclosure, or Card Member Agreement

document_policy_detail.privacy_policy.asset_urls

object
Conditionally returned

Contains one or more URLs for an asset.

Allowable Values:

One or more asset_urls objects

document_policy_detail.privacy_policy.asset_urls.pdf

string
Returned

URL to the PDF version of the asset.

Allowable Values:

A valid URL

document_policy_detail.privacy_policy.asset_urls.png

string
Returned

URL to the PNG version of the asset.

Allowable Values:

A valid URL

document_policy_detail.privacy_policy.asset_urls.html

string
Returned

URL to the HTML version of the asset.

Allowable Values:

A valid URL

document_policy_detail.privacy_policy.asset_created_time

datetime
Conditionally returned

Date and time when the asset was created.

Allowable Values:

Format: yyyy-MM-ddThh:mm:ssZ

document_policy_detail.e_disclosure

object
Conditionally returned

Contains information on the eDisclosure, which is a pre-application disclosure that states that users are to receive their disclosures electronically.

Allowable Values:

Existing e_disclosure object

document_policy_detail.e_disclosure.asset_token

string
Conditionally returned

Unique identifier of the asset, which is a type of document that contains finalized values. The values are finalized when the bundle containing the document is created.

Allowable Values:

Existing asset token for the Benefits Disclosure (Traditional), Benefits Disclosure (Premium), Privacy Policy, eDisclosure, or Card Member Agreement

document_policy_detail.e_disclosure.asset_urls

object
Conditionally returned

Contains one or more URLs for an asset.

Allowable Values:

One or more asset_urls objects

document_policy_detail.e_disclosure.asset_urls.pdf

string
Returned

URL to the PDF version of the asset.

Allowable Values:

A valid URL

document_policy_detail.e_disclosure.asset_urls.png

string
Returned

URL to the PNG version of the asset.

Allowable Values:

A valid URL

document_policy_detail.e_disclosure.asset_urls.html

string
Returned

URL to the HTML version of the asset.

Allowable Values:

A valid URL

document_policy_detail.e_disclosure.asset_created_time

datetime
Conditionally returned

Date and time when the asset was created.

Allowable Values:

Format: yyyy-MM-ddThh:mm:ssZ

document_policy_detail.card_member_agreement

object
Conditionally returned

Contains information on the Card Member Agreement, which is a post-application disclosure that specifies the terms and conditions of an account, including the interest rates, interest charges, fees, minimum payment calculations, and more.

Allowable Values:

Existing card_member_agreement object

document_policy_detail.card_member_agreement.asset_token

string
Conditionally returned

Unique identifier of the asset, which is a type of document that contains finalized values. The values are finalized when the bundle containing the document is created.

Allowable Values:

Existing asset token for the Benefits Disclosure (Traditional), Benefits Disclosure (Premium), Privacy Policy, eDisclosure, or Card Member Agreement

document_policy_detail.card_member_agreement.asset_urls

object
Conditionally returned

Contains one or more URLs for an asset.

Allowable Values:

One or more asset_urls objects

document_policy_detail.card_member_agreement.asset_urls.pdf

string
Returned

URL to the PDF version of the asset.

Allowable Values:

A valid URL

document_policy_detail.card_member_agreement.asset_urls.png

string
Returned

URL to the PNG version of the asset.

Allowable Values:

A valid URL

document_policy_detail.card_member_agreement.asset_urls.html

string
Returned

URL to the HTML version of the asset.

Allowable Values:

A valid URL

document_policy_detail.card_member_agreement.asset_created_time

datetime
Conditionally returned

Date and time when the asset was created.

Allowable Values:

Format: yyyy-MM-ddThh:mm:ssZ

document_policy_detail.account_statement

object
Conditionally returned

Contains information on the Account Statement, which outlines the information that appears on the statements generated for a credit account.

Allowable Values:

Existing account_statement object

document_policy_detail.account_statement.template_token

string
Conditionally returned

Unique identifier of a template, which is a document that serves as an initial disclosure but does not contain finalized values.

Allowable Values:

Existing template token for the Terms Schedule, Account Statement, or NOAA

document_policy_detail.account_statement.template_urls

object
Conditionally returned

Contains one or more URLs for a template.

Allowable Values:

One or more template_urls objects

document_policy_detail.account_statement.template_urls.html

string
Returned

URL to the HTML version of the document template.

Allowable Values:

A valid URL

document_policy_detail.account_statement.template_created_time

datetime
Conditionally returned

Date and time when the template was created.

Allowable Values:

Format: yyyy-MM-ddThh:mm:ssZ

document_policy_detail.noaa_single_reason

object
Conditionally returned

Contains information on the Notice of Adverse Action (NOAA) used when an application is declined for single reason.

Allowable Values:

Existing noaa_single_reason object

document_policy_detail.noaa_single_reason.template_token

string
Conditionally returned

Unique identifier of a template, which is a document that serves as an initial disclosure but does not contain finalized values.

Allowable Values:

Existing template token for the Terms Schedule, Account Statement, or NOAA

document_policy_detail.noaa_single_reason.template_urls

object
Conditionally returned

Contains one or more URLs for a template.

Allowable Values:

One or more template_urls objects

document_policy_detail.noaa_single_reason.template_urls.html

string
Returned

URL to the HTML version of the document template.

Allowable Values:

A valid URL

document_policy_detail.noaa_single_reason.template_created_time

datetime
Conditionally returned

Date and time when the template was created.

Allowable Values:

Format: yyyy-MM-ddThh:mm:ssZ

document_policy_detail.noaa_single_reason_with_dodd_frank

object
Conditionally returned

Contains information on the NOAA used when an application is declined for single reason related to the applicant’s credit score. This NOAA contains a Dodd-Frank section that discloses their credit score and the information related to that score that was used to decline their application.

Allowable Values:

Existing noaa_single_reason_with_dodd_frank object

document_policy_detail.noaa_single_reason_with_dodd_frank.template_token

string
Conditionally returned

Unique identifier of a template, which is a document that serves as an initial disclosure but does not contain finalized values.

Allowable Values:

Existing template token for the Terms Schedule, Account Statement, or NOAA

document_policy_detail.noaa_single_reason_with_dodd_frank.template_urls

object
Conditionally returned

Contains one or more URLs for a template.

Allowable Values:

One or more template_urls objects

document_policy_detail.noaa_single_reason_with_dodd_frank.template_urls.html

string
Returned

URL to the HTML version of the document template.

Allowable Values:

A valid URL

document_policy_detail.noaa_single_reason_with_dodd_frank.template_created_time

datetime
Conditionally returned

Date and time when the template was created.

Allowable Values:

Format: yyyy-MM-ddThh:mm:ssZ

document_policy_detail.noaa_multiple_reason_with_dodd_frank

object
Conditionally returned

Contains information on the NOAA used when an application is declined for multiple reasons related to the applicant’s credit score. This NOAA contains a Dodd-Frank section that discloses their credit score and the information related to that score that was used to decline their application.

Allowable Values:

Existing noaa_multiple_reason_with_dodd_frank object

document_policy_detail.noaa_multiple_reason_with_dodd_frank.template_token

string
Conditionally returned

Unique identifier of a template, which is a document that serves as an initial disclosure but does not contain finalized values.

Allowable Values:

Existing template token for the Terms Schedule, Account Statement, or NOAA

document_policy_detail.noaa_multiple_reason_with_dodd_frank.template_urls

object
Conditionally returned

Contains one or more URLs for a template.

Allowable Values:

One or more template_urls objects

document_policy_detail.noaa_multiple_reason_with_dodd_frank.template_urls.html

string
Returned

URL to the HTML version of the document template.

Allowable Values:

A valid URL

document_policy_detail.noaa_multiple_reason_with_dodd_frank.template_created_time

datetime
Conditionally returned

Date and time when the template was created.

Allowable Values:

Format: yyyy-MM-ddThh:mm:ssZ

document_policy_detail.created_time

datetime
Conditionally returned

Date and time when the document policy was created on Marqeta’s credit platform, in UTC.

Allowable Values:

Format: yyyy-MM-ddThh:mm:ssZ

document_policy_detail.updated_time

datetime
Conditionally returned

Date and time when the document policy was last updated on Marqeta’s credit platform, in UTC.

Allowable Values:

Format: yyyy-MM-ddThh:mm:ssZ

fee_policy_token

string
Conditionally returned

Unique identifier of the bundle’s fee policy.

Allowable Values:

36 char max

fee_policy_detail

object
Conditionally returned

Contains information on a fee policy.

Allowable Values:

Existing fee_policy_detail object

fee_policy_detail.token

string
Conditionally returned

Unique identifier of the fee policy.

Allowable Values:

36 char max

fee_policy_detail.name

string
Conditionally returned

Name of the fee policy.

Allowable Values:

255 char max

fee_policy_detail.description

string
Conditionally returned

Description of the fee policy.

Allowable Values:

255 char max

fee_policy_detail.account

object
Conditionally returned

Contains information on the fee policy on a credit account.

Allowable Values:

Existing account object

fee_policy_detail.account.late_payment

object
Conditionally returned

Contains information on the late payment fee.

Allowable Values:

Existing late_payment object

fee_policy_detail.account.returned_payment

object
Conditionally returned

Contains information on the returned payment fee.

Allowable Values:

Existing returned_payment object

fee_policy_detail.created_time

datetime
Conditionally returned

Date and time when the fee policy was created on Marqeta’s credit platform, in UTC.

Allowable Values:

Format: yyyy-MM-ddThh:mm:ssZ

fee_policy_detail.updated_time

datetime
Conditionally returned

Date and time when the fee policy was last updated on Marqeta’s credit platform, in UTC.

Allowable Values:

Format: yyyy-MM-ddThh:mm:ssZ

reward_policy_token

string
Conditionally returned

Unique identifier of the bundle’s reward policy.

Allowable Values:

36 char max

reward_policy_detail

object
Conditionally returned

Contains information on a reward policy.

Allowable Values:

Existing reward_policy_detail object

reward_policy_detail.token

string
Conditionally returned

Unique identifier of the reward policy.

Allowable Values:

36 char max

reward_policy_detail.name

string
Conditionally returned

Name of the reward policy.

Allowable Values:

255 char max

reward_policy_detail.description

string
Conditionally returned

Description of the reward policy.

Allowable Values:

255 char max

reward_policy_detail.rules

array of objects
Conditionally returned

One or more reward rules

Allowable Values:

One or more rules objects

reward_policy_detail.rules[].type

string
Returned

Type of reward rule.

Allowable Values:

CASHBACK

reward_policy_detail.rules[].filters

object
Returned

Contains information on the rules defined for a reward program.

Allowable Values:

Existing filters object

reward_policy_detail.rules[].filters.amount

object
Returned

Contains information on the minimum and maximum amounts that the balance for a billing cycle can be to earn the reward.

Allowable Values:

Existing amount object

reward_policy_detail.rules[].filters.amount.greater_than

decimal
Conditionally returned

The minimum amount that a balance for a billing cycle can be to earn the reward.

Allowable Values:

0 min

reward_policy_detail.rules[].filters.amount.less_than

decimal
Conditionally returned

The maximum amount that a balance for a billing cycle can be to earn the reward.

Allowable Values:

0 min

reward_policy_detail.rules[].filters.mcc_dynamic

object
Conditionally returned

Contains information on the dynamic merchant category code (MCC) for a reward.

Allowable Values:

Existing mcc_dynamic object

reward_policy_detail.rules[].filters.mcc_dynamic.includes

array of strings
Returned

One or more dynamic MCCs.

Allowable Values:

HIGHEST_SPEND

reward_policy_detail.rules[].outcome

object
Returned

Contains information on the outcome of a reward rule.

Allowable Values:

Existing outcome object

reward_policy_detail.rules[].outcome.percentage

decimal
Returned

The reward percentage applied when the balance for a billing cycle is within the range specified in the filters.amount.greater_than and filters.amount.less_than fields. For example, if the percentage is 1, the account holder earns 1% of the account balance if they spend between the greater_than and less_than amounts during a billing cycle.

Allowable Values:

0 min

reward_policy_detail.rules[].outcome.max_amount

decimal
Conditionally returned

Max amount of the reward.

Allowable Values:

0 min

reward_policy_detail.created_time

datetime
Conditionally returned

Date and time when the reward policy was created on Marqeta’s credit platform, in UTC.

Allowable Values:

Format: yyyy-MM-ddThh:mm:ssZ

reward_policy_detail.updated_time

datetime
Conditionally returned

Date and time when the reward policy was last updated on Marqeta’s credit platform, in UTC.

Allowable Values:

Format: yyyy-MM-ddThh:mm:ssZ

offer_policy_token

string
Conditionally returned

Unique identifier of the bundle’s offer policy.

Allowable Values:

36 char max

offer_policy_detail

object
Conditionally returned

Contains information on an offer policy.

Allowable Values:

Existing offer_policy_detail object

offer_policy_detail.token

string
Conditionally returned

Unique identifier of the offer policy.

Allowable Values:

36 char max

offer_policy_detail.name

string
Conditionally returned

Name of the offer policy.

Allowable Values:

255 char max

offer_policy_detail.description

string
Conditionally returned

Description of the offer policy.

Allowable Values:

255 char max

offer_policy_detail.created_time

datetime
Conditionally returned

Date and time when the offer policy was created on Marqeta’s credit platform, in UTC.

Allowable Values:

Format: yyyy-MM-ddThh:mm:ssZ

offer_policy_detail.updated_time

datetime
Conditionally returned

Date and time when the offer policy was last updated on Marqeta’s credit platform, in UTC.

Allowable Values:

Format: yyyy-MM-ddThh:mm:ssZ

created_time

datetime
Conditionally returned

Date and time when the bundle 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 bundle was last updated on Marqeta’s credit platform, in UTC.

Allowable Values:

Format: yyyy-MM-ddThh:mm:ssZ

Sample response body

JSON
Copied

Is this helpful?

Yes
No

List bundles

Action: GET
Endpoint: /credit/bundles

Retrieve an array of bundles.

This endpoint supports sorting and pagination.

URL query parameters

Fields Description

count

integer
Optional

The number of 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

status

array of strings
Optional

An array of statuses by which to filter bundles.

Allowable Values:

DRAFT, PENDING_APPROVAL, SENT_FOR_REVISION, ACTIVE, REJECTED, ARCHIVED, APPROVED

Response body

Fields Description

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 bundles.

Allowable Values:

One or more bundle objects

data[].token

string
Conditionally returned

Unique identifier of the bundle.

Allowable Values:

36 char max

data[].name

string
Conditionally returned

Name of the bundle.

Allowable Values:

255 char max

data[].status

string
Conditionally returned

Status of the bundle.

  • DRAFT - The bundle is in the process of being created.

  • PENDING_APPROVAL - The bundle has been created and is awaiting approval.

  • SENT_FOR_REVISION - The bundle has been returned for revision.

  • ACTIVE - The bundle is active.

  • REJECTED - The bundle has been rejected; this status cannot be changed.

  • ARCHIVED - The previously active bundle has been archived.

  • APPROVED - The bundle has been approved (after having been sent for approval).

Allowable Values:

DRAFT, PENDING_APPROVAL, SENT_FOR_REVISION, ACTIVE, REJECTED, ARCHIVED, APPROVED

data[].description

string
Conditionally returned

Description of the bundle.

Allowable Values:

255 char max

data[].credit_product_policy_token

string
Conditionally returned

Unique identifier of the bundle’s credit product policy.

Allowable Values:

36 char max

data[].credit_product_policy_detail

object
Conditionally returned

Contains information on the credit product policy.

Allowable Values:

Existing credit_product_policy_detail object

data[].credit_product_policy_detail.token

string
Conditionally returned

Unique identifier of the credit product policy.

Allowable Values:

36 char max

data[].credit_product_policy_detail.card_products

array of objects
Conditionally returned

One or more card products associated with the credit product policy.

Allowable Values:

One or more card_products objects

data[].credit_product_policy_detail.card_products[].token

string
Conditionally returned

Unique identifier of the card product.

Allowable Values:

36 char max

data[].credit_product_policy_detail.card_products[].level

string
Conditionally returned

Level of the card product.

Allowable Values:

PREMIUM, TRADITIONAL

data[].credit_product_policy_detail.card_products[].network

string
Conditionally returned

Name of the card network.

Allowable Values:

VISA, MASTERCARD, SANDBOX

data[].credit_product_policy_detail.name

string
Conditionally returned

Name of the credit product policy.

Allowable Values:

1 char min

data[].credit_product_policy_detail.description

string
Conditionally returned

Description of the credit product policy.

Allowable Values:

255 char max

data[].credit_product_policy_detail.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[].credit_product_policy_detail.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[].credit_product_policy_detail.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[].credit_product_policy_detail.currency_code

string
Conditionally returned

A valid three-digit ISO 4217 currency code

Allowable Values:

USD

data[].credit_product_policy_detail.credit_line

object
Conditionally returned

Contains information on the credit line range.

Allowable Values:

Existing credit_line object

data[].credit_product_policy_detail.credit_line.min

decimal
Returned

Minimum credit limit.

Allowable Values:

0–999999999999.99

data[].credit_product_policy_detail.credit_line.max

decimal
Returned

Maximum credit limit.

Allowable Values:

0–999999999999.99

data[].credit_product_policy_detail.usage

array of strings
Conditionally returned

One or more usage types for the credit product policy.

Allowable Values:

PURCHASE

Valid usage array

data[].credit_product_policy_detail.interest_calculation

object
Conditionally returned

Contains the configurations for interest calculation.

Allowable Values:

Existing interest_calculation object

data[].credit_product_policy_detail.interest_calculation.method

string
Returned

Method of interest calculation.

Allowable Values:

AVG_DAILY_BALANCE_WITH_NEW_TRANSACTIONS

data[].credit_product_policy_detail.interest_calculation.day_count

string
Returned

Day-count convention.

Allowable Values:

ACTUAL

data[].credit_product_policy_detail.interest_calculation.interest_application

array of strings
Returned

One or more balance types on which interest is applied.

Allowable Values:

PRINCIPAL, FEES, INTEREST

data[].credit_product_policy_detail.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[].credit_product_policy_detail.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[].credit_product_policy_detail.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[].credit_product_policy_detail.interest_calculation.application_of_credits

object
Returned

Contains information on the cycle type and billing cycle day when credits are applied in the daily balance calculation.

Allowable Values:

Existing application_of_credits object

data[].credit_product_policy_detail.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 the balance is paid off each month.

Allowable Values:

BEGINNING_REVOLVING, REVOLVING, END_REVOLVING, TRANSACTING

When creating or updating an account, only TRANSACTING is allowed.

data[].credit_product_policy_detail.interest_calculation.application_of_credits.day

integer
Returned

Day of the billing cycle when credits are applied.

Allowable Values:

1–31

data[].credit_product_policy_detail.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

data[].credit_product_policy_detail.payments

object
Conditionally returned

Contains the configurations for billing cycle day, payment due day, and fees.

Allowable Values:

Existing payments object

data[].credit_product_policy_detail.payments.billing_cycle_day

integer
Returned

Day of month the billing cycle starts.

Allowable Values:

1

data[].credit_product_policy_detail.payments.due_day

integer
Returned

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

Allowable Values:

31

data[].credit_product_policy_detail.payments.allocation_order

array of strings
Returned

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

Allowable Values:

INTEREST, FEES, PRINCIPAL

data[].credit_product_policy_detail.payments.min_payment_calculation

object
Returned

Contains information used to calculate the minimum payment amount on a credit product policy.

Allowable Values:

Existing min_payment_calculation object

data[].credit_product_policy_detail.payments.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[].credit_product_policy_detail.payments.min_payment_calculation.include_overlimit_amount

boolean
Returned

Whether to include the overlimit amount when calculating the minimum payment.

Allowable Values:

true, false

data[].credit_product_policy_detail.payments.min_payment_calculation.min_payment_flat_amount

decimal
Conditionally returned

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

Allowable Values:

Format: 0.00

data[].credit_product_policy_detail.payments.min_payment_calculation.min_payment_percentage

object
Conditionally returned

Contains information used to calculate the minimum payment amount when expressed as a percentage.

Allowable Values:

Existing min_payment_percentage object

data[].credit_product_policy_detail.payments.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[].credit_product_policy_detail.payments.min_payment_calculation.min_payment_percentage.include_interest_charged

boolean
Returned

Whether to include the amount of interest charged when calculating the minimum payment.

Allowable Values:

true, false

data[].credit_product_policy_detail.payments.min_payment_calculation.min_payment_percentage.include_fees_charged

array of strings
Conditionally returned

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

Allowable Values:

LATE_PAYMENT_FEE, RETURNED_PAYMENT_FEE

data[].credit_product_policy_detail.created_time

datetime
Conditionally returned

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

Allowable Values:

Format: yyyy-MM-ddThh:mm:ssZ

data[].credit_product_policy_detail.updated_time

datetime
Conditionally returned

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

Allowable Values:

Format: yyyy-MM-ddThh:mm:ssZ

data[].apr_policy_token

string
Conditionally returned

Unique identifier of the bundle’s APR policy.

Allowable Values:

36 char max

data[].apr_policy_detail

object
Conditionally returned

Contains information on an APR policy.

Allowable Values:

Existing apr_policy_detail object

data[].apr_policy_detail.token

string
Conditionally returned

Unique identifier of the APR policy.

Allowable Values:

36 char max

data[].apr_policy_detail.name

string
Conditionally returned

Name of the APR policy.

Allowable Values:

255 char max

data[].apr_policy_detail.description

string
Conditionally returned

Description of the APR policy.

Allowable Values:

255 char max

data[].apr_policy_detail.purchases

object
Conditionally returned

Contains information on the pricing strategy for purchases.

Allowable Values:

Existing purchases object

data[].apr_policy_detail.purchases.name

string
Conditionally returned

Name of the pricing strategy.

Allowable Values:

255 char max

data[].apr_policy_detail.purchases.external_token

string
Conditionally returned

Unique identifier of the pricing strategy on a credit program.

Allowable Values:

36 char max

data[].apr_policy_detail.purchases.tiers

array of objects
Conditionally returned

One or more risk tiers for a pricing strategy.

Allowable Values:

One or more tiers objects

data[].apr_policy_detail.purchases.tiers[].margin_rate

decimal
Conditionally returned

Margin rate for the risk tier for a pricing strategy.

Allowable Values:

Format: 0.00

data[].apr_policy_detail.purchases.tiers[].apr

decimal
Conditionally returned

The value of the APR.

Allowable Values:

Format: 0.00

data[].apr_policy_detail.effective_date

date
Conditionally returned

Date the APR goes into effect, in UTC.

Allowable Values:

Format: yyyy-MM-dd

data[].apr_policy_detail.created_time

datetime
Conditionally returned

Date and time when the APR policy was created on Marqeta’s credit platform, in UTC.

Allowable Values:

Format: yyyy-MM-ddThh:mm:ssZ

data[].apr_policy_detail.updated_time

datetime
Conditionally returned

Date and time when the APR policy was last updated on Marqeta’s credit platform, in UTC.

Allowable Values:

Format: yyyy-MM-ddThh:mm:ssZ

data[].document_policy_token

string
Conditionally returned

Unique identifier of the bundle’s document policy.

Allowable Values:

36 char max

data[].document_policy_detail

object
Conditionally returned

Contains information on a document policy.

Allowable Values:

Existing document_policy_detail object

data[].document_policy_detail.token

string
Conditionally returned

Unique identifier of the document policy.

Allowable Values:

36 char max

data[].document_policy_detail.name

string
Conditionally returned

Name of the document policy.

Allowable Values:

255 char max

data[].document_policy_detail.summary_of_credit_terms

object
Conditionally returned

Contains information on the Summary of Credit Terms (SOCT), which is a pre- and post-application disclosure that outlines the terms of an account, such as the interest rates, interest charges, associated fees, and more.

Allowable Values:

Existing summary_of_credit_terms object

data[].document_policy_detail.summary_of_credit_terms.asset_token

string
Conditionally returned

Unique identifier of the asset, which is the version of a document that is based on the template and contains finalized values. The values are finalized when the bundle containing the document is created.

Allowable Values:

Existing asset token for the SOCT or Rewards Disclosure

data[].document_policy_detail.summary_of_credit_terms.asset_urls

object
Conditionally returned

Contains one or more URLs for an asset.

Allowable Values:

One or more asset_urls objects

data[].document_policy_detail.summary_of_credit_terms.asset_urls.pdf

string
Returned

URL to the PDF version of the asset.

Allowable Values:

A valid URL

data[].document_policy_detail.summary_of_credit_terms.asset_urls.png

string
Returned

URL to the PNG version of the asset.

Allowable Values:

A valid URL

data[].document_policy_detail.summary_of_credit_terms.asset_urls.html

string
Returned

URL to the HTML version of the asset.

Allowable Values:

A valid URL

data[].document_policy_detail.summary_of_credit_terms.asset_created_time

datetime
Conditionally returned

Date and time when the asset was created.

Allowable Values:

Format: yyyy-MM-ddThh:mm:ssZ

data[].document_policy_detail.summary_of_credit_terms.template_token

string
Conditionally returned

Unique identifier of the template, which is the version of a document that serves as an initial disclosure but does not contain finalized values. Values are finalized in the asset version of the document.

Allowable Values:

Existing template token for the SOCT or Rewards Disclosure

data[].document_policy_detail.summary_of_credit_terms.template_urls

object
Conditionally returned

Contains one or more URLs for a template.

Allowable Values:

One or more template_urls objects

data[].document_policy_detail.summary_of_credit_terms.template_urls.html

string
Returned

URL to the HTML version of the document template.

Allowable Values:

A valid URL

data[].document_policy_detail.summary_of_credit_terms.template_created_time

datetime
Conditionally returned

Date and time when the template was created.

Allowable Values:

Format: yyyy-MM-ddThh:mm:ssZ

data[].document_policy_detail.rewards_disclosure

object
Conditionally returned

Contains information on the Rewards Disclosure, which is a pre- and post-application disclosure that provides details about the rewards program for a bundle.

Allowable Values:

Existing rewards_disclosure object

data[].document_policy_detail.rewards_disclosure.asset_token

string
Conditionally returned

Unique identifier of the asset, which is the version of a document that is based on the template and contains finalized values. The values are finalized when the bundle containing the document is created.

Allowable Values:

Existing asset token for the SOCT or Rewards Disclosure

data[].document_policy_detail.rewards_disclosure.asset_urls

object
Conditionally returned

Contains one or more URLs for an asset.

Allowable Values:

One or more asset_urls objects

data[].document_policy_detail.rewards_disclosure.asset_urls.pdf

string
Returned

URL to the PDF version of the asset.

Allowable Values:

A valid URL

data[].document_policy_detail.rewards_disclosure.asset_urls.png

string
Returned

URL to the PNG version of the asset.

Allowable Values:

A valid URL

data[].document_policy_detail.rewards_disclosure.asset_urls.html

string
Returned

URL to the HTML version of the asset.

Allowable Values:

A valid URL

data[].document_policy_detail.rewards_disclosure.asset_created_time

datetime
Conditionally returned

Date and time when the asset was created.

Allowable Values:

Format: yyyy-MM-ddThh:mm:ssZ

data[].document_policy_detail.rewards_disclosure.template_token

string
Conditionally returned

Unique identifier of the template, which is the version of a document that serves as an initial disclosure but does not contain finalized values. Values are finalized in the asset version of the document.

Allowable Values:

Existing template token for the SOCT or Rewards Disclosure

data[].document_policy_detail.rewards_disclosure.template_urls

object
Conditionally returned

Contains one or more URLs for a template.

Allowable Values:

One or more template_urls objects

data[].document_policy_detail.rewards_disclosure.template_urls.html

string
Returned

URL to the HTML version of the document template.

Allowable Values:

A valid URL

data[].document_policy_detail.rewards_disclosure.template_created_time

datetime
Conditionally returned

Date and time when the template was created.

Allowable Values:

Format: yyyy-MM-ddThh:mm:ssZ

data[].document_policy_detail.terms_schedule

object
Conditionally returned

Contains information on the Terms Schedule, which is a post-application disclosure that contains the terms of credit for an account, including the interest rate details.

Allowable Values:

Existing terms_schedule object

data[].document_policy_detail.terms_schedule.template_token

string
Conditionally returned

Unique identifier of a template, which is a document that serves as an initial disclosure but does not contain finalized values.

Allowable Values:

Existing template token for the Terms Schedule, Account Statement, or NOAA

data[].document_policy_detail.terms_schedule.template_urls

object
Conditionally returned

Contains one or more URLs for a template.

Allowable Values:

One or more template_urls objects

data[].document_policy_detail.terms_schedule.template_urls.html

string
Returned

URL to the HTML version of the document template.

Allowable Values:

A valid URL

data[].document_policy_detail.terms_schedule.template_created_time

datetime
Conditionally returned

Date and time when the template was created.

Allowable Values:

Format: yyyy-MM-ddThh:mm:ssZ

data[].document_policy_detail.benefits_disclosure_traditional

object
Conditionally returned

Contains information on the Benefits Disclosure (Traditional), which is a post-application disclosure that outlines the network benefits of a traditional Mastercard or Visa card.

Allowable Values:

Existing benefits_disclosure_traditional object

data[].document_policy_detail.benefits_disclosure_traditional.asset_token

string
Conditionally returned

Unique identifier of the asset, which is a type of document that contains finalized values. The values are finalized when the bundle containing the document is created.

Allowable Values:

Existing asset token for the Benefits Disclosure (Traditional), Benefits Disclosure (Premium), Privacy Policy, eDisclosure, or Card Member Agreement

data[].document_policy_detail.benefits_disclosure_traditional.asset_urls

object
Conditionally returned

Contains one or more URLs for an asset.

Allowable Values:

One or more asset_urls objects

data[].document_policy_detail.benefits_disclosure_traditional.asset_urls.pdf

string
Returned

URL to the PDF version of the asset.

Allowable Values:

A valid URL

data[].document_policy_detail.benefits_disclosure_traditional.asset_urls.png

string
Returned

URL to the PNG version of the asset.

Allowable Values:

A valid URL

data[].document_policy_detail.benefits_disclosure_traditional.asset_urls.html

string
Returned

URL to the HTML version of the asset.

Allowable Values:

A valid URL

data[].document_policy_detail.benefits_disclosure_traditional.asset_created_time

datetime
Conditionally returned

Date and time when the asset was created.

Allowable Values:

Format: yyyy-MM-ddThh:mm:ssZ

data[].document_policy_detail.benefits_disclosure_premium

object
Conditionally returned

Contains information on the Benefits Disclosure (Premium), which is a post-application disclosure that outlines the network benefits of a Mastercard World or Visa Signature card.

Allowable Values:

Existing benefits_disclosure_premium object

data[].document_policy_detail.benefits_disclosure_premium.asset_token

string
Conditionally returned

Unique identifier of the asset, which is a type of document that contains finalized values. The values are finalized when the bundle containing the document is created.

Allowable Values:

Existing asset token for the Benefits Disclosure (Traditional), Benefits Disclosure (Premium), Privacy Policy, eDisclosure, or Card Member Agreement

data[].document_policy_detail.benefits_disclosure_premium.asset_urls

object
Conditionally returned

Contains one or more URLs for an asset.

Allowable Values:

One or more asset_urls objects

data[].document_policy_detail.benefits_disclosure_premium.asset_urls.pdf

string
Returned

URL to the PDF version of the asset.

Allowable Values:

A valid URL

data[].document_policy_detail.benefits_disclosure_premium.asset_urls.png

string
Returned

URL to the PNG version of the asset.

Allowable Values:

A valid URL

data[].document_policy_detail.benefits_disclosure_premium.asset_urls.html

string
Returned

URL to the HTML version of the asset.

Allowable Values:

A valid URL

data[].document_policy_detail.benefits_disclosure_premium.asset_created_time

datetime
Conditionally returned

Date and time when the asset was created.

Allowable Values:

Format: yyyy-MM-ddThh:mm:ssZ

data[].document_policy_detail.privacy_policy

object
Conditionally returned

Contains information on the Privacy Policy, which is a pre-application disclosure that explains how an applicant’s data is used and managed.

Allowable Values:

Existing privacy_policy object

data[].document_policy_detail.privacy_policy.asset_token

string
Conditionally returned

Unique identifier of the asset, which is a type of document that contains finalized values. The values are finalized when the bundle containing the document is created.

Allowable Values:

Existing asset token for the Benefits Disclosure (Traditional), Benefits Disclosure (Premium), Privacy Policy, eDisclosure, or Card Member Agreement

data[].document_policy_detail.privacy_policy.asset_urls

object
Conditionally returned

Contains one or more URLs for an asset.

Allowable Values:

One or more asset_urls objects

data[].document_policy_detail.privacy_policy.asset_urls.pdf

string
Returned

URL to the PDF version of the asset.

Allowable Values:

A valid URL

data[].document_policy_detail.privacy_policy.asset_urls.png

string
Returned

URL to the PNG version of the asset.

Allowable Values:

A valid URL

data[].document_policy_detail.privacy_policy.asset_urls.html

string
Returned

URL to the HTML version of the asset.

Allowable Values:

A valid URL

data[].document_policy_detail.privacy_policy.asset_created_time

datetime
Conditionally returned

Date and time when the asset was created.

Allowable Values:

Format: yyyy-MM-ddThh:mm:ssZ

data[].document_policy_detail.e_disclosure

object
Conditionally returned

Contains information on the eDisclosure, which is a pre-application disclosure that states that users are to receive their disclosures electronically.

Allowable Values:

Existing e_disclosure object

data[].document_policy_detail.e_disclosure.asset_token

string
Conditionally returned

Unique identifier of the asset, which is a type of document that contains finalized values. The values are finalized when the bundle containing the document is created.

Allowable Values:

Existing asset token for the Benefits Disclosure (Traditional), Benefits Disclosure (Premium), Privacy Policy, eDisclosure, or Card Member Agreement

data[].document_policy_detail.e_disclosure.asset_urls

object
Conditionally returned

Contains one or more URLs for an asset.

Allowable Values:

One or more asset_urls objects

data[].document_policy_detail.e_disclosure.asset_urls.pdf

string
Returned

URL to the PDF version of the asset.

Allowable Values:

A valid URL

data[].document_policy_detail.e_disclosure.asset_urls.png

string
Returned

URL to the PNG version of the asset.

Allowable Values:

A valid URL

data[].document_policy_detail.e_disclosure.asset_urls.html

string
Returned

URL to the HTML version of the asset.

Allowable Values:

A valid URL

data[].document_policy_detail.e_disclosure.asset_created_time

datetime
Conditionally returned

Date and time when the asset was created.

Allowable Values:

Format: yyyy-MM-ddThh:mm:ssZ

data[].document_policy_detail.card_member_agreement

object
Conditionally returned

Contains information on the Card Member Agreement, which is a post-application disclosure that specifies the terms and conditions of an account, including the interest rates, interest charges, fees, minimum payment calculations, and more.

Allowable Values:

Existing card_member_agreement object

data[].document_policy_detail.card_member_agreement.asset_token

string
Conditionally returned

Unique identifier of the asset, which is a type of document that contains finalized values. The values are finalized when the bundle containing the document is created.

Allowable Values:

Existing asset token for the Benefits Disclosure (Traditional), Benefits Disclosure (Premium), Privacy Policy, eDisclosure, or Card Member Agreement

data[].document_policy_detail.card_member_agreement.asset_urls

object
Conditionally returned

Contains one or more URLs for an asset.

Allowable Values:

One or more asset_urls objects

data[].document_policy_detail.card_member_agreement.asset_urls.pdf

string
Returned

URL to the PDF version of the asset.

Allowable Values:

A valid URL

data[].document_policy_detail.card_member_agreement.asset_urls.png

string
Returned

URL to the PNG version of the asset.

Allowable Values:

A valid URL

data[].document_policy_detail.card_member_agreement.asset_urls.html

string
Returned

URL to the HTML version of the asset.

Allowable Values:

A valid URL

data[].document_policy_detail.card_member_agreement.asset_created_time

datetime
Conditionally returned

Date and time when the asset was created.

Allowable Values:

Format: yyyy-MM-ddThh:mm:ssZ

data[].document_policy_detail.account_statement

object
Conditionally returned

Contains information on the Account Statement, which outlines the information that appears on the statements generated for a credit account.

Allowable Values:

Existing account_statement object

data[].document_policy_detail.account_statement.template_token

string
Conditionally returned

Unique identifier of a template, which is a document that serves as an initial disclosure but does not contain finalized values.

Allowable Values:

Existing template token for the Terms Schedule, Account Statement, or NOAA

data[].document_policy_detail.account_statement.template_urls

object
Conditionally returned

Contains one or more URLs for a template.

Allowable Values:

One or more template_urls objects

data[].document_policy_detail.account_statement.template_urls.html

string
Returned

URL to the HTML version of the document template.

Allowable Values:

A valid URL

data[].document_policy_detail.account_statement.template_created_time

datetime
Conditionally returned

Date and time when the template was created.

Allowable Values:

Format: yyyy-MM-ddThh:mm:ssZ

data[].document_policy_detail.noaa_single_reason

object
Conditionally returned

Contains information on the Notice of Adverse Action (NOAA) used when an application is declined for single reason.

Allowable Values:

Existing noaa_single_reason object

data[].document_policy_detail.noaa_single_reason.template_token

string
Conditionally returned

Unique identifier of a template, which is a document that serves as an initial disclosure but does not contain finalized values.

Allowable Values:

Existing template token for the Terms Schedule, Account Statement, or NOAA

data[].document_policy_detail.noaa_single_reason.template_urls

object
Conditionally returned

Contains one or more URLs for a template.

Allowable Values:

One or more template_urls objects

data[].document_policy_detail.noaa_single_reason.template_urls.html

string
Returned

URL to the HTML version of the document template.

Allowable Values:

A valid URL

data[].document_policy_detail.noaa_single_reason.template_created_time

datetime
Conditionally returned

Date and time when the template was created.

Allowable Values:

Format: yyyy-MM-ddThh:mm:ssZ

data[].document_policy_detail.noaa_single_reason_with_dodd_frank

object
Conditionally returned

Contains information on the NOAA used when an application is declined for single reason related to the applicant’s credit score. This NOAA contains a Dodd-Frank section that discloses their credit score and the information related to that score that was used to decline their application.

Allowable Values:

Existing noaa_single_reason_with_dodd_frank object

data[].document_policy_detail.noaa_single_reason_with_dodd_frank.template_token

string
Conditionally returned

Unique identifier of a template, which is a document that serves as an initial disclosure but does not contain finalized values.

Allowable Values:

Existing template token for the Terms Schedule, Account Statement, or NOAA

data[].document_policy_detail.noaa_single_reason_with_dodd_frank.template_urls

object
Conditionally returned

Contains one or more URLs for a template.

Allowable Values:

One or more template_urls objects

data[].document_policy_detail.noaa_single_reason_with_dodd_frank.template_urls.html

string
Returned

URL to the HTML version of the document template.

Allowable Values:

A valid URL

data[].document_policy_detail.noaa_single_reason_with_dodd_frank.template_created_time

datetime
Conditionally returned

Date and time when the template was created.

Allowable Values:

Format: yyyy-MM-ddThh:mm:ssZ

data[].document_policy_detail.noaa_multiple_reason_with_dodd_frank

object
Conditionally returned

Contains information on the NOAA used when an application is declined for multiple reasons related to the applicant’s credit score. This NOAA contains a Dodd-Frank section that discloses their credit score and the information related to that score that was used to decline their application.

Allowable Values:

Existing noaa_multiple_reason_with_dodd_frank object

data[].document_policy_detail.noaa_multiple_reason_with_dodd_frank.template_token

string
Conditionally returned

Unique identifier of a template, which is a document that serves as an initial disclosure but does not contain finalized values.

Allowable Values:

Existing template token for the Terms Schedule, Account Statement, or NOAA

data[].document_policy_detail.noaa_multiple_reason_with_dodd_frank.template_urls

object
Conditionally returned

Contains one or more URLs for a template.

Allowable Values:

One or more template_urls objects

data[].document_policy_detail.noaa_multiple_reason_with_dodd_frank.template_urls.html

string
Returned

URL to the HTML version of the document template.

Allowable Values:

A valid URL

data[].document_policy_detail.noaa_multiple_reason_with_dodd_frank.template_created_time

datetime
Conditionally returned

Date and time when the template was created.

Allowable Values:

Format: yyyy-MM-ddThh:mm:ssZ

data[].document_policy_detail.created_time

datetime
Conditionally returned

Date and time when the document policy was created on Marqeta’s credit platform, in UTC.

Allowable Values:

Format: yyyy-MM-ddThh:mm:ssZ

data[].document_policy_detail.updated_time

datetime
Conditionally returned

Date and time when the document policy was last updated on Marqeta’s credit platform, in UTC.

Allowable Values:

Format: yyyy-MM-ddThh:mm:ssZ

data[].fee_policy_token

string
Conditionally returned

Unique identifier of the bundle’s fee policy.

Allowable Values:

36 char max

data[].fee_policy_detail

object
Conditionally returned

Contains information on a fee policy.

Allowable Values:

Existing fee_policy_detail object

data[].fee_policy_detail.token

string
Conditionally returned

Unique identifier of the fee policy.

Allowable Values:

36 char max

data[].fee_policy_detail.name

string
Conditionally returned

Name of the fee policy.

Allowable Values:

255 char max

data[].fee_policy_detail.description

string
Conditionally returned

Description of the fee policy.

Allowable Values:

255 char max

data[].fee_policy_detail.account

object
Conditionally returned

Contains information on the fee policy on a credit account.

Allowable Values:

Existing account object

data[].fee_policy_detail.account.late_payment

object
Conditionally returned

Contains information on the late payment fee.

Allowable Values:

Existing late_payment object

data[].fee_policy_detail.account.returned_payment

object
Conditionally returned

Contains information on the returned payment fee.

Allowable Values:

Existing returned_payment object

data[].fee_policy_detail.created_time

datetime
Conditionally returned

Date and time when the fee policy was created on Marqeta’s credit platform, in UTC.

Allowable Values:

Format: yyyy-MM-ddThh:mm:ssZ

data[].fee_policy_detail.updated_time

datetime
Conditionally returned

Date and time when the fee policy was last updated on Marqeta’s credit platform, in UTC.

Allowable Values:

Format: yyyy-MM-ddThh:mm:ssZ

data[].reward_policy_token

string
Conditionally returned

Unique identifier of the bundle’s reward policy.

Allowable Values:

36 char max

data[].reward_policy_detail

object
Conditionally returned

Contains information on a reward policy.

Allowable Values:

Existing reward_policy_detail object

data[].reward_policy_detail.token

string
Conditionally returned

Unique identifier of the reward policy.

Allowable Values:

36 char max

data[].reward_policy_detail.name

string
Conditionally returned

Name of the reward policy.

Allowable Values:

255 char max

data[].reward_policy_detail.description

string
Conditionally returned

Description of the reward policy.

Allowable Values:

255 char max

data[].reward_policy_detail.rules

array of objects
Conditionally returned

One or more reward rules

Allowable Values:

One or more rules objects

data[].reward_policy_detail.rules[].type

string
Returned

Type of reward rule.

Allowable Values:

CASHBACK

data[].reward_policy_detail.rules[].filters

object
Returned

Contains information on the rules defined for a reward program.

Allowable Values:

Existing filters object

data[].reward_policy_detail.rules[].filters.amount

object
Returned

Contains information on the minimum and maximum amounts that the balance for a billing cycle can be to earn the reward.

Allowable Values:

Existing amount object

data[].reward_policy_detail.rules[].filters.amount.greater_than

decimal
Conditionally returned

The minimum amount that a balance for a billing cycle can be to earn the reward.

Allowable Values:

0 min

data[].reward_policy_detail.rules[].filters.amount.less_than

decimal
Conditionally returned

The maximum amount that a balance for a billing cycle can be to earn the reward.

Allowable Values:

0 min

data[].reward_policy_detail.rules[].filters.mcc_dynamic

object
Conditionally returned

Contains information on the dynamic merchant category code (MCC) for a reward.

Allowable Values:

Existing mcc_dynamic object

data[].reward_policy_detail.rules[].filters.mcc_dynamic.includes

array of strings
Returned

One or more dynamic MCCs.

Allowable Values:

HIGHEST_SPEND

data[].reward_policy_detail.rules[].outcome

object
Returned

Contains information on the outcome of a reward rule.

Allowable Values:

Existing outcome object

data[].reward_policy_detail.rules[].outcome.percentage

decimal
Returned

The reward percentage applied when the balance for a billing cycle is within the range specified in the filters.amount.greater_than and filters.amount.less_than fields. For example, if the percentage is 1, the account holder earns 1% of the account balance if they spend between the greater_than and less_than amounts during a billing cycle.

Allowable Values:

0 min

data[].reward_policy_detail.rules[].outcome.max_amount

decimal
Conditionally returned

Max amount of the reward.

Allowable Values:

0 min

data[].reward_policy_detail.created_time

datetime
Conditionally returned

Date and time when the reward policy was created on Marqeta’s credit platform, in UTC.

Allowable Values:

Format: yyyy-MM-ddThh:mm:ssZ

data[].reward_policy_detail.updated_time

datetime
Conditionally returned

Date and time when the reward policy was last updated on Marqeta’s credit platform, in UTC.

Allowable Values:

Format: yyyy-MM-ddThh:mm:ssZ

data[].offer_policy_token

string
Conditionally returned

Unique identifier of the bundle’s offer policy.

Allowable Values:

36 char max

data[].offer_policy_detail

object
Conditionally returned

Contains information on an offer policy.

Allowable Values:

Existing offer_policy_detail object

data[].offer_policy_detail.token

string
Conditionally returned

Unique identifier of the offer policy.

Allowable Values:

36 char max

data[].offer_policy_detail.name

string
Conditionally returned

Name of the offer policy.

Allowable Values:

255 char max

data[].offer_policy_detail.description

string
Conditionally returned

Description of the offer policy.

Allowable Values:

255 char max

data[].offer_policy_detail.created_time

datetime
Conditionally returned

Date and time when the offer policy was created on Marqeta’s credit platform, in UTC.

Allowable Values:

Format: yyyy-MM-ddThh:mm:ssZ

data[].offer_policy_detail.updated_time

datetime
Conditionally returned

Date and time when the offer policy was last updated on Marqeta’s credit platform, in UTC.

Allowable Values:

Format: yyyy-MM-ddThh:mm:ssZ

data[].created_time

datetime
Conditionally returned

Date and time when the bundle 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 bundle was last updated on Marqeta’s credit platform, in UTC.

Allowable Values:

Format: yyyy-MM-ddThh:mm:ssZ

Sample response body

JSON
Copied

Is this helpful?

Yes
No

Retrieve bundle

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

Retrieve a specific bundle.

URL path parameters

Fields Description

token

string
Required

The unique identifier of the bundle to retrieve.

Send a GET request to /credit/bundles to retrieve existing tokens.

Allowable Values:

Existing bundle token

URL query parameters

Fields Description

expand_objects

array of strings
Optional

Embeds the associated object of the specified type into the response. For more, see object expansion.

Allowable Values:

APR, DOCUMENT, FEE, OFFER, PRODUCT, REWARD, ALL

Response body

Fields Description

token

string
Conditionally returned

Unique identifier of the bundle.

Allowable Values:

36 char max

name

string
Conditionally returned

Name of the bundle.

Allowable Values:

255 char max

status

string
Conditionally returned

Status of the bundle.

  • DRAFT - The bundle is in the process of being created.

  • PENDING_APPROVAL - The bundle has been created and is awaiting approval.

  • SENT_FOR_REVISION - The bundle has been returned for revision.

  • ACTIVE - The bundle is active.

  • REJECTED - The bundle has been rejected; this status cannot be changed.

  • ARCHIVED - The previously active bundle has been archived.

  • APPROVED - The bundle has been approved (after having been sent for approval).

Allowable Values:

DRAFT, PENDING_APPROVAL, SENT_FOR_REVISION, ACTIVE, REJECTED, ARCHIVED, APPROVED

description

string
Conditionally returned

Description of the bundle.

Allowable Values:

255 char max

credit_product_policy_token

string
Conditionally returned

Unique identifier of the bundle’s credit product policy.

Allowable Values:

36 char max

credit_product_policy_detail

object
Conditionally returned

Contains information on the credit product policy.

Allowable Values:

Existing credit_product_policy_detail object

credit_product_policy_detail.token

string
Conditionally returned

Unique identifier of the credit product policy.

Allowable Values:

36 char max

credit_product_policy_detail.card_products

array of objects
Conditionally returned

One or more card products associated with the credit product policy.

Allowable Values:

One or more card_products objects

credit_product_policy_detail.card_products[].token

string
Conditionally returned

Unique identifier of the card product.

Allowable Values:

36 char max

credit_product_policy_detail.card_products[].level

string
Conditionally returned

Level of the card product.

Allowable Values:

PREMIUM, TRADITIONAL

credit_product_policy_detail.card_products[].network

string
Conditionally returned

Name of the card network.

Allowable Values:

VISA, MASTERCARD, SANDBOX

credit_product_policy_detail.name

string
Conditionally returned

Name of the credit product policy.

Allowable Values:

1 char min

credit_product_policy_detail.description

string
Conditionally returned

Description of the credit product policy.

Allowable Values:

255 char max

credit_product_policy_detail.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

credit_product_policy_detail.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

credit_product_policy_detail.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

credit_product_policy_detail.currency_code

string
Conditionally returned

A valid three-digit ISO 4217 currency code

Allowable Values:

USD

credit_product_policy_detail.credit_line

object
Conditionally returned

Contains information on the credit line range.

Allowable Values:

Existing credit_line object

credit_product_policy_detail.credit_line.min

decimal
Returned

Minimum credit limit.

Allowable Values:

0–999999999999.99

credit_product_policy_detail.credit_line.max

decimal
Returned

Maximum credit limit.

Allowable Values:

0–999999999999.99

credit_product_policy_detail.usage

array of strings
Conditionally returned

One or more usage types for the credit product policy.

Allowable Values:

PURCHASE

Valid usage array

credit_product_policy_detail.interest_calculation

object
Conditionally returned

Contains the configurations for interest calculation.

Allowable Values:

Existing interest_calculation object

credit_product_policy_detail.interest_calculation.method

string
Returned

Method of interest calculation.

Allowable Values:

AVG_DAILY_BALANCE_WITH_NEW_TRANSACTIONS

credit_product_policy_detail.interest_calculation.day_count

string
Returned

Day-count convention.

Allowable Values:

ACTUAL

credit_product_policy_detail.interest_calculation.interest_application

array of strings
Returned

One or more balance types on which interest is applied.

Allowable Values:

PRINCIPAL, FEES, INTEREST

credit_product_policy_detail.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

credit_product_policy_detail.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

credit_product_policy_detail.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

credit_product_policy_detail.interest_calculation.application_of_credits

object
Returned

Contains information on the cycle type and billing cycle day when credits are applied in the daily balance calculation.

Allowable Values:

Existing application_of_credits object

credit_product_policy_detail.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 the balance is paid off each month.

Allowable Values:

BEGINNING_REVOLVING, REVOLVING, END_REVOLVING, TRANSACTING

When creating or updating an account, only TRANSACTING is allowed.

credit_product_policy_detail.interest_calculation.application_of_credits.day

integer
Returned

Day of the billing cycle when credits are applied.

Allowable Values:

1–31

credit_product_policy_detail.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

credit_product_policy_detail.payments

object
Conditionally returned

Contains the configurations for billing cycle day, payment due day, and fees.

Allowable Values:

Existing payments object

credit_product_policy_detail.payments.billing_cycle_day

integer
Returned

Day of month the billing cycle starts.

Allowable Values:

1

credit_product_policy_detail.payments.due_day

integer
Returned

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

Allowable Values:

31

credit_product_policy_detail.payments.allocation_order

array of strings
Returned

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

Allowable Values:

INTEREST, FEES, PRINCIPAL

credit_product_policy_detail.payments.min_payment_calculation

object
Returned

Contains information used to calculate the minimum payment amount on a credit product policy.

Allowable Values:

Existing min_payment_calculation object

credit_product_policy_detail.payments.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

credit_product_policy_detail.payments.min_payment_calculation.include_overlimit_amount

boolean
Returned

Whether to include the overlimit amount when calculating the minimum payment.

Allowable Values:

true, false

credit_product_policy_detail.payments.min_payment_calculation.min_payment_flat_amount

decimal
Conditionally returned

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

Allowable Values:

Format: 0.00

credit_product_policy_detail.payments.min_payment_calculation.min_payment_percentage

object
Conditionally returned

Contains information used to calculate the minimum payment amount when expressed as a percentage.

Allowable Values:

Existing min_payment_percentage object

credit_product_policy_detail.payments.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

credit_product_policy_detail.payments.min_payment_calculation.min_payment_percentage.include_interest_charged

boolean
Returned

Whether to include the amount of interest charged when calculating the minimum payment.

Allowable Values:

true, false

credit_product_policy_detail.payments.min_payment_calculation.min_payment_percentage.include_fees_charged

array of strings
Conditionally returned

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

Allowable Values:

LATE_PAYMENT_FEE, RETURNED_PAYMENT_FEE

credit_product_policy_detail.created_time

datetime
Conditionally returned

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

Allowable Values:

Format: yyyy-MM-ddThh:mm:ssZ

credit_product_policy_detail.updated_time

datetime
Conditionally returned

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

Allowable Values:

Format: yyyy-MM-ddThh:mm:ssZ

apr_policy_token

string
Conditionally returned

Unique identifier of the bundle’s APR policy.

Allowable Values:

36 char max

apr_policy_detail

object
Conditionally returned

Contains information on an APR policy.

Allowable Values:

Existing apr_policy_detail object

apr_policy_detail.token

string
Conditionally returned

Unique identifier of the APR policy.

Allowable Values:

36 char max

apr_policy_detail.name

string
Conditionally returned

Name of the APR policy.

Allowable Values:

255 char max

apr_policy_detail.description

string
Conditionally returned

Description of the APR policy.

Allowable Values:

255 char max

apr_policy_detail.purchases

object
Conditionally returned

Contains information on the pricing strategy for purchases.

Allowable Values:

Existing purchases object

apr_policy_detail.purchases.name

string
Conditionally returned

Name of the pricing strategy.

Allowable Values:

255 char max

apr_policy_detail.purchases.external_token

string
Conditionally returned

Unique identifier of the pricing strategy on a credit program.

Allowable Values:

36 char max

apr_policy_detail.purchases.tiers

array of objects
Conditionally returned

One or more risk tiers for a pricing strategy.

Allowable Values:

One or more tiers objects

apr_policy_detail.purchases.tiers[].margin_rate

decimal
Conditionally returned

Margin rate for the risk tier for a pricing strategy.

Allowable Values:

Format: 0.00

apr_policy_detail.purchases.tiers[].apr

decimal
Conditionally returned

The value of the APR.

Allowable Values:

Format: 0.00

apr_policy_detail.effective_date

date
Conditionally returned

Date the APR goes into effect, in UTC.

Allowable Values:

Format: yyyy-MM-dd

apr_policy_detail.created_time

datetime
Conditionally returned

Date and time when the APR policy was created on Marqeta’s credit platform, in UTC.

Allowable Values:

Format: yyyy-MM-ddThh:mm:ssZ

apr_policy_detail.updated_time

datetime
Conditionally returned

Date and time when the APR policy was last updated on Marqeta’s credit platform, in UTC.

Allowable Values:

Format: yyyy-MM-ddThh:mm:ssZ

document_policy_token

string
Conditionally returned

Unique identifier of the bundle’s document policy.

Allowable Values:

36 char max

document_policy_detail

object
Conditionally returned

Contains information on a document policy.

Allowable Values:

Existing document_policy_detail object

document_policy_detail.token

string
Conditionally returned

Unique identifier of the document policy.

Allowable Values:

36 char max

document_policy_detail.name

string
Conditionally returned

Name of the document policy.

Allowable Values:

255 char max

document_policy_detail.summary_of_credit_terms

object
Conditionally returned

Contains information on the Summary of Credit Terms (SOCT), which is a pre- and post-application disclosure that outlines the terms of an account, such as the interest rates, interest charges, associated fees, and more.

Allowable Values:

Existing summary_of_credit_terms object

document_policy_detail.summary_of_credit_terms.asset_token

string
Conditionally returned

Unique identifier of the asset, which is the version of a document that is based on the template and contains finalized values. The values are finalized when the bundle containing the document is created.

Allowable Values:

Existing asset token for the SOCT or Rewards Disclosure

document_policy_detail.summary_of_credit_terms.asset_urls

object
Conditionally returned

Contains one or more URLs for an asset.

Allowable Values:

One or more asset_urls objects

document_policy_detail.summary_of_credit_terms.asset_urls.pdf

string
Returned

URL to the PDF version of the asset.

Allowable Values:

A valid URL

document_policy_detail.summary_of_credit_terms.asset_urls.png

string
Returned

URL to the PNG version of the asset.

Allowable Values:

A valid URL

document_policy_detail.summary_of_credit_terms.asset_urls.html

string
Returned

URL to the HTML version of the asset.

Allowable Values:

A valid URL

document_policy_detail.summary_of_credit_terms.asset_created_time

datetime
Conditionally returned

Date and time when the asset was created.

Allowable Values:

Format: yyyy-MM-ddThh:mm:ssZ

document_policy_detail.summary_of_credit_terms.template_token

string
Conditionally returned

Unique identifier of the template, which is the version of a document that serves as an initial disclosure but does not contain finalized values. Values are finalized in the asset version of the document.

Allowable Values:

Existing template token for the SOCT or Rewards Disclosure

document_policy_detail.summary_of_credit_terms.template_urls

object
Conditionally returned

Contains one or more URLs for a template.

Allowable Values:

One or more template_urls objects

document_policy_detail.summary_of_credit_terms.template_urls.html

string
Returned

URL to the HTML version of the document template.

Allowable Values:

A valid URL

document_policy_detail.summary_of_credit_terms.template_created_time

datetime
Conditionally returned

Date and time when the template was created.

Allowable Values:

Format: yyyy-MM-ddThh:mm:ssZ

document_policy_detail.rewards_disclosure

object
Conditionally returned

Contains information on the Rewards Disclosure, which is a pre- and post-application disclosure that provides details about the rewards program for a bundle.

Allowable Values:

Existing rewards_disclosure object

document_policy_detail.rewards_disclosure.asset_token

string
Conditionally returned

Unique identifier of the asset, which is the version of a document that is based on the template and contains finalized values. The values are finalized when the bundle containing the document is created.

Allowable Values:

Existing asset token for the SOCT or Rewards Disclosure

document_policy_detail.rewards_disclosure.asset_urls

object
Conditionally returned

Contains one or more URLs for an asset.

Allowable Values:

One or more asset_urls objects

document_policy_detail.rewards_disclosure.asset_urls.pdf

string
Returned

URL to the PDF version of the asset.

Allowable Values:

A valid URL

document_policy_detail.rewards_disclosure.asset_urls.png

string
Returned

URL to the PNG version of the asset.

Allowable Values:

A valid URL

document_policy_detail.rewards_disclosure.asset_urls.html

string
Returned

URL to the HTML version of the asset.

Allowable Values:

A valid URL

document_policy_detail.rewards_disclosure.asset_created_time

datetime
Conditionally returned

Date and time when the asset was created.

Allowable Values:

Format: yyyy-MM-ddThh:mm:ssZ

document_policy_detail.rewards_disclosure.template_token

string
Conditionally returned

Unique identifier of the template, which is the version of a document that serves as an initial disclosure but does not contain finalized values. Values are finalized in the asset version of the document.

Allowable Values:

Existing template token for the SOCT or Rewards Disclosure

document_policy_detail.rewards_disclosure.template_urls

object
Conditionally returned

Contains one or more URLs for a template.

Allowable Values:

One or more template_urls objects

document_policy_detail.rewards_disclosure.template_urls.html

string
Returned

URL to the HTML version of the document template.

Allowable Values:

A valid URL

document_policy_detail.rewards_disclosure.template_created_time

datetime
Conditionally returned

Date and time when the template was created.

Allowable Values:

Format: yyyy-MM-ddThh:mm:ssZ

document_policy_detail.terms_schedule

object
Conditionally returned

Contains information on the Terms Schedule, which is a post-application disclosure that contains the terms of credit for an account, including the interest rate details.

Allowable Values:

Existing terms_schedule object

document_policy_detail.terms_schedule.template_token

string
Conditionally returned

Unique identifier of a template, which is a document that serves as an initial disclosure but does not contain finalized values.

Allowable Values:

Existing template token for the Terms Schedule, Account Statement, or NOAA

document_policy_detail.terms_schedule.template_urls

object
Conditionally returned

Contains one or more URLs for a template.

Allowable Values:

One or more template_urls objects

document_policy_detail.terms_schedule.template_urls.html

string
Returned

URL to the HTML version of the document template.

Allowable Values:

A valid URL

document_policy_detail.terms_schedule.template_created_time

datetime
Conditionally returned

Date and time when the template was created.

Allowable Values:

Format: yyyy-MM-ddThh:mm:ssZ

document_policy_detail.benefits_disclosure_traditional

object
Conditionally returned

Contains information on the Benefits Disclosure (Traditional), which is a post-application disclosure that outlines the network benefits of a traditional Mastercard or Visa card.

Allowable Values:

Existing benefits_disclosure_traditional object

document_policy_detail.benefits_disclosure_traditional.asset_token

string
Conditionally returned

Unique identifier of the asset, which is a type of document that contains finalized values. The values are finalized when the bundle containing the document is created.

Allowable Values:

Existing asset token for the Benefits Disclosure (Traditional), Benefits Disclosure (Premium), Privacy Policy, eDisclosure, or Card Member Agreement

document_policy_detail.benefits_disclosure_traditional.asset_urls

object
Conditionally returned

Contains one or more URLs for an asset.

Allowable Values:

One or more asset_urls objects

document_policy_detail.benefits_disclosure_traditional.asset_urls.pdf

string
Returned

URL to the PDF version of the asset.

Allowable Values:

A valid URL

document_policy_detail.benefits_disclosure_traditional.asset_urls.png

string
Returned

URL to the PNG version of the asset.

Allowable Values:

A valid URL

document_policy_detail.benefits_disclosure_traditional.asset_urls.html

string
Returned

URL to the HTML version of the asset.

Allowable Values:

A valid URL

document_policy_detail.benefits_disclosure_traditional.asset_created_time

datetime
Conditionally returned

Date and time when the asset was created.

Allowable Values:

Format: yyyy-MM-ddThh:mm:ssZ

document_policy_detail.benefits_disclosure_premium

object
Conditionally returned

Contains information on the Benefits Disclosure (Premium), which is a post-application disclosure that outlines the network benefits of a Mastercard World or Visa Signature card.

Allowable Values:

Existing benefits_disclosure_premium object

document_policy_detail.benefits_disclosure_premium.asset_token

string
Conditionally returned

Unique identifier of the asset, which is a type of document that contains finalized values. The values are finalized when the bundle containing the document is created.

Allowable Values:

Existing asset token for the Benefits Disclosure (Traditional), Benefits Disclosure (Premium), Privacy Policy, eDisclosure, or Card Member Agreement

document_policy_detail.benefits_disclosure_premium.asset_urls

object
Conditionally returned

Contains one or more URLs for an asset.

Allowable Values:

One or more asset_urls objects

document_policy_detail.benefits_disclosure_premium.asset_urls.pdf

string
Returned

URL to the PDF version of the asset.

Allowable Values:

A valid URL

document_policy_detail.benefits_disclosure_premium.asset_urls.png

string
Returned

URL to the PNG version of the asset.

Allowable Values:

A valid URL

document_policy_detail.benefits_disclosure_premium.asset_urls.html

string
Returned

URL to the HTML version of the asset.

Allowable Values:

A valid URL

document_policy_detail.benefits_disclosure_premium.asset_created_time

datetime
Conditionally returned

Date and time when the asset was created.

Allowable Values:

Format: yyyy-MM-ddThh:mm:ssZ

document_policy_detail.privacy_policy

object
Conditionally returned

Contains information on the Privacy Policy, which is a pre-application disclosure that explains how an applicant’s data is used and managed.

Allowable Values:

Existing privacy_policy object

document_policy_detail.privacy_policy.asset_token

string
Conditionally returned

Unique identifier of the asset, which is a type of document that contains finalized values. The values are finalized when the bundle containing the document is created.

Allowable Values:

Existing asset token for the Benefits Disclosure (Traditional), Benefits Disclosure (Premium), Privacy Policy, eDisclosure, or Card Member Agreement

document_policy_detail.privacy_policy.asset_urls

object
Conditionally returned

Contains one or more URLs for an asset.

Allowable Values:

One or more asset_urls objects

document_policy_detail.privacy_policy.asset_urls.pdf

string
Returned

URL to the PDF version of the asset.

Allowable Values:

A valid URL

document_policy_detail.privacy_policy.asset_urls.png

string
Returned

URL to the PNG version of the asset.

Allowable Values:

A valid URL

document_policy_detail.privacy_policy.asset_urls.html

string
Returned

URL to the HTML version of the asset.

Allowable Values:

A valid URL

document_policy_detail.privacy_policy.asset_created_time

datetime
Conditionally returned

Date and time when the asset was created.

Allowable Values:

Format: yyyy-MM-ddThh:mm:ssZ

document_policy_detail.e_disclosure

object
Conditionally returned

Contains information on the eDisclosure, which is a pre-application disclosure that states that users are to receive their disclosures electronically.

Allowable Values:

Existing e_disclosure object

document_policy_detail.e_disclosure.asset_token

string
Conditionally returned

Unique identifier of the asset, which is a type of document that contains finalized values. The values are finalized when the bundle containing the document is created.

Allowable Values:

Existing asset token for the Benefits Disclosure (Traditional), Benefits Disclosure (Premium), Privacy Policy, eDisclosure, or Card Member Agreement

document_policy_detail.e_disclosure.asset_urls

object
Conditionally returned

Contains one or more URLs for an asset.

Allowable Values:

One or more asset_urls objects

document_policy_detail.e_disclosure.asset_urls.pdf

string
Returned

URL to the PDF version of the asset.

Allowable Values:

A valid URL

document_policy_detail.e_disclosure.asset_urls.png

string
Returned

URL to the PNG version of the asset.

Allowable Values:

A valid URL

document_policy_detail.e_disclosure.asset_urls.html

string
Returned

URL to the HTML version of the asset.

Allowable Values:

A valid URL

document_policy_detail.e_disclosure.asset_created_time

datetime
Conditionally returned

Date and time when the asset was created.

Allowable Values:

Format: yyyy-MM-ddThh:mm:ssZ

document_policy_detail.card_member_agreement

object
Conditionally returned

Contains information on the Card Member Agreement, which is a post-application disclosure that specifies the terms and conditions of an account, including the interest rates, interest charges, fees, minimum payment calculations, and more.

Allowable Values:

Existing card_member_agreement object

document_policy_detail.card_member_agreement.asset_token

string
Conditionally returned

Unique identifier of the asset, which is a type of document that contains finalized values. The values are finalized when the bundle containing the document is created.

Allowable Values:

Existing asset token for the Benefits Disclosure (Traditional), Benefits Disclosure (Premium), Privacy Policy, eDisclosure, or Card Member Agreement

document_policy_detail.card_member_agreement.asset_urls

object
Conditionally returned

Contains one or more URLs for an asset.

Allowable Values:

One or more asset_urls objects

document_policy_detail.card_member_agreement.asset_urls.pdf

string
Returned

URL to the PDF version of the asset.

Allowable Values:

A valid URL

document_policy_detail.card_member_agreement.asset_urls.png

string
Returned

URL to the PNG version of the asset.

Allowable Values:

A valid URL

document_policy_detail.card_member_agreement.asset_urls.html

string
Returned

URL to the HTML version of the asset.

Allowable Values:

A valid URL

document_policy_detail.card_member_agreement.asset_created_time

datetime
Conditionally returned

Date and time when the asset was created.

Allowable Values:

Format: yyyy-MM-ddThh:mm:ssZ

document_policy_detail.account_statement

object
Conditionally returned

Contains information on the Account Statement, which outlines the information that appears on the statements generated for a credit account.

Allowable Values:

Existing account_statement object

document_policy_detail.account_statement.template_token

string
Conditionally returned

Unique identifier of a template, which is a document that serves as an initial disclosure but does not contain finalized values.

Allowable Values:

Existing template token for the Terms Schedule, Account Statement, or NOAA

document_policy_detail.account_statement.template_urls

object
Conditionally returned

Contains one or more URLs for a template.

Allowable Values:

One or more template_urls objects

document_policy_detail.account_statement.template_urls.html

string
Returned

URL to the HTML version of the document template.

Allowable Values:

A valid URL

document_policy_detail.account_statement.template_created_time

datetime
Conditionally returned

Date and time when the template was created.

Allowable Values:

Format: yyyy-MM-ddThh:mm:ssZ

document_policy_detail.noaa_single_reason

object
Conditionally returned

Contains information on the Notice of Adverse Action (NOAA) used when an application is declined for single reason.

Allowable Values:

Existing noaa_single_reason object

document_policy_detail.noaa_single_reason.template_token

string
Conditionally returned

Unique identifier of a template, which is a document that serves as an initial disclosure but does not contain finalized values.

Allowable Values:

Existing template token for the Terms Schedule, Account Statement, or NOAA

document_policy_detail.noaa_single_reason.template_urls

object
Conditionally returned

Contains one or more URLs for a template.

Allowable Values:

One or more template_urls objects

document_policy_detail.noaa_single_reason.template_urls.html

string
Returned

URL to the HTML version of the document template.

Allowable Values:

A valid URL

document_policy_detail.noaa_single_reason.template_created_time

datetime
Conditionally returned

Date and time when the template was created.

Allowable Values:

Format: yyyy-MM-ddThh:mm:ssZ

document_policy_detail.noaa_single_reason_with_dodd_frank

object
Conditionally returned

Contains information on the NOAA used when an application is declined for single reason related to the applicant’s credit score. This NOAA contains a Dodd-Frank section that discloses their credit score and the information related to that score that was used to decline their application.

Allowable Values:

Existing noaa_single_reason_with_dodd_frank object

document_policy_detail.noaa_single_reason_with_dodd_frank.template_token

string
Conditionally returned

Unique identifier of a template, which is a document that serves as an initial disclosure but does not contain finalized values.

Allowable Values:

Existing template token for the Terms Schedule, Account Statement, or NOAA

document_policy_detail.noaa_single_reason_with_dodd_frank.template_urls

object
Conditionally returned

Contains one or more URLs for a template.

Allowable Values:

One or more template_urls objects

document_policy_detail.noaa_single_reason_with_dodd_frank.template_urls.html

string
Returned

URL to the HTML version of the document template.

Allowable Values:

A valid URL

document_policy_detail.noaa_single_reason_with_dodd_frank.template_created_time

datetime
Conditionally returned

Date and time when the template was created.

Allowable Values:

Format: yyyy-MM-ddThh:mm:ssZ

document_policy_detail.noaa_multiple_reason_with_dodd_frank

object
Conditionally returned

Contains information on the NOAA used when an application is declined for multiple reasons related to the applicant’s credit score. This NOAA contains a Dodd-Frank section that discloses their credit score and the information related to that score that was used to decline their application.

Allowable Values:

Existing noaa_multiple_reason_with_dodd_frank object

document_policy_detail.noaa_multiple_reason_with_dodd_frank.template_token

string
Conditionally returned

Unique identifier of a template, which is a document that serves as an initial disclosure but does not contain finalized values.

Allowable Values:

Existing template token for the Terms Schedule, Account Statement, or NOAA

document_policy_detail.noaa_multiple_reason_with_dodd_frank.template_urls

object
Conditionally returned

Contains one or more URLs for a template.

Allowable Values:

One or more template_urls objects

document_policy_detail.noaa_multiple_reason_with_dodd_frank.template_urls.html

string
Returned

URL to the HTML version of the document template.

Allowable Values:

A valid URL

document_policy_detail.noaa_multiple_reason_with_dodd_frank.template_created_time

datetime
Conditionally returned

Date and time when the template was created.

Allowable Values:

Format: yyyy-MM-ddThh:mm:ssZ

document_policy_detail.created_time

datetime
Conditionally returned

Date and time when the document policy was created on Marqeta’s credit platform, in UTC.

Allowable Values:

Format: yyyy-MM-ddThh:mm:ssZ

document_policy_detail.updated_time

datetime
Conditionally returned

Date and time when the document policy was last updated on Marqeta’s credit platform, in UTC.

Allowable Values:

Format: yyyy-MM-ddThh:mm:ssZ

fee_policy_token

string
Conditionally returned

Unique identifier of the bundle’s fee policy.

Allowable Values:

36 char max

fee_policy_detail

object
Conditionally returned

Contains information on a fee policy.

Allowable Values:

Existing fee_policy_detail object

fee_policy_detail.token

string
Conditionally returned

Unique identifier of the fee policy.

Allowable Values:

36 char max

fee_policy_detail.name

string
Conditionally returned

Name of the fee policy.

Allowable Values:

255 char max

fee_policy_detail.description

string
Conditionally returned

Description of the fee policy.

Allowable Values:

255 char max

fee_policy_detail.account

object
Conditionally returned

Contains information on the fee policy on a credit account.

Allowable Values:

Existing account object

fee_policy_detail.account.late_payment

object
Conditionally returned

Contains information on the late payment fee.

Allowable Values:

Existing late_payment object

fee_policy_detail.account.returned_payment

object
Conditionally returned

Contains information on the returned payment fee.

Allowable Values:

Existing returned_payment object

fee_policy_detail.created_time

datetime
Conditionally returned

Date and time when the fee policy was created on Marqeta’s credit platform, in UTC.

Allowable Values:

Format: yyyy-MM-ddThh:mm:ssZ

fee_policy_detail.updated_time

datetime
Conditionally returned

Date and time when the fee policy was last updated on Marqeta’s credit platform, in UTC.

Allowable Values:

Format: yyyy-MM-ddThh:mm:ssZ

reward_policy_token

string
Conditionally returned

Unique identifier of the bundle’s reward policy.

Allowable Values:

36 char max

reward_policy_detail

object
Conditionally returned

Contains information on a reward policy.

Allowable Values:

Existing reward_policy_detail object

reward_policy_detail.token

string
Conditionally returned

Unique identifier of the reward policy.

Allowable Values:

36 char max

reward_policy_detail.name

string
Conditionally returned

Name of the reward policy.

Allowable Values:

255 char max

reward_policy_detail.description

string
Conditionally returned

Description of the reward policy.

Allowable Values:

255 char max

reward_policy_detail.rules

array of objects
Conditionally returned

One or more reward rules

Allowable Values:

One or more rules objects

reward_policy_detail.rules[].type

string
Returned

Type of reward rule.

Allowable Values:

CASHBACK

reward_policy_detail.rules[].filters

object
Returned

Contains information on the rules defined for a reward program.

Allowable Values:

Existing filters object

reward_policy_detail.rules[].filters.amount

object
Returned

Contains information on the minimum and maximum amounts that the balance for a billing cycle can be to earn the reward.

Allowable Values:

Existing amount object

reward_policy_detail.rules[].filters.amount.greater_than

decimal
Conditionally returned

The minimum amount that a balance for a billing cycle can be to earn the reward.

Allowable Values:

0 min

reward_policy_detail.rules[].filters.amount.less_than

decimal
Conditionally returned

The maximum amount that a balance for a billing cycle can be to earn the reward.

Allowable Values:

0 min

reward_policy_detail.rules[].filters.mcc_dynamic

object
Conditionally returned

Contains information on the dynamic merchant category code (MCC) for a reward.

Allowable Values:

Existing mcc_dynamic object

reward_policy_detail.rules[].filters.mcc_dynamic.includes

array of strings
Returned

One or more dynamic MCCs.

Allowable Values:

HIGHEST_SPEND

reward_policy_detail.rules[].outcome

object
Returned

Contains information on the outcome of a reward rule.

Allowable Values:

Existing outcome object

reward_policy_detail.rules[].outcome.percentage

decimal
Returned

The reward percentage applied when the balance for a billing cycle is within the range specified in the filters.amount.greater_than and filters.amount.less_than fields. For example, if the percentage is 1, the account holder earns 1% of the account balance if they spend between the greater_than and less_than amounts during a billing cycle.

Allowable Values:

0 min

reward_policy_detail.rules[].outcome.max_amount

decimal
Conditionally returned

Max amount of the reward.

Allowable Values:

0 min

reward_policy_detail.created_time

datetime
Conditionally returned

Date and time when the reward policy was created on Marqeta’s credit platform, in UTC.

Allowable Values:

Format: yyyy-MM-ddThh:mm:ssZ

reward_policy_detail.updated_time

datetime
Conditionally returned

Date and time when the reward policy was last updated on Marqeta’s credit platform, in UTC.

Allowable Values:

Format: yyyy-MM-ddThh:mm:ssZ

offer_policy_token

string
Conditionally returned

Unique identifier of the bundle’s offer policy.

Allowable Values:

36 char max

offer_policy_detail

object
Conditionally returned

Contains information on an offer policy.

Allowable Values:

Existing offer_policy_detail object

offer_policy_detail.token

string
Conditionally returned

Unique identifier of the offer policy.

Allowable Values:

36 char max

offer_policy_detail.name

string
Conditionally returned

Name of the offer policy.

Allowable Values:

255 char max

offer_policy_detail.description

string
Conditionally returned

Description of the offer policy.

Allowable Values:

255 char max

offer_policy_detail.created_time

datetime
Conditionally returned

Date and time when the offer policy was created on Marqeta’s credit platform, in UTC.

Allowable Values:

Format: yyyy-MM-ddThh:mm:ssZ

offer_policy_detail.updated_time

datetime
Conditionally returned

Date and time when the offer policy was last updated on Marqeta’s credit platform, in UTC.

Allowable Values:

Format: yyyy-MM-ddThh:mm:ssZ

created_time

datetime
Conditionally returned

Date and time when the bundle 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 bundle was last updated on Marqeta’s credit platform, in UTC.

Allowable Values:

Format: yyyy-MM-ddThh:mm:ssZ

Sample response body

JSON
Copied

Is this helpful?

Yes
No

Update bundle

Action: PUT
Endpoint: /credit/bundles/{token}

Update a specific bundle that is not ACTIVE or ARCHIVED. Bundles are created in a DRAFT state, and are still modifiable at this point. Using the transitions endpoint a bundle can be transitioned from DRAFT, to ACTIVE. Once a bundle is active, it is immutable, and cannot be modified.

URL path parameters

Fields Description

token

string
Required

Token of the bundle to update.

Send a GET request to /credit/bundles to retrieve existing tokens.

Allowable Values:

Existing bundle token

Request body

Fields Description

name

string
Required

Name of the bundle.

Allowable Values:

255 char max

description

string
Required

Description of the bundle.

Allowable Values:

255 char max

credit_product_policy_token

string
Required

Unique identifier of the bundle’s credit product policy.

Allowable Values:

36 char max

apr_policy_token

string
Required

Unique identifier of the bundle’s APR policy.

Allowable Values:

36 char max

document_policy_token

string
Required

Unique identifier of the bundle’s document policy.

Allowable Values:

36 char max

fee_policy_token

string
Required

Unique identifier of the bundle’s fee policy.

Allowable Values:

36 char max

reward_policy_token

string
Optional

Unique identifier of the bundle’s reward policy.

Allowable Values:

36 char max

offer_policy_token

string
Optional

Unique identifier of the bundle’s offer policy.

Allowable Values:

36 char max

Sample request body

JSON
Copied

Is this helpful?

Yes
No

Response body

Fields Description

token

string
Conditionally returned

Unique identifier of the bundle.

Allowable Values:

36 char max

name

string
Conditionally returned

Name of the bundle.

Allowable Values:

255 char max

status

string
Conditionally returned

Status of the bundle.

  • DRAFT - The bundle is in the process of being created.

  • PENDING_APPROVAL - The bundle has been created and is awaiting approval.

  • SENT_FOR_REVISION - The bundle has been returned for revision.

  • ACTIVE - The bundle is active.

  • REJECTED - The bundle has been rejected; this status cannot be changed.

  • ARCHIVED - The previously active bundle has been archived.

  • APPROVED - The bundle has been approved (after having been sent for approval).

Allowable Values:

DRAFT, PENDING_APPROVAL, SENT_FOR_REVISION, ACTIVE, REJECTED, ARCHIVED, APPROVED

description

string
Conditionally returned

Description of the bundle.

Allowable Values:

255 char max

credit_product_policy_token

string
Conditionally returned

Unique identifier of the bundle’s credit product policy.

Allowable Values:

36 char max

credit_product_policy_detail

object
Conditionally returned

Contains information on the credit product policy.

Allowable Values:

Existing credit_product_policy_detail object

credit_product_policy_detail.token

string
Conditionally returned

Unique identifier of the credit product policy.

Allowable Values:

36 char max

credit_product_policy_detail.card_products

array of objects
Conditionally returned

One or more card products associated with the credit product policy.

Allowable Values:

One or more card_products objects

credit_product_policy_detail.card_products[].token

string
Conditionally returned

Unique identifier of the card product.

Allowable Values:

36 char max

credit_product_policy_detail.card_products[].level

string
Conditionally returned

Level of the card product.

Allowable Values:

PREMIUM, TRADITIONAL

credit_product_policy_detail.card_products[].network

string
Conditionally returned

Name of the card network.

Allowable Values:

VISA, MASTERCARD, SANDBOX

credit_product_policy_detail.name

string
Conditionally returned

Name of the credit product policy.

Allowable Values:

1 char min

credit_product_policy_detail.description

string
Conditionally returned

Description of the credit product policy.

Allowable Values:

255 char max

credit_product_policy_detail.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

credit_product_policy_detail.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

credit_product_policy_detail.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

credit_product_policy_detail.currency_code

string
Conditionally returned

A valid three-digit ISO 4217 currency code

Allowable Values:

USD

credit_product_policy_detail.credit_line

object
Conditionally returned

Contains information on the credit line range.

Allowable Values:

Existing credit_line object

credit_product_policy_detail.credit_line.min

decimal
Returned

Minimum credit limit.

Allowable Values:

0–999999999999.99

credit_product_policy_detail.credit_line.max

decimal
Returned

Maximum credit limit.

Allowable Values:

0–999999999999.99

credit_product_policy_detail.usage

array of strings
Conditionally returned

One or more usage types for the credit product policy.

Allowable Values:

PURCHASE

Valid usage array

credit_product_policy_detail.interest_calculation

object
Conditionally returned

Contains the configurations for interest calculation.

Allowable Values:

Existing interest_calculation object

credit_product_policy_detail.interest_calculation.method

string
Returned

Method of interest calculation.

Allowable Values:

AVG_DAILY_BALANCE_WITH_NEW_TRANSACTIONS

credit_product_policy_detail.interest_calculation.day_count

string
Returned

Day-count convention.

Allowable Values:

ACTUAL

credit_product_policy_detail.interest_calculation.interest_application

array of strings
Returned

One or more balance types on which interest is applied.

Allowable Values:

PRINCIPAL, FEES, INTEREST

credit_product_policy_detail.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

credit_product_policy_detail.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

credit_product_policy_detail.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

credit_product_policy_detail.interest_calculation.application_of_credits

object
Returned

Contains information on the cycle type and billing cycle day when credits are applied in the daily balance calculation.

Allowable Values:

Existing application_of_credits object

credit_product_policy_detail.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 the balance is paid off each month.

Allowable Values:

BEGINNING_REVOLVING, REVOLVING, END_REVOLVING, TRANSACTING

When creating or updating an account, only TRANSACTING is allowed.

credit_product_policy_detail.interest_calculation.application_of_credits.day

integer
Returned

Day of the billing cycle when credits are applied.

Allowable Values:

1–31

credit_product_policy_detail.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

credit_product_policy_detail.payments

object
Conditionally returned

Contains the configurations for billing cycle day, payment due day, and fees.

Allowable Values:

Existing payments object

credit_product_policy_detail.payments.billing_cycle_day

integer
Returned

Day of month the billing cycle starts.

Allowable Values:

1

credit_product_policy_detail.payments.due_day

integer
Returned

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

Allowable Values:

31

credit_product_policy_detail.payments.allocation_order

array of strings
Returned

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

Allowable Values:

INTEREST, FEES, PRINCIPAL

credit_product_policy_detail.payments.min_payment_calculation

object
Returned

Contains information used to calculate the minimum payment amount on a credit product policy.

Allowable Values:

Existing min_payment_calculation object

credit_product_policy_detail.payments.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

credit_product_policy_detail.payments.min_payment_calculation.include_overlimit_amount

boolean
Returned

Whether to include the overlimit amount when calculating the minimum payment.

Allowable Values:

true, false

credit_product_policy_detail.payments.min_payment_calculation.min_payment_flat_amount

decimal
Conditionally returned

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

Allowable Values:

Format: 0.00

credit_product_policy_detail.payments.min_payment_calculation.min_payment_percentage

object
Conditionally returned

Contains information used to calculate the minimum payment amount when expressed as a percentage.

Allowable Values:

Existing min_payment_percentage object

credit_product_policy_detail.payments.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

credit_product_policy_detail.payments.min_payment_calculation.min_payment_percentage.include_interest_charged

boolean
Returned

Whether to include the amount of interest charged when calculating the minimum payment.

Allowable Values:

true, false

credit_product_policy_detail.payments.min_payment_calculation.min_payment_percentage.include_fees_charged

array of strings
Conditionally returned

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

Allowable Values:

LATE_PAYMENT_FEE, RETURNED_PAYMENT_FEE

credit_product_policy_detail.created_time

datetime
Conditionally returned

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

Allowable Values:

Format: yyyy-MM-ddThh:mm:ssZ

credit_product_policy_detail.updated_time

datetime
Conditionally returned

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

Allowable Values:

Format: yyyy-MM-ddThh:mm:ssZ

apr_policy_token

string
Conditionally returned

Unique identifier of the bundle’s APR policy.

Allowable Values:

36 char max

apr_policy_detail

object
Conditionally returned

Contains information on an APR policy.

Allowable Values:

Existing apr_policy_detail object

apr_policy_detail.token

string
Conditionally returned

Unique identifier of the APR policy.

Allowable Values:

36 char max

apr_policy_detail.name

string
Conditionally returned

Name of the APR policy.

Allowable Values:

255 char max

apr_policy_detail.description

string
Conditionally returned

Description of the APR policy.

Allowable Values:

255 char max

apr_policy_detail.purchases

object
Conditionally returned

Contains information on the pricing strategy for purchases.

Allowable Values:

Existing purchases object

apr_policy_detail.purchases.name

string
Conditionally returned

Name of the pricing strategy.

Allowable Values:

255 char max

apr_policy_detail.purchases.external_token

string
Conditionally returned

Unique identifier of the pricing strategy on a credit program.

Allowable Values:

36 char max

apr_policy_detail.purchases.tiers

array of objects
Conditionally returned

One or more risk tiers for a pricing strategy.

Allowable Values:

One or more tiers objects

apr_policy_detail.purchases.tiers[].margin_rate

decimal
Conditionally returned

Margin rate for the risk tier for a pricing strategy.

Allowable Values:

Format: 0.00

apr_policy_detail.purchases.tiers[].apr

decimal
Conditionally returned

The value of the APR.

Allowable Values:

Format: 0.00

apr_policy_detail.effective_date

date
Conditionally returned

Date the APR goes into effect, in UTC.

Allowable Values:

Format: yyyy-MM-dd

apr_policy_detail.created_time

datetime
Conditionally returned

Date and time when the APR policy was created on Marqeta’s credit platform, in UTC.

Allowable Values:

Format: yyyy-MM-ddThh:mm:ssZ

apr_policy_detail.updated_time

datetime
Conditionally returned

Date and time when the APR policy was last updated on Marqeta’s credit platform, in UTC.

Allowable Values:

Format: yyyy-MM-ddThh:mm:ssZ

document_policy_token

string
Conditionally returned

Unique identifier of the bundle’s document policy.

Allowable Values:

36 char max

document_policy_detail

object
Conditionally returned

Contains information on a document policy.

Allowable Values:

Existing document_policy_detail object

document_policy_detail.token

string
Conditionally returned

Unique identifier of the document policy.

Allowable Values:

36 char max

document_policy_detail.name

string
Conditionally returned

Name of the document policy.

Allowable Values:

255 char max

document_policy_detail.summary_of_credit_terms

object
Conditionally returned

Contains information on the Summary of Credit Terms (SOCT), which is a pre- and post-application disclosure that outlines the terms of an account, such as the interest rates, interest charges, associated fees, and more.

Allowable Values:

Existing summary_of_credit_terms object

document_policy_detail.summary_of_credit_terms.asset_token

string
Conditionally returned

Unique identifier of the asset, which is the version of a document that is based on the template and contains finalized values. The values are finalized when the bundle containing the document is created.

Allowable Values:

Existing asset token for the SOCT or Rewards Disclosure

document_policy_detail.summary_of_credit_terms.asset_urls

object
Conditionally returned

Contains one or more URLs for an asset.

Allowable Values:

One or more asset_urls objects

document_policy_detail.summary_of_credit_terms.asset_urls.pdf

string
Returned

URL to the PDF version of the asset.

Allowable Values:

A valid URL

document_policy_detail.summary_of_credit_terms.asset_urls.png

string
Returned

URL to the PNG version of the asset.

Allowable Values:

A valid URL

document_policy_detail.summary_of_credit_terms.asset_urls.html

string
Returned

URL to the HTML version of the asset.

Allowable Values:

A valid URL

document_policy_detail.summary_of_credit_terms.asset_created_time

datetime
Conditionally returned

Date and time when the asset was created.

Allowable Values:

Format: yyyy-MM-ddThh:mm:ssZ

document_policy_detail.summary_of_credit_terms.template_token

string
Conditionally returned

Unique identifier of the template, which is the version of a document that serves as an initial disclosure but does not contain finalized values. Values are finalized in the asset version of the document.

Allowable Values:

Existing template token for the SOCT or Rewards Disclosure

document_policy_detail.summary_of_credit_terms.template_urls

object
Conditionally returned

Contains one or more URLs for a template.

Allowable Values:

One or more template_urls objects

document_policy_detail.summary_of_credit_terms.template_urls.html

string
Returned

URL to the HTML version of the document template.

Allowable Values:

A valid URL

document_policy_detail.summary_of_credit_terms.template_created_time

datetime
Conditionally returned

Date and time when the template was created.

Allowable Values:

Format: yyyy-MM-ddThh:mm:ssZ

document_policy_detail.rewards_disclosure

object
Conditionally returned

Contains information on the Rewards Disclosure, which is a pre- and post-application disclosure that provides details about the rewards program for a bundle.

Allowable Values:

Existing rewards_disclosure object

document_policy_detail.rewards_disclosure.asset_token

string
Conditionally returned

Unique identifier of the asset, which is the version of a document that is based on the template and contains finalized values. The values are finalized when the bundle containing the document is created.

Allowable Values:

Existing asset token for the SOCT or Rewards Disclosure

document_policy_detail.rewards_disclosure.asset_urls

object
Conditionally returned

Contains one or more URLs for an asset.

Allowable Values:

One or more asset_urls objects

document_policy_detail.rewards_disclosure.asset_urls.pdf

string
Returned

URL to the PDF version of the asset.

Allowable Values:

A valid URL

document_policy_detail.rewards_disclosure.asset_urls.png

string
Returned

URL to the PNG version of the asset.

Allowable Values:

A valid URL

document_policy_detail.rewards_disclosure.asset_urls.html

string
Returned

URL to the HTML version of the asset.

Allowable Values:

A valid URL

document_policy_detail.rewards_disclosure.asset_created_time

datetime
Conditionally returned

Date and time when the asset was created.

Allowable Values:

Format: yyyy-MM-ddThh:mm:ssZ

document_policy_detail.rewards_disclosure.template_token

string
Conditionally returned

Unique identifier of the template, which is the version of a document that serves as an initial disclosure but does not contain finalized values. Values are finalized in the asset version of the document.

Allowable Values:

Existing template token for the SOCT or Rewards Disclosure

document_policy_detail.rewards_disclosure.template_urls

object
Conditionally returned

Contains one or more URLs for a template.

Allowable Values:

One or more template_urls objects

document_policy_detail.rewards_disclosure.template_urls.html

string
Returned

URL to the HTML version of the document template.

Allowable Values:

A valid URL

document_policy_detail.rewards_disclosure.template_created_time

datetime
Conditionally returned

Date and time when the template was created.

Allowable Values:

Format: yyyy-MM-ddThh:mm:ssZ

document_policy_detail.terms_schedule

object
Conditionally returned

Contains information on the Terms Schedule, which is a post-application disclosure that contains the terms of credit for an account, including the interest rate details.

Allowable Values:

Existing terms_schedule object

document_policy_detail.terms_schedule.template_token

string
Conditionally returned

Unique identifier of a template, which is a document that serves as an initial disclosure but does not contain finalized values.

Allowable Values:

Existing template token for the Terms Schedule, Account Statement, or NOAA

document_policy_detail.terms_schedule.template_urls

object
Conditionally returned

Contains one or more URLs for a template.

Allowable Values:

One or more template_urls objects

document_policy_detail.terms_schedule.template_urls.html

string
Returned

URL to the HTML version of the document template.

Allowable Values:

A valid URL

document_policy_detail.terms_schedule.template_created_time

datetime
Conditionally returned

Date and time when the template was created.

Allowable Values:

Format: yyyy-MM-ddThh:mm:ssZ

document_policy_detail.benefits_disclosure_traditional

object
Conditionally returned

Contains information on the Benefits Disclosure (Traditional), which is a post-application disclosure that outlines the network benefits of a traditional Mastercard or Visa card.

Allowable Values:

Existing benefits_disclosure_traditional object

document_policy_detail.benefits_disclosure_traditional.asset_token

string
Conditionally returned

Unique identifier of the asset, which is a type of document that contains finalized values. The values are finalized when the bundle containing the document is created.

Allowable Values:

Existing asset token for the Benefits Disclosure (Traditional), Benefits Disclosure (Premium), Privacy Policy, eDisclosure, or Card Member Agreement

document_policy_detail.benefits_disclosure_traditional.asset_urls

object
Conditionally returned

Contains one or more URLs for an asset.

Allowable Values:

One or more asset_urls objects

document_policy_detail.benefits_disclosure_traditional.asset_urls.pdf

string
Returned

URL to the PDF version of the asset.

Allowable Values:

A valid URL

document_policy_detail.benefits_disclosure_traditional.asset_urls.png

string
Returned

URL to the PNG version of the asset.

Allowable Values:

A valid URL

document_policy_detail.benefits_disclosure_traditional.asset_urls.html

string
Returned

URL to the HTML version of the asset.

Allowable Values:

A valid URL

document_policy_detail.benefits_disclosure_traditional.asset_created_time

datetime
Conditionally returned

Date and time when the asset was created.

Allowable Values:

Format: yyyy-MM-ddThh:mm:ssZ

document_policy_detail.benefits_disclosure_premium

object
Conditionally returned

Contains information on the Benefits Disclosure (Premium), which is a post-application disclosure that outlines the network benefits of a Mastercard World or Visa Signature card.

Allowable Values:

Existing benefits_disclosure_premium object

document_policy_detail.benefits_disclosure_premium.asset_token

string
Conditionally returned

Unique identifier of the asset, which is a type of document that contains finalized values. The values are finalized when the bundle containing the document is created.

Allowable Values:

Existing asset token for the Benefits Disclosure (Traditional), Benefits Disclosure (Premium), Privacy Policy, eDisclosure, or Card Member Agreement

document_policy_detail.benefits_disclosure_premium.asset_urls

object
Conditionally returned

Contains one or more URLs for an asset.

Allowable Values:

One or more asset_urls objects

document_policy_detail.benefits_disclosure_premium.asset_urls.pdf

string
Returned

URL to the PDF version of the asset.

Allowable Values:

A valid URL

document_policy_detail.benefits_disclosure_premium.asset_urls.png

string
Returned

URL to the PNG version of the asset.

Allowable Values:

A valid URL

document_policy_detail.benefits_disclosure_premium.asset_urls.html

string
Returned

URL to the HTML version of the asset.

Allowable Values:

A valid URL

document_policy_detail.benefits_disclosure_premium.asset_created_time

datetime
Conditionally returned

Date and time when the asset was created.

Allowable Values:

Format: yyyy-MM-ddThh:mm:ssZ

document_policy_detail.privacy_policy

object
Conditionally returned

Contains information on the Privacy Policy, which is a pre-application disclosure that explains how an applicant’s data is used and managed.

Allowable Values:

Existing privacy_policy object

document_policy_detail.privacy_policy.asset_token

string
Conditionally returned

Unique identifier of the asset, which is a type of document that contains finalized values. The values are finalized when the bundle containing the document is created.

Allowable Values:

Existing asset token for the Benefits Disclosure (Traditional), Benefits Disclosure (Premium), Privacy Policy, eDisclosure, or Card Member Agreement

document_policy_detail.privacy_policy.asset_urls

object
Conditionally returned

Contains one or more URLs for an asset.

Allowable Values:

One or more asset_urls objects

document_policy_detail.privacy_policy.asset_urls.pdf

string
Returned

URL to the PDF version of the asset.

Allowable Values:

A valid URL

document_policy_detail.privacy_policy.asset_urls.png

string
Returned

URL to the PNG version of the asset.

Allowable Values:

A valid URL

document_policy_detail.privacy_policy.asset_urls.html

string
Returned

URL to the HTML version of the asset.

Allowable Values:

A valid URL

document_policy_detail.privacy_policy.asset_created_time

datetime
Conditionally returned

Date and time when the asset was created.

Allowable Values:

Format: yyyy-MM-ddThh:mm:ssZ

document_policy_detail.e_disclosure

object
Conditionally returned

Contains information on the eDisclosure, which is a pre-application disclosure that states that users are to receive their disclosures electronically.

Allowable Values:

Existing e_disclosure object

document_policy_detail.e_disclosure.asset_token

string
Conditionally returned

Unique identifier of the asset, which is a type of document that contains finalized values. The values are finalized when the bundle containing the document is created.

Allowable Values:

Existing asset token for the Benefits Disclosure (Traditional), Benefits Disclosure (Premium), Privacy Policy, eDisclosure, or Card Member Agreement

document_policy_detail.e_disclosure.asset_urls

object
Conditionally returned

Contains one or more URLs for an asset.

Allowable Values:

One or more asset_urls objects

document_policy_detail.e_disclosure.asset_urls.pdf

string
Returned

URL to the PDF version of the asset.

Allowable Values:

A valid URL

document_policy_detail.e_disclosure.asset_urls.png

string
Returned

URL to the PNG version of the asset.

Allowable Values:

A valid URL

document_policy_detail.e_disclosure.asset_urls.html

string
Returned

URL to the HTML version of the asset.

Allowable Values:

A valid URL