GET////
Retrieve an array of related product bundles.
This endpoint supports sorting and pagination.
URL path parameters
| Fields | Description |
|---|---|
| token string Required | Unique identifier of the parent product bundle. Send a GET request to /bundles to retrieve existing product bundles tokens.Allowable Values: Existing bundle token |
URL query parameters
| Fields | Description |
|---|---|
| count integer Optional | Number of related bundle product resources to retrieve. Allowable Values: 1–100 |
| start_index integer Optional | Sort order index of the first resource in the returned array. Allowable Values: 0 min |
| sort_by string Optional | Field on which to sort. Prefix the field name with a hyphen (-) to sort in descending order. Omit the hyphen to sort in ascending order.NOTE: You must sort using system field names such as lastModifiedTime, and not by the field names appearing in response bodies such as last_modified_time.Allowable Values: lastModifiedTime, -lastModifiedTime |
| status array of strings Optional | 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.- SECURED_CARD - Card backed by a user-funded deposit that enables the cardholder to make purchases on credit.Allowable Values: CREDIT_CARD, SECURED_CARD |
| data[].credit_product_policy_detail.currency_code string Conditionally returned | 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: PURCHASEValid 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.exclude_tran_types array of strings Conditionally returned | One or more transactions that are excluded from current billing period’s interest charge, but included in next. Allowable Values: LATE_PAYMENT_FEE, ANNUAL_FEE, MONTHLY_FEE, CASH_BACK_STATEMENT_CREDIT, RETURNED_PAYMENT_FEE, FOREIGN_TRANSACTION_FEE |
| data[].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 the month when the billing cycle starts. Allowable Values: 1–28 |
| data[].credit_product_policy_detail.payments.due_day integer Conditionally returned | Day of month the payment for the previous billing cycle is due. This field is being deprecated and replaced by payment_due_interval of a product policy. To retrieve payment_due_interval, see Retrieve credit product policy, payments.payment_due_interval.Allowable Values: 31 |
| data[].credit_product_policy_detail.payments.billing_cycle_frequency string Conditionally returned | Frequency at which the account is billed. Allowable Values: MONTHLY |
| data[].credit_product_policy_detail.payments.payment_due_interval integer Conditionally returned | Specifies the payment due interval that is used to determine the payment due date for a billing cycle. A value of -1 indicates one day prior to the next billing cycle date. For consumer programs, a minimum gap of 21 days is required between when a statement is delivered and the payment due date. Allowable Values: -1 min Positive integers greater than 0; -1 is the default value |
| data[].credit_product_policy_detail.payments.billing_cycle_day_strategy string Conditionally returned | Determines if the billing cycle day is manually set or determined dynamically during account creation based on cycling logic. Allowable Values: MANUAL |
| data[].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_all_fees_charged boolean Conditionally returned | Whether to include all fees charged when calculating the minimum payment. Allowable Values: true, false |
| 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 | 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: 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: 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: 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: 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: Valid URL |
| data[].document_policy_detail.rewards_disclosure.asset_urls.png string Returned | URL to the PNG version of the asset. Allowable Values: Valid URL |
| data[].document_policy_detail.rewards_disclosure.asset_urls.html string Returned | URL to the HTML version of the asset. Allowable Values: 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: 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.pre_qualification_disclosure object Conditionally returned | Contains information on the Pre-Qualification Disclosure, which is a pre-disclosure that provides details about the pre-qualification offer for the user. Allowable Values: Existing pre_qualification_disclosure object |
| data[].document_policy_detail.pre_qualification_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.pre_qualification_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.pre_qualification_disclosure.asset_urls.pdf string Returned | URL to the PDF version of the asset. Allowable Values: Valid URL |
| data[].document_policy_detail.pre_qualification_disclosure.asset_urls.png string Returned | URL to the PNG version of the asset. Allowable Values: Valid URL |
| data[].document_policy_detail.pre_qualification_disclosure.asset_urls.html string Returned | URL to the HTML version of the asset. Allowable Values: Valid URL |
| data[].document_policy_detail.pre_qualification_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.pre_qualification_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.pre_qualification_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.pre_qualification_disclosure.template_urls.html string Returned | URL to the HTML version of the document template. Allowable Values: Valid URL |
| data[].document_policy_detail.pre_qualification_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: 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: Valid URL |
| data[].document_policy_detail.benefits_disclosure_traditional.asset_urls.png string Returned | URL to the PNG version of the asset. Allowable Values: Valid URL |
| data[].document_policy_detail.benefits_disclosure_traditional.asset_urls.html string Returned | URL to the HTML version of the asset. Allowable Values: 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: Valid URL |
| data[].document_policy_detail.benefits_disclosure_premium.asset_urls.png string Returned | URL to the PNG version of the asset. Allowable Values: Valid URL |
| data[].document_policy_detail.benefits_disclosure_premium.asset_urls.html string Returned | URL to the HTML version of the asset. Allowable Values: 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: Valid URL |
| data[].document_policy_detail.privacy_policy.asset_urls.png string Returned | URL to the PNG version of the asset. Allowable Values: Valid URL |
| data[].document_policy_detail.privacy_policy.asset_urls.html string Returned | URL to the HTML version of the asset. Allowable Values: 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: Valid URL |
| data[].document_policy_detail.e_disclosure.asset_urls.png string Returned | URL to the PNG version of the asset. Allowable Values: Valid URL |
| data[].document_policy_detail.e_disclosure.asset_urls.html string Returned | URL to the HTML version of the asset. Allowable Values: 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: Valid URL |
| data[].document_policy_detail.card_member_agreement.asset_urls.png string Returned | URL to the PNG version of the asset. Allowable Values: Valid URL |
| data[].document_policy_detail.card_member_agreement.asset_urls.html string Returned | URL to the HTML version of the asset. Allowable Values: 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: 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: 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: 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: 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 fees in an account’s fee policy. 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.account.foreign_transaction_fee object Conditionally returned | Contains information on the foreign transaction fee. Allowable Values: Existing foreign_transaction_fee object |
| data[].fee_policy_detail.account.monthly_fee object Conditionally returned | Contains information on the monthly periodic fees. Allowable Values: Existing periodic_fees object |
| data[].fee_policy_detail.account.annual_fee object Conditionally returned | Contains information on the annual periodic fees. Allowable Values: Existing periodic_fees 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.settlement_strategy string Conditionally returned | Reward settlement strategy for a credit program. Allowable Values: STATEMENT, LIVE |
| data[].reward_policy_detail.accrual_strategy string Conditionally returned | Reward accrual strategy for a credit program. If no value for accrual_strategy is set, the default value of this field is DEFAULT.Allowable Values: DEFAULT, PAYMENT |
| data[].reward_policy_detail.rounding_strategy string Conditionally returned | Rounding strategy for reward accrual calculations. If no value for rounding_strategy is set, then the default value of this field is ROUND_HALF_EVEN.Available options: - ROUND_UP: Always rounds away from zero to whole numbers.- ROUND_DOWN: Always rounds towards zero to whole numbers.- ROUND_HALF_EVEN: Rounds to two decimal places using half-even logic (default).- ROUND_HALF_EVEN_WHOLE: Rounds to whole numbers using half-even logic.Allowable Values: ROUND_UP, ROUND_DOWN, ROUND_HALF_EVEN, ROUND_HALF_EVEN_WHOLE |
| data[].reward_policy_detail.rules array of objects Conditionally returned | A list of one or more reward rules. Allowable Values: Valid array of one or more rules objects |
| data[].reward_policy_detail.rules[].description string Returned | The description of the rule. Allowable Values: 255 char max |
| data[].reward_policy_detail.rules[].type string Returned | Type of rule. Allowable Values: MULTIPLIER_PER_TRANSACTION |
| data[].reward_policy_detail.rules[].calculation_type string Conditionally returned | Type of calculation to use to evaluate if a rule has been satisfied. Allowable Values: PER_TRANSACTION |
| data[].reward_policy_detail.rules[].multiplier decimal Conditionally returned | The reward multiplier to apply the transaction, where ‘1’ means 1x transaction amount. Allowable Values: Any integer |
| data[].reward_policy_detail.rules[].amount decimal Conditionally returned | The static amount to reward if the rule conditions are met. Allowable Values: Any integer |
| data[].reward_policy_detail.rules[].attributes object Conditionally returned | Additional properties for which the rule can be used to determine reward accrual eligibility for a transaction. Allowable Values: mcc: 1500, 0001-1499 mid: 255 |
| data[].reward_policy_detail.rules[].attributes.mcc array of strings Conditionally returned | List of merchant category codes (MCCs). MCCs must be a four-digit number, or a range of two four-digit numbers separated by a hyphen. Allowable Values: 1500, 0001-1499 |
| data[].reward_policy_detail.rules[].attributes.mid string Conditionally returned | Merchant ID for the rule. Allowable Values: “255” |
| data[].reward_policy_detail.rules[].attributes.min_spend decimal Conditionally returned | Minimum spend amount. Allowable Values: 100 |
| data[].reward_policy_detail.rules[].attributes.max_spend decimal Conditionally returned | Maximum spend amount. Allowable Values: 150 |
| data[].reward_policy_detail.rules[].attributes.spend_total decimal Conditionally returned | Total spend amount. Allowable Values: 100 |
| data[].reward_policy_detail.rules[].attributes.spend_days integer Conditionally returned | Maximum number of days since account creation within which the minimum spend requirements must be met to qualify for the reward (used for signup bonus rules). Positive integer values are allowed, with a minimum value of 1.Allowable Values: 1 min |
| data[].reward_policy_detail.conversions array of objects Conditionally returned | List of one or more reward conversions. Allowable Values: Valid array of one or more conversion objects |
| data[].reward_policy_detail.conversions[].type string Returned | Type of conversion. Allowable Values: STATEMENT_CREDIT |
| data[].reward_policy_detail.conversions[].conversion_rate decimal Returned | The rate that points are worth with converting the REDEMPTION_TYPE indicated. Allowable Values: 0.001 min Format: 0.000 |
| data[].reward_policy_detail.conversions[].conversion_increment integer Returned | The static amount to reward if the rule conditions are met. Allowable Values: Any integer |
| data[].reward_policy_detail.conversions[].currency string Conditionally returned | Type of currency used with the conversion rate. Allowable Values: Currency code, such as EUR or USD. |
| data[].reward_policy_detail.exclusions object Conditionally returned | Defines what merchant category codes (MCCs) are excluded from earning rewards. MCCs must be a four-digit number, or a range of two four-digit numbers separated by a hyphen. Allowable Values: 1500, 0001-1499 |
| data[].reward_policy_detail.exclusions.use_default_exclusions boolean Conditionally returned | Indicates whether to use the default exclusion list. - If true, the default exclusion list is used.- If false, the custom exclusion list is used, if custom exclusions are included.Allowable Values: true, false |
| data[].reward_policy_detail.exclusions.custom_exclusions array of strings Conditionally returned | List of merchant category codes (MCCs). MCCs must be a four-digit number, or a range of two four-digit numbers separated by a hyphen. Allowable Values: 1500, 0001-1499 |
| 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 |