Create document policy
Action:POSTEndpoint:
/credit/policies/documents
Create a new document policy, which consists of all the pre- and post-application disclosures and credit program documents known as assets and templates. Assets contain finalized values after a bundle is created; templates do not contain finalized values.
Request body
| Fields | Description |
|---|---|
| token string Optional | Unique identifier of the document policy. Allowable Values: 36 char max |
| name string Required | Name of the document policy. Allowable Values: 255 char max |
| summary_of_credit_terms object Required | 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 |
| summary_of_credit_terms.asset_token string Required | 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 |
| summary_of_credit_terms.template_token string Required | Unique identifier of the template, which is the version of a document that serves as an initial disclosure but does not contain finalized values. The values are finalized in the asset version of the document. Allowable Values: Existing template token for the SOCT or Rewards Disclosure |
| rewards_disclosure object Optional | 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 |
| rewards_disclosure.asset_token string Required | 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 |
| rewards_disclosure.template_token string Required | Unique identifier of the template, which is the version of a document that serves as an initial disclosure but does not contain finalized values. The values are finalized in the asset version of the document. Allowable Values: Existing template token for the SOCT or Rewards Disclosure |
| pre_qualification_disclosure object Optional | Contains information on the prequalification Disclosure, which is a pre-disclosure that provides details about the pre-qualification offer for the user. Allowable Values: Existing pre_qualification_disclosure object |
| pre_qualification_disclosure.asset_token string Required | 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 |
| pre_qualification_disclosure.template_token string Required | Unique identifier of the template, which is the version of a document that serves as an initial disclosure but does not contain finalized values. The values are finalized in the asset version of the document. Allowable Values: Existing template token for the SOCT or Rewards Disclosure |
| terms_schedule object Required | 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 |
| terms_schedule.template_token string Required | 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 |
| benefits_disclosure_traditional object Required | 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 |
| benefits_disclosure_traditional.asset_token string Required | 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 |
| benefits_disclosure_premium object Required | 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 |
| benefits_disclosure_premium.asset_token string Required | 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 |
| privacy_policy object Required | 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 |
| privacy_policy.asset_token string Required | 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 |
| e_disclosure object Required | 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 |
| e_disclosure.asset_token string Required | 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 |
| card_member_agreement object Required | 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 |
| card_member_agreement.asset_token string Required | 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 |
| account_statement object Required | 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 |
| account_statement.template_token string Required | 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 |
| noaa_single_reason object Required | 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 |
| noaa_single_reason.template_token string Required | 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 |
| noaa_single_reason_with_dodd_frank object Required | 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 |
| noaa_single_reason_with_dodd_frank.template_token string Required | 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 |
| noaa_multiple_reason_with_dodd_frank object Required | 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 |
| noaa_multiple_reason_with_dodd_frank.template_token string Required | 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 |
Sample request body
JSON
Response body
| Fields | Description |
|---|---|
| token string Conditionally returned | Unique identifier of the document policy. Allowable Values: 36 char max |
| name string Conditionally returned | Name of the document policy. Allowable Values: 255 char max |
| 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 |
| 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 |
| 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 |
| summary_of_credit_terms.asset_urls.pdf string Returned | URL to the PDF version of the asset. Allowable Values: Valid URL |
| summary_of_credit_terms.asset_urls.png string Returned | URL to the PNG version of the asset. Allowable Values: Valid URL |
| summary_of_credit_terms.asset_urls.html string Returned | URL to the HTML version of the asset. Allowable Values: Valid URL |
| 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 |
| 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 |
| 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 |
| summary_of_credit_terms.template_urls.html string Returned | URL to the HTML version of the document template. Allowable Values: Valid URL |
| 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 |
| 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 |
| 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 |
| rewards_disclosure.asset_urls object Conditionally returned | Contains one or more URLs for an asset. Allowable Values: One or more asset_urls objects |
| rewards_disclosure.asset_urls.pdf string Returned | URL to the PDF version of the asset. Allowable Values: Valid URL |
| rewards_disclosure.asset_urls.png string Returned | URL to the PNG version of the asset. Allowable Values: Valid URL |
| rewards_disclosure.asset_urls.html string Returned | URL to the HTML version of the asset. Allowable Values: Valid URL |
| rewards_disclosure.asset_created_time datetime Conditionally returned | Date and time when the asset was created. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
| 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 |
| rewards_disclosure.template_urls object Conditionally returned | Contains one or more URLs for a template. Allowable Values: One or more template_urls objects |
| rewards_disclosure.template_urls.html string Returned | URL to the HTML version of the document template. Allowable Values: Valid URL |
| rewards_disclosure.template_created_time datetime Conditionally returned | Date and time when the template was created. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
| 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 |
| 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 |
| pre_qualification_disclosure.asset_urls object Conditionally returned | Contains one or more URLs for an asset. Allowable Values: One or more asset_urls objects |
| pre_qualification_disclosure.asset_urls.pdf string Returned | URL to the PDF version of the asset. Allowable Values: Valid URL |
| pre_qualification_disclosure.asset_urls.png string Returned | URL to the PNG version of the asset. Allowable Values: Valid URL |
| pre_qualification_disclosure.asset_urls.html string Returned | URL to the HTML version of the asset. Allowable Values: Valid URL |
| 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 |
| 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 |
| pre_qualification_disclosure.template_urls object Conditionally returned | Contains one or more URLs for a template. Allowable Values: One or more template_urls objects |
| pre_qualification_disclosure.template_urls.html string Returned | URL to the HTML version of the document template. Allowable Values: Valid URL |
| 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 |
| 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 |
| 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 |
| terms_schedule.template_urls object Conditionally returned | Contains one or more URLs for a template. Allowable Values: One or more template_urls objects |
| terms_schedule.template_urls.html string Returned | URL to the HTML version of the document template. Allowable Values: Valid URL |
| terms_schedule.template_created_time datetime Conditionally returned | Date and time when the template was created. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
| 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 |
| 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 |
| benefits_disclosure_traditional.asset_urls object Conditionally returned | Contains one or more URLs for an asset. Allowable Values: One or more asset_urls objects |
| benefits_disclosure_traditional.asset_urls.pdf string Returned | URL to the PDF version of the asset. Allowable Values: Valid URL |
| benefits_disclosure_traditional.asset_urls.png string Returned | URL to the PNG version of the asset. Allowable Values: Valid URL |
| benefits_disclosure_traditional.asset_urls.html string Returned | URL to the HTML version of the asset. Allowable Values: Valid URL |
| 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 |
| 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 |
| 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 |
| benefits_disclosure_premium.asset_urls object Conditionally returned | Contains one or more URLs for an asset. Allowable Values: One or more asset_urls objects |
| benefits_disclosure_premium.asset_urls.pdf string Returned | URL to the PDF version of the asset. Allowable Values: Valid URL |
| benefits_disclosure_premium.asset_urls.png string Returned | URL to the PNG version of the asset. Allowable Values: Valid URL |
| benefits_disclosure_premium.asset_urls.html string Returned | URL to the HTML version of the asset. Allowable Values: Valid URL |
| 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 |
| 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 |
| 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 |
| privacy_policy.asset_urls object Conditionally returned | Contains one or more URLs for an asset. Allowable Values: One or more asset_urls objects |
| privacy_policy.asset_urls.pdf string Returned | URL to the PDF version of the asset. Allowable Values: Valid URL |
| privacy_policy.asset_urls.png string Returned | URL to the PNG version of the asset. Allowable Values: Valid URL |
| privacy_policy.asset_urls.html string Returned | URL to the HTML version of the asset. Allowable Values: Valid URL |
| privacy_policy.asset_created_time datetime Conditionally returned | Date and time when the asset was created. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
| 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 |
| 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 |
| e_disclosure.asset_urls object Conditionally returned | Contains one or more URLs for an asset. Allowable Values: One or more asset_urls objects |
| e_disclosure.asset_urls.pdf string Returned | URL to the PDF version of the asset. Allowable Values: Valid URL |
| e_disclosure.asset_urls.png string Returned | URL to the PNG version of the asset. Allowable Values: Valid URL |
| e_disclosure.asset_urls.html string Returned | URL to the HTML version of the asset. Allowable Values: Valid URL |
| e_disclosure.asset_created_time datetime Conditionally returned | Date and time when the asset was created. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
| 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 |
| 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 |
| card_member_agreement.asset_urls object Conditionally returned | Contains one or more URLs for an asset. Allowable Values: One or more asset_urls objects |
| card_member_agreement.asset_urls.pdf string Returned | URL to the PDF version of the asset. Allowable Values: Valid URL |
| card_member_agreement.asset_urls.png string Returned | URL to the PNG version of the asset. Allowable Values: Valid URL |
| card_member_agreement.asset_urls.html string Returned | URL to the HTML version of the asset. Allowable Values: Valid URL |
| 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 |
| 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 |
| 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 |
| account_statement.template_urls object Conditionally returned | Contains one or more URLs for a template. Allowable Values: One or more template_urls objects |
| account_statement.template_urls.html string Returned | URL to the HTML version of the document template. Allowable Values: Valid URL |
| account_statement.template_created_time datetime Conditionally returned | Date and time when the template was created. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
| 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 |
| 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 |
| noaa_single_reason.template_urls object Conditionally returned | Contains one or more URLs for a template. Allowable Values: One or more template_urls objects |
| noaa_single_reason.template_urls.html string Returned | URL to the HTML version of the document template. Allowable Values: Valid URL |
| 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 |
| 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 |
| 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 |
| 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 |
| noaa_single_reason_with_dodd_frank.template_urls.html string Returned | URL to the HTML version of the document template. Allowable Values: Valid URL |
| 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 |
| 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 |
| 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 |
| 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 |
| noaa_multiple_reason_with_dodd_frank.template_urls.html string Returned | URL to the HTML version of the document template. Allowable Values: Valid URL |
| 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 |
| 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 |
| 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 |
Sample response body
JSON
List document policies
Action:GETEndpoint:
/credit/policies/documents
Retrieve an array of existing document policies. A document policy consists of all the pre- and post-application disclosures and credit program documents known as assets and templates. Assets contain finalized values after a bundle is created; templates do not contain finalized values.
This endpoint supports sorting and pagination.
URL query parameters
| Fields | Description |
|---|---|
| count integer Optional | Number of document policy resources to retrieve. Allowable Values: 1–100 |
| start_index integer Optional | Sort order index of the first resource in the returned array. Allowable Values: 0 min |
| sort_by string Optional | Field on which to sort. Prefix the field name with a hyphen (-) to sort in descending order. Omit the hyphen to sort in ascending order.NOTE: You must sort using system field names such as lastModifiedTime, and not by the field names appearing in response bodies such as last_modified_time.Allowable Values: lastModifiedTime, -lastModifiedTime |
Response body
| 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 | One or more document policies. Allowable Values: One or more document policy objects |
| data[].token string Conditionally returned | Unique identifier of the document policy. Allowable Values: 36 char max |
| data[].name string Conditionally returned | Name of the document policy. Allowable Values: 255 char max |
| data[].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[].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[].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[].summary_of_credit_terms.asset_urls.pdf string Returned | URL to the PDF version of the asset. Allowable Values: Valid URL |
| data[].summary_of_credit_terms.asset_urls.png string Returned | URL to the PNG version of the asset. Allowable Values: Valid URL |
| data[].summary_of_credit_terms.asset_urls.html string Returned | URL to the HTML version of the asset. Allowable Values: Valid URL |
| data[].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[].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[].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[].summary_of_credit_terms.template_urls.html string Returned | URL to the HTML version of the document template. Allowable Values: Valid URL |
| data[].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[].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[].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[].rewards_disclosure.asset_urls object Conditionally returned | Contains one or more URLs for an asset. Allowable Values: One or more asset_urls objects |
| data[].rewards_disclosure.asset_urls.pdf string Returned | URL to the PDF version of the asset. Allowable Values: Valid URL |
| data[].rewards_disclosure.asset_urls.png string Returned | URL to the PNG version of the asset. Allowable Values: Valid URL |
| data[].rewards_disclosure.asset_urls.html string Returned | URL to the HTML version of the asset. Allowable Values: Valid URL |
| data[].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[].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[].rewards_disclosure.template_urls object Conditionally returned | Contains one or more URLs for a template. Allowable Values: One or more template_urls objects |
| data[].rewards_disclosure.template_urls.html string Returned | URL to the HTML version of the document template. Allowable Values: Valid URL |
| data[].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[].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[].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[].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[].pre_qualification_disclosure.asset_urls.pdf string Returned | URL to the PDF version of the asset. Allowable Values: Valid URL |
| data[].pre_qualification_disclosure.asset_urls.png string Returned | URL to the PNG version of the asset. Allowable Values: Valid URL |
| data[].pre_qualification_disclosure.asset_urls.html string Returned | URL to the HTML version of the asset. Allowable Values: Valid URL |
| data[].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[].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[].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[].pre_qualification_disclosure.template_urls.html string Returned | URL to the HTML version of the document template. Allowable Values: Valid URL |
| data[].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[].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[].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[].terms_schedule.template_urls object Conditionally returned | Contains one or more URLs for a template. Allowable Values: One or more template_urls objects |
| data[].terms_schedule.template_urls.html string Returned | URL to the HTML version of the document template. Allowable Values: Valid URL |
| data[].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[].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[].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[].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[].benefits_disclosure_traditional.asset_urls.pdf string Returned | URL to the PDF version of the asset. Allowable Values: Valid URL |
| data[].benefits_disclosure_traditional.asset_urls.png string Returned | URL to the PNG version of the asset. Allowable Values: Valid URL |
| data[].benefits_disclosure_traditional.asset_urls.html string Returned | URL to the HTML version of the asset. Allowable Values: Valid URL |
| data[].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[].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[].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[].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[].benefits_disclosure_premium.asset_urls.pdf string Returned | URL to the PDF version of the asset. Allowable Values: Valid URL |
| data[].benefits_disclosure_premium.asset_urls.png string Returned | URL to the PNG version of the asset. Allowable Values: Valid URL |
| data[].benefits_disclosure_premium.asset_urls.html string Returned | URL to the HTML version of the asset. Allowable Values: Valid URL |
| data[].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[].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[].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[].privacy_policy.asset_urls object Conditionally returned | Contains one or more URLs for an asset. Allowable Values: One or more asset_urls objects |
| data[].privacy_policy.asset_urls.pdf string Returned | URL to the PDF version of the asset. Allowable Values: Valid URL |
| data[].privacy_policy.asset_urls.png string Returned | URL to the PNG version of the asset. Allowable Values: Valid URL |
| data[].privacy_policy.asset_urls.html string Returned | URL to the HTML version of the asset. Allowable Values: Valid URL |
| data[].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[].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[].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[].e_disclosure.asset_urls object Conditionally returned | Contains one or more URLs for an asset. Allowable Values: One or more asset_urls objects |
| data[].e_disclosure.asset_urls.pdf string Returned | URL to the PDF version of the asset. Allowable Values: Valid URL |
| data[].e_disclosure.asset_urls.png string Returned | URL to the PNG version of the asset. Allowable Values: Valid URL |
| data[].e_disclosure.asset_urls.html string Returned | URL to the HTML version of the asset. Allowable Values: Valid URL |
| data[].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[].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[].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[].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[].card_member_agreement.asset_urls.pdf string Returned | URL to the PDF version of the asset. Allowable Values: Valid URL |
| data[].card_member_agreement.asset_urls.png string Returned | URL to the PNG version of the asset. Allowable Values: Valid URL |
| data[].card_member_agreement.asset_urls.html string Returned | URL to the HTML version of the asset. Allowable Values: Valid URL |
| data[].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[].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[].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[].account_statement.template_urls object Conditionally returned | Contains one or more URLs for a template. Allowable Values: One or more template_urls objects |
| data[].account_statement.template_urls.html string Returned | URL to the HTML version of the document template. Allowable Values: Valid URL |
| data[].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[].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[].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[].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[].noaa_single_reason.template_urls.html string Returned | URL to the HTML version of the document template. Allowable Values: Valid URL |
| data[].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[].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[].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[].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[].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[].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[].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[].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[].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[].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[].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[].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[].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 |
Sample response body
JSON
Retrieve document policy
Action:GETEndpoint:
/credit/policies/documents/{token}
Retrieve a specific document policy, which consists of all the pre- and post-application disclosures and credit program documents known as assets and templates. Assets contain finalized values after a bundle is created; templates do not contain finalized values.
URL path parameters
| Fields | Description |
|---|---|
| token string Required | Unique identifier of the document policy to retrieve. Send a GET request to /policies/documents to retrieve existing document policy tokens.Allowable Values: Existing document policy token |
Response body
| Fields | Description |
|---|---|
| token string Conditionally returned | Unique identifier of the document policy. Allowable Values: 36 char max |
| name string Conditionally returned | Name of the document policy. Allowable Values: 255 char max |
| 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 |
| 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 |
| 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 |
| summary_of_credit_terms.asset_urls.pdf string Returned | URL to the PDF version of the asset. Allowable Values: Valid URL |
| summary_of_credit_terms.asset_urls.png string Returned | URL to the PNG version of the asset. Allowable Values: Valid URL |
| summary_of_credit_terms.asset_urls.html string Returned | URL to the HTML version of the asset. Allowable Values: Valid URL |
| 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 |
| 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 |
| 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 |
| summary_of_credit_terms.template_urls.html string Returned | URL to the HTML version of the document template. Allowable Values: Valid URL |
| 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 |
| 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 |
| 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 |
| rewards_disclosure.asset_urls object Conditionally returned | Contains one or more URLs for an asset. Allowable Values: One or more asset_urls objects |
| rewards_disclosure.asset_urls.pdf string Returned | URL to the PDF version of the asset. Allowable Values: Valid URL |
| rewards_disclosure.asset_urls.png string Returned | URL to the PNG version of the asset. Allowable Values: Valid URL |
| rewards_disclosure.asset_urls.html string Returned | URL to the HTML version of the asset. Allowable Values: Valid URL |
| rewards_disclosure.asset_created_time datetime Conditionally returned | Date and time when the asset was created. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
| 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 |
| rewards_disclosure.template_urls object Conditionally returned | Contains one or more URLs for a template. Allowable Values: One or more template_urls objects |
| rewards_disclosure.template_urls.html string Returned | URL to the HTML version of the document template. Allowable Values: Valid URL |
| rewards_disclosure.template_created_time datetime Conditionally returned | Date and time when the template was created. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
| 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 |
| 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 |
| pre_qualification_disclosure.asset_urls object Conditionally returned | Contains one or more URLs for an asset. Allowable Values: One or more asset_urls objects |
| pre_qualification_disclosure.asset_urls.pdf string Returned | URL to the PDF version of the asset. Allowable Values: Valid URL |
| pre_qualification_disclosure.asset_urls.png string Returned | URL to the PNG version of the asset. Allowable Values: Valid URL |
| pre_qualification_disclosure.asset_urls.html string Returned | URL to the HTML version of the asset. Allowable Values: Valid URL |
| 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 |
| 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 |
| pre_qualification_disclosure.template_urls object Conditionally returned | Contains one or more URLs for a template. Allowable Values: One or more template_urls objects |
| pre_qualification_disclosure.template_urls.html string Returned | URL to the HTML version of the document template. Allowable Values: Valid URL |
| 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 |
| 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 |
| 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 |
| terms_schedule.template_urls object Conditionally returned | Contains one or more URLs for a template. Allowable Values: One or more template_urls objects |
| terms_schedule.template_urls.html string Returned | URL to the HTML version of the document template. Allowable Values: Valid URL |
| terms_schedule.template_created_time datetime Conditionally returned | Date and time when the template was created. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
| 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 |
| 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 |
| benefits_disclosure_traditional.asset_urls object Conditionally returned | Contains one or more URLs for an asset. Allowable Values: One or more asset_urls objects |
| benefits_disclosure_traditional.asset_urls.pdf string Returned | URL to the PDF version of the asset. Allowable Values: Valid URL |
| benefits_disclosure_traditional.asset_urls.png string Returned | URL to the PNG version of the asset. Allowable Values: Valid URL |
| benefits_disclosure_traditional.asset_urls.html string Returned | URL to the HTML version of the asset. Allowable Values: Valid URL |
| 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 |
| 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 |
| 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 |
| benefits_disclosure_premium.asset_urls object Conditionally returned | Contains one or more URLs for an asset. Allowable Values: One or more asset_urls objects |
| benefits_disclosure_premium.asset_urls.pdf string Returned | URL to the PDF version of the asset. Allowable Values: Valid URL |
| benefits_disclosure_premium.asset_urls.png string Returned | URL to the PNG version of the asset. Allowable Values: Valid URL |
| benefits_disclosure_premium.asset_urls.html string Returned | URL to the HTML version of the asset. Allowable Values: Valid URL |
| 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 |
| 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 |
| 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 |
| privacy_policy.asset_urls object Conditionally returned | Contains one or more URLs for an asset. Allowable Values: One or more asset_urls objects |
| privacy_policy.asset_urls.pdf string Returned | URL to the PDF version of the asset. Allowable Values: Valid URL |
| privacy_policy.asset_urls.png string Returned | URL to the PNG version of the asset. Allowable Values: Valid URL |
| privacy_policy.asset_urls.html string Returned | URL to the HTML version of the asset. Allowable Values: Valid URL |
| privacy_policy.asset_created_time datetime Conditionally returned | Date and time when the asset was created. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
| 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 |
| 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 |
| e_disclosure.asset_urls object Conditionally returned | Contains one or more URLs for an asset. Allowable Values: One or more asset_urls objects |
| e_disclosure.asset_urls.pdf string Returned | URL to the PDF version of the asset. Allowable Values: Valid URL |
| e_disclosure.asset_urls.png string Returned | URL to the PNG version of the asset. Allowable Values: Valid URL |
| e_disclosure.asset_urls.html string Returned | URL to the HTML version of the asset. Allowable Values: Valid URL |
| e_disclosure.asset_created_time datetime Conditionally returned | Date and time when the asset was created. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
| 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 |
| 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 |
| card_member_agreement.asset_urls object Conditionally returned | Contains one or more URLs for an asset. Allowable Values: One or more asset_urls objects |
| card_member_agreement.asset_urls.pdf string Returned | URL to the PDF version of the asset. Allowable Values: Valid URL |
| card_member_agreement.asset_urls.png string Returned | URL to the PNG version of the asset. Allowable Values: Valid URL |
| card_member_agreement.asset_urls.html string Returned | URL to the HTML version of the asset. Allowable Values: Valid URL |
| 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 |
| 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 |
| 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 |
| account_statement.template_urls object Conditionally returned | Contains one or more URLs for a template. Allowable Values: One or more template_urls objects |
| account_statement.template_urls.html string Returned | URL to the HTML version of the document template. Allowable Values: Valid URL |
| account_statement.template_created_time datetime Conditionally returned | Date and time when the template was created. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
| 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 |
| 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 |
| noaa_single_reason.template_urls object Conditionally returned | Contains one or more URLs for a template. Allowable Values: One or more template_urls objects |
| noaa_single_reason.template_urls.html string Returned | URL to the HTML version of the document template. Allowable Values: Valid URL |
| 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 |
| 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 |
| 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 |
| 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 |
| noaa_single_reason_with_dodd_frank.template_urls.html string Returned | URL to the HTML version of the document template. Allowable Values: Valid URL |
| 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 |
| 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 |
| 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 |
| 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 |
| noaa_multiple_reason_with_dodd_frank.template_urls.html string Returned | URL to the HTML version of the document template. Allowable Values: Valid URL |
| 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 |
| 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 |
| 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 |
Sample response body
JSON
Update document policy
Action:PUTEndpoint:
/credit/policies/documents/{token}
Update a specific document policy, which consists of all the pre- and post-application disclosures and credit program documents known as assets and templates. Assets contain finalized values after a bundle is created; templates do not contain finalized values.
URL path parameters
| Fields | Description |
|---|---|
| token string Required | Unique identifier of the document policy to update. Send a GET request to /policies/documents to retrieve existing document policy tokens.Allowable Values: Existing document policy token |
Request body
| Fields | Description |
|---|---|
| name string Required | Name of the document policy. Allowable Values: 255 char max |
| summary_of_credit_terms object Required | 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 |
| summary_of_credit_terms.asset_token string Required | 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 |
| summary_of_credit_terms.template_token string Required | Unique identifier of the template, which is the version of a document that serves as an initial disclosure but does not contain finalized values. The values are finalized in the asset version of the document. Allowable Values: Existing template token for the SOCT or Rewards Disclosure |
| rewards_disclosure object Optional | 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 |
| rewards_disclosure.asset_token string Required | 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 |
| rewards_disclosure.template_token string Required | Unique identifier of the template, which is the version of a document that serves as an initial disclosure but does not contain finalized values. The values are finalized in the asset version of the document. Allowable Values: Existing template token for the SOCT or Rewards Disclosure |
| pre_qualification_disclosure object Optional | 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 |
| pre_qualification_disclosure.asset_token string Required | 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 |
| pre_qualification_disclosure.template_token string Required | Unique identifier of the template, which is the version of a document that serves as an initial disclosure but does not contain finalized values. The values are finalized in the asset version of the document. Allowable Values: Existing template token for the SOCT or Rewards Disclosure |
| terms_schedule object Required | 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 |
| terms_schedule.template_token string Required | 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 |
| benefits_disclosure_traditional object Required | 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 |
| benefits_disclosure_traditional.asset_token string Required | 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 |
| benefits_disclosure_premium object Required | 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 |
| benefits_disclosure_premium.asset_token string Required | 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 |
| privacy_policy object Required | 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 |
| privacy_policy.asset_token string Required | 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 |
| e_disclosure object Required | 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 |
| e_disclosure.asset_token string Required | 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 |
| card_member_agreement object Required | 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 |
| card_member_agreement.asset_token string Required | 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 |
| account_statement object Required | 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 |
| account_statement.template_token string Required | 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 |
| noaa_single_reason object Required | 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 |
| noaa_single_reason.template_token string Required | 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 |
| noaa_single_reason_with_dodd_frank object Required | 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 |
| noaa_single_reason_with_dodd_frank.template_token string Required | 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 |
| noaa_multiple_reason_with_dodd_frank object Required | 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 |
| noaa_multiple_reason_with_dodd_frank.template_token string Required | 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 |
Sample request body
JSON
Response body
| Fields | Description |
|---|---|
| token string Conditionally returned | Unique identifier of the document policy. Allowable Values: 36 char max |
| name string Conditionally returned | Name of the document policy. Allowable Values: 255 char max |
| 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 |
| 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 |
| 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 |
| summary_of_credit_terms.asset_urls.pdf string Returned | URL to the PDF version of the asset. Allowable Values: Valid URL |
| summary_of_credit_terms.asset_urls.png string Returned | URL to the PNG version of the asset. Allowable Values: Valid URL |
| summary_of_credit_terms.asset_urls.html string Returned | URL to the HTML version of the asset. Allowable Values: Valid URL |
| 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 |
| 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 |
| 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 |
| summary_of_credit_terms.template_urls.html string Returned | URL to the HTML version of the document template. Allowable Values: Valid URL |
| 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 |
| 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 |
| 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 |
| rewards_disclosure.asset_urls object Conditionally returned | Contains one or more URLs for an asset. Allowable Values: One or more asset_urls objects |
| rewards_disclosure.asset_urls.pdf string Returned | URL to the PDF version of the asset. Allowable Values: Valid URL |
| rewards_disclosure.asset_urls.png string Returned | URL to the PNG version of the asset. Allowable Values: Valid URL |
| rewards_disclosure.asset_urls.html string Returned | URL to the HTML version of the asset. Allowable Values: Valid URL |
| rewards_disclosure.asset_created_time datetime Conditionally returned | Date and time when the asset was created. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
| 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 |
| rewards_disclosure.template_urls object Conditionally returned | Contains one or more URLs for a template. Allowable Values: One or more template_urls objects |
| rewards_disclosure.template_urls.html string Returned | URL to the HTML version of the document template. Allowable Values: Valid URL |
| rewards_disclosure.template_created_time datetime Conditionally returned | Date and time when the template was created. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
| 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 |
| 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 |
| pre_qualification_disclosure.asset_urls object Conditionally returned | Contains one or more URLs for an asset. Allowable Values: One or more asset_urls objects |
| pre_qualification_disclosure.asset_urls.pdf string Returned | URL to the PDF version of the asset. Allowable Values: Valid URL |
| pre_qualification_disclosure.asset_urls.png string Returned | URL to the PNG version of the asset. Allowable Values: Valid URL |
| pre_qualification_disclosure.asset_urls.html string Returned | URL to the HTML version of the asset. Allowable Values: Valid URL |
| 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 |
| 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 |
| pre_qualification_disclosure.template_urls object Conditionally returned | Contains one or more URLs for a template. Allowable Values: One or more template_urls objects |
| pre_qualification_disclosure.template_urls.html string Returned | URL to the HTML version of the document template. Allowable Values: Valid URL |
| 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 |
| 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 |
| 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 |
| terms_schedule.template_urls object Conditionally returned | Contains one or more URLs for a template. Allowable Values: One or more template_urls objects |
| terms_schedule.template_urls.html string Returned | URL to the HTML version of the document template. Allowable Values: Valid URL |
| terms_schedule.template_created_time datetime Conditionally returned | Date and time when the template was created. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
| 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 |
| 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 |
| benefits_disclosure_traditional.asset_urls object Conditionally returned | Contains one or more URLs for an asset. Allowable Values: One or more asset_urls objects |
| benefits_disclosure_traditional.asset_urls.pdf string Returned | URL to the PDF version of the asset. Allowable Values: Valid URL |
| benefits_disclosure_traditional.asset_urls.png string Returned | URL to the PNG version of the asset. Allowable Values: Valid URL |
| benefits_disclosure_traditional.asset_urls.html string Returned | URL to the HTML version of the asset. Allowable Values: Valid URL |
| 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 |
| 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 |
| 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 |
| benefits_disclosure_premium.asset_urls object Conditionally returned | Contains one or more URLs for an asset. Allowable Values: One or more asset_urls objects |
| benefits_disclosure_premium.asset_urls.pdf string Returned | URL to the PDF version of the asset. Allowable Values: Valid URL |
| benefits_disclosure_premium.asset_urls.png string Returned | URL to the PNG version of the asset. Allowable Values: Valid URL |
| benefits_disclosure_premium.asset_urls.html string Returned | URL to the HTML version of the asset. Allowable Values: Valid URL |
| 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 |
| 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 |
| 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 |
| privacy_policy.asset_urls object Conditionally returned | Contains one or more URLs for an asset. Allowable Values: One or more asset_urls objects |
| privacy_policy.asset_urls.pdf string Returned | URL to the PDF version of the asset. Allowable Values: Valid URL |
| privacy_policy.asset_urls.png string Returned | URL to the PNG version of the asset. Allowable Values: Valid URL |
| privacy_policy.asset_urls.html string Returned | URL to the HTML version of the asset. Allowable Values: Valid URL |
| privacy_policy.asset_created_time datetime Conditionally returned | Date and time when the asset was created. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
| 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 |
| 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 |
| e_disclosure.asset_urls object Conditionally returned | Contains one or more URLs for an asset. Allowable Values: One or more asset_urls objects |
| e_disclosure.asset_urls.pdf string Returned | URL to the PDF version of the asset. Allowable Values: Valid URL |
| e_disclosure.asset_urls.png string Returned | URL to the PNG version of the asset. Allowable Values: Valid URL |
| e_disclosure.asset_urls.html string Returned | URL to the HTML version of the asset. Allowable Values: Valid URL |
| e_disclosure.asset_created_time datetime Conditionally returned | Date and time when the asset was created. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
| 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 |
| 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 |
| card_member_agreement.asset_urls object Conditionally returned | Contains one or more URLs for an asset. Allowable Values: One or more asset_urls objects |
| card_member_agreement.asset_urls.pdf string Returned | URL to the PDF version of the asset. Allowable Values: Valid URL |
| card_member_agreement.asset_urls.png string Returned | URL to the PNG version of the asset. Allowable Values: Valid URL |
| card_member_agreement.asset_urls.html string Returned | URL to the HTML version of the asset. Allowable Values: Valid URL |
| 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 |
| 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 |
| 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 |
| account_statement.template_urls object Conditionally returned | Contains one or more URLs for a template. Allowable Values: One or more template_urls objects |
| account_statement.template_urls.html string Returned | URL to the HTML version of the document template. Allowable Values: Valid URL |
| account_statement.template_created_time datetime Conditionally returned | Date and time when the template was created. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
| 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 |
| 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 |
| noaa_single_reason.template_urls object Conditionally returned | Contains one or more URLs for a template. Allowable Values: One or more template_urls objects |
| noaa_single_reason.template_urls.html string Returned | URL to the HTML version of the document template. Allowable Values: Valid URL |
| 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 |
| 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 |
| 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 |
| 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 |
| noaa_single_reason_with_dodd_frank.template_urls.html string Returned | URL to the HTML version of the document template. Allowable Values: Valid URL |
| 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 |
| 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 |
| 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 |
| 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 |
| noaa_multiple_reason_with_dodd_frank.template_urls.html string Returned | URL to the HTML version of the document template. Allowable Values: Valid URL |
| 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 |
| 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 |
| 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 |
Sample response body
JSON
Clone document policy
Action:POSTEndpoint:
/credit/policies/documents/{token}/clone
Create a new document policy based on an existing document policy. A document policy consists of all the pre- and post-application disclosures and credit program documents known as assets and templates. Assets contain finalized values after a bundle is created; templates do not contain finalized values.
URL path parameters
| Fields | Description |
|---|---|
| token string Required | Unique identifier of the document policy to clone. Send a GET request to /policies/documents to retrieve existing document policy tokens.Allowable Values: Existing document policy token |
Response body
| Fields | Description |
|---|---|
| token string Conditionally returned | Unique identifier of the document policy. Allowable Values: 36 char max |
| name string Conditionally returned | Name of the document policy. Allowable Values: 255 char max |
| 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 |
| 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 |
| 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 |
| summary_of_credit_terms.asset_urls.pdf string Returned | URL to the PDF version of the asset. Allowable Values: Valid URL |
| summary_of_credit_terms.asset_urls.png string Returned | URL to the PNG version of the asset. Allowable Values: Valid URL |
| summary_of_credit_terms.asset_urls.html string Returned | URL to the HTML version of the asset. Allowable Values: Valid URL |
| 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 |
| 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 |
| 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 |
| summary_of_credit_terms.template_urls.html string Returned | URL to the HTML version of the document template. Allowable Values: Valid URL |
| 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 |
| 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 |
| 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 |
| rewards_disclosure.asset_urls object Conditionally returned | Contains one or more URLs for an asset. Allowable Values: One or more asset_urls objects |
| rewards_disclosure.asset_urls.pdf string Returned | URL to the PDF version of the asset. Allowable Values: Valid URL |
| rewards_disclosure.asset_urls.png string Returned | URL to the PNG version of the asset. Allowable Values: Valid URL |
| rewards_disclosure.asset_urls.html string Returned | URL to the HTML version of the asset. Allowable Values: Valid URL |
| rewards_disclosure.asset_created_time datetime Conditionally returned | Date and time when the asset was created. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
| 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 |
| rewards_disclosure.template_urls object Conditionally returned | Contains one or more URLs for a template. Allowable Values: One or more template_urls objects |
| rewards_disclosure.template_urls.html string Returned | URL to the HTML version of the document template. Allowable Values: Valid URL |
| rewards_disclosure.template_created_time datetime Conditionally returned | Date and time when the template was created. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
| 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 |
| 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 |
| pre_qualification_disclosure.asset_urls object Conditionally returned | Contains one or more URLs for an asset. Allowable Values: One or more asset_urls objects |
| pre_qualification_disclosure.asset_urls.pdf string Returned | URL to the PDF version of the asset. Allowable Values: Valid URL |
| pre_qualification_disclosure.asset_urls.png string Returned | URL to the PNG version of the asset. Allowable Values: Valid URL |
| pre_qualification_disclosure.asset_urls.html string Returned | URL to the HTML version of the asset. Allowable Values: Valid URL |
| 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 |
| 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 |
| pre_qualification_disclosure.template_urls object Conditionally returned | Contains one or more URLs for a template. Allowable Values: One or more template_urls objects |
| pre_qualification_disclosure.template_urls.html string Returned | URL to the HTML version of the document template. Allowable Values: Valid URL |
| 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 |
| 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 |
| 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 |
| terms_schedule.template_urls object Conditionally returned | Contains one or more URLs for a template. Allowable Values: One or more template_urls objects |
| terms_schedule.template_urls.html string Returned | URL to the HTML version of the document template. Allowable Values: Valid URL |
| terms_schedule.template_created_time datetime Conditionally returned | Date and time when the template was created. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
| 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 |
| 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 |
| benefits_disclosure_traditional.asset_urls object Conditionally returned | Contains one or more URLs for an asset. Allowable Values: One or more asset_urls objects |
| benefits_disclosure_traditional.asset_urls.pdf string Returned | URL to the PDF version of the asset. Allowable Values: Valid URL |
| benefits_disclosure_traditional.asset_urls.png string Returned | URL to the PNG version of the asset. Allowable Values: Valid URL |
| benefits_disclosure_traditional.asset_urls.html string Returned | URL to the HTML version of the asset. Allowable Values: Valid URL |
| 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 |
| 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 |
| 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 |
| benefits_disclosure_premium.asset_urls object Conditionally returned | Contains one or more URLs for an asset. Allowable Values: One or more asset_urls objects |
| benefits_disclosure_premium.asset_urls.pdf string Returned | URL to the PDF version of the asset. Allowable Values: Valid URL |
| benefits_disclosure_premium.asset_urls.png string Returned | URL to the PNG version of the asset. Allowable Values: Valid URL |
| benefits_disclosure_premium.asset_urls.html string Returned | URL to the HTML version of the asset. Allowable Values: Valid URL |
| 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 |
| 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 |
| 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 |
| privacy_policy.asset_urls object Conditionally returned | Contains one or more URLs for an asset. Allowable Values: One or more asset_urls objects |
| privacy_policy.asset_urls.pdf string Returned | URL to the PDF version of the asset. Allowable Values: Valid URL |
| privacy_policy.asset_urls.png string Returned | URL to the PNG version of the asset. Allowable Values: Valid URL |
| privacy_policy.asset_urls.html string Returned | URL to the HTML version of the asset. Allowable Values: Valid URL |
| privacy_policy.asset_created_time datetime Conditionally returned | Date and time when the asset was created. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
| 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 |
| 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 |
| e_disclosure.asset_urls object Conditionally returned | Contains one or more URLs for an asset. Allowable Values: One or more asset_urls objects |
| e_disclosure.asset_urls.pdf string Returned | URL to the PDF version of the asset. Allowable Values: Valid URL |
| e_disclosure.asset_urls.png string Returned | URL to the PNG version of the asset. Allowable Values: Valid URL |
| e_disclosure.asset_urls.html string Returned | URL to the HTML version of the asset. Allowable Values: Valid URL |
| e_disclosure.asset_created_time datetime Conditionally returned | Date and time when the asset was created. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
| 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 |
| 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 |
| card_member_agreement.asset_urls object Conditionally returned | Contains one or more URLs for an asset. Allowable Values: One or more asset_urls objects |
| card_member_agreement.asset_urls.pdf string Returned | URL to the PDF version of the asset. Allowable Values: Valid URL |
| card_member_agreement.asset_urls.png string Returned | URL to the PNG version of the asset. Allowable Values: Valid URL |
| card_member_agreement.asset_urls.html string Returned | URL to the HTML version of the asset. Allowable Values: Valid URL |
| 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 |
| 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 |
| 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 |
| account_statement.template_urls object Conditionally returned | Contains one or more URLs for a template. Allowable Values: One or more template_urls objects |
| account_statement.template_urls.html string Returned | URL to the HTML version of the document template. Allowable Values: Valid URL |
| account_statement.template_created_time datetime Conditionally returned | Date and time when the template was created. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
| 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 |
| 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 |
| noaa_single_reason.template_urls object Conditionally returned | Contains one or more URLs for a template. Allowable Values: One or more template_urls objects |
| noaa_single_reason.template_urls.html string Returned | URL to the HTML version of the document template. Allowable Values: Valid URL |
| 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 |
| 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 |
| 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 |
| 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 |
| noaa_single_reason_with_dodd_frank.template_urls.html string Returned | URL to the HTML version of the document template. Allowable Values: Valid URL |
| 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 |
| 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 |
| 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 |
| 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 |
| noaa_multiple_reason_with_dodd_frank.template_urls.html string Returned | URL to the HTML version of the document template. Allowable Values: Valid URL |
| 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 |
| 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 |
| 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 |
Sample response body
JSON
Create credit product policy
Action:POSTEndpoint:
/credit/policies/products
Create a new credit product policy.
Request body
| Fields | Description |
|---|---|
| token string Optional | Unique identifier of the credit product policy. Allowable Values: 36 char max |
| card_products array of objects Required | One or more card products associated with the credit product policy. Allowable Values: One or more card_products objects |
| card_products[].token string Required | Unique identifier of the card product. Allowable Values: 36 char max |
| card_products[].level string Required | Level of the card product. Allowable Values: PREMIUM, TRADITIONAL |
| name string Required | Name of the credit product policy. Allowable Values: 1 char min |
| description string Optional | Description of the credit product policy. Allowable Values: 255 char max |
| classification string Required | Specifies for whom the credit product is intended. - CONSUMER - The credit product is intended for individual consumers.- SMALL_AND_MEDIUM_BUSINESS - The credit product is intended for small and medium business.Allowable Values: CONSUMER, SMALL_AND_MEDIUM_BUSINESS |
| product_type string Required | Type of credit product.REVOLVING - Allows users to continuously borrow and pay debts up to the credit limit.Allowable Values: REVOLVING |
| product_sub_type string Required | Subtype of the credit product type. - CREDIT_CARD - Card that enables the cardholder to make purchases on credit.- SECURED_CARD - Card backed by a user-funded deposit that enables the cardholder to make purchases on credit.Allowable Values: CREDIT_CARD, SECURED_CARD |
| currency_code string Required | Valid three-digit ISO 4217 currency code. Allowable Values: USD |
| credit_line object Required | Contains information on the credit line range. Allowable Values: Existing credit_line object |
| credit_line.min decimal Required | Minimum credit limit. Allowable Values: 0–999999999999.99 |
| credit_line.max decimal Required | Maximum credit limit. Allowable Values: 0–999999999999.99 |
| usage array of strings Required | One or more usage types for the credit product policy. Allowable Values: PURCHASE |
| interest_calculation object Required | Contains the configurations for interest calculation. Allowable Values: Existing interest_calculation object |
| interest_calculation.method string Required | Method of interest calculation. Allowable Values: AVG_DAILY_BALANCE_WITH_NEW_TRANSACTIONS |
| interest_calculation.day_count string Required | Day-count convention. Allowable Values: ACTUAL |
| interest_calculation.interest_application array of strings Required | One or more balance types on which interest is applied. Allowable Values: PRINCIPAL, FEES, INTEREST |
| interest_calculation.minimum_interest decimal Required | When interest is applied, this value determines the minimum amount of interest that can be charged. Allowable Values: 0–999999999999.99 |
| interest_calculation.interest_on_grace_reactivation string Required | Determines whether to charge or waive interest for the billing period when the balance is paid off. Allowable Values: ACCRUE_FULL_CYCLE, ACCRUE_PAYMENT_DATE, WAIVE |
| interest_calculation.grace_days_application string Required | Determines the last day of grace period based on which interest charges are calculated. Allowable Values: NEXT_CYCLE_DATE |
| interest_calculation.exclude_tran_types array of strings Optional | One or more transactions that are excluded from current billing period’s interest charge, but included in next. Allowable Values: LATE_PAYMENT_FEE, ANNUAL_FEE, MONTHLY_FEE, CASH_BACK_STATEMENT_CREDIT, RETURNED_PAYMENT_FEE, FOREIGN_TRANSACTION_FEE |
| payments object Required | Contains the configurations for billing cycle day, payment due day, and fees. Allowable Values: Existing payments object |
| payments.billing_cycle_day integer Required | Day of the month when the billing cycle starts. Allowable Values: 1–28 |
| payments.due_day integer Optional | 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 |
| payments.billing_cycle_frequency string Optional | Frequency at which the account is billed. Allowable Values: MONTHLY |
| payments.payment_due_interval integer Optional | Specifies the payment due interval that is used to determine the payment due date for a billing cycle. A value of -1 indicates one day prior to the next billing cycle date. For consumer programs, a minimum gap of 21 days is required between when a statement is delivered and the payment due date. Allowable Values: -1 min Positive integers greater than 0; -1 is the default value |
| payments.billing_cycle_day_strategy string Optional | Determines if the billing cycle day is manually set or determined dynamically during account creation based on cycling logic. Allowable Values: MANUAL |
| payments.allocation_order array of strings Required | Ordered list of balance types to which payments are allocated, from first to last. Allowable Values: INTEREST, FEES, PRINCIPAL |
| payments.min_payment_calculation object Required | Contains information used to calculate the minimum payment amount on a credit product policy. Allowable Values: Existing min_payment_calculation object |
| payments.min_payment_calculation.include_past_due_amount boolean Required | Whether to include the past due amount when calculating the minimum payment. Allowable Values: true, false |
| payments.min_payment_calculation.include_overlimit_amount boolean Required | Whether to include the overlimit amount when calculating the minimum payment. Allowable Values: true, false |
| payments.min_payment_calculation.min_payment_flat_amount decimal Optional | Minimum payment, expressed as a flat amount, due on the payment due day. Allowable Values: Format: 0.00 |
| payments.min_payment_calculation.min_payment_percentage object Optional | Contains information used to calculate the minimum payment amount when expressed as a percentage. Allowable Values: Existing min_payment_percentage object |
| payments.min_payment_calculation.min_payment_percentage.percentage_of_balance decimal Required | Minimum payment, expressed as a percentage of the total statement balance, due on the payment due day. Allowable Values: 0.0001–100 |
| payments.min_payment_calculation.min_payment_percentage.include_interest_charged boolean Required | Whether to include the amount of interest charged when calculating the minimum payment. Allowable Values: true, false |
| payments.min_payment_calculation.min_payment_percentage.include_all_fees_charged boolean Optional | Whether to include all fees charged when calculating the minimum payment. Allowable Values: true, false |
Sample request body
JSON
Response body
| Fields | Description |
|---|---|
| token string Conditionally returned | Unique identifier of the credit product policy. Allowable Values: 36 char max |
| 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 |
| card_products[].token string Conditionally returned | Unique identifier of the card product. Allowable Values: 36 char max |
| card_products[].level string Conditionally returned | Level of the card product. Allowable Values: PREMIUM, TRADITIONAL |
| card_products[].network string Conditionally returned | Name of the card network. Allowable Values: VISA, MASTERCARD, SANDBOX |
| name string Conditionally returned | Name of the credit product policy. Allowable Values: 1 char min |
| description string Conditionally returned | Description of the credit product policy. Allowable Values: 255 char max |
| classification string Conditionally returned | Specifies for whom the credit product is intended. - CONSUMER - The credit product is intended for individual consumers.- SMALL_AND_MEDIUM_BUSINESS - The credit product is intended for small and medium business.Allowable Values: CONSUMER, SMALL_AND_MEDIUM_BUSINESS |
| product_type string Conditionally returned | Type of credit product.REVOLVING - Allows users to continuously borrow and pay debts up to the credit limit.Allowable Values: REVOLVING |
| product_sub_type string Conditionally returned | Subtype of the credit product type. - CREDIT_CARD - Card that enables the cardholder to make purchases on credit.- SECURED_CARD - Card backed by a user-funded deposit that enables the cardholder to make purchases on credit.Allowable Values: CREDIT_CARD, SECURED_CARD |
| currency_code string Conditionally returned | Valid three-digit ISO 4217 currency code. Allowable Values: USD |
| credit_line object Conditionally returned | Contains information on the credit line range. Allowable Values: Existing credit_line object |
| credit_line.min decimal Returned | Minimum credit limit. Allowable Values: 0–999999999999.99 |
| credit_line.max decimal Returned | Maximum credit limit. Allowable Values: 0–999999999999.99 |
| usage array of strings Conditionally returned | One or more usage types for the credit product policy. Allowable Values: PURCHASEValid usage array |
| interest_calculation object Conditionally returned | Contains the configurations for interest calculation. Allowable Values: Existing interest_calculation object |
| interest_calculation.method string Returned | Method of interest calculation. Allowable Values: AVG_DAILY_BALANCE_WITH_NEW_TRANSACTIONS |
| interest_calculation.day_count string Returned | Day-count convention. Allowable Values: ACTUAL |
| interest_calculation.interest_application array of strings Returned | One or more balance types on which interest is applied. Allowable Values: PRINCIPAL, FEES, INTEREST |
| interest_calculation.minimum_interest decimal Returned | When interest is applied, this value determines the minimum amount of interest that can be charged. Allowable Values: 0–999999999999.99 |
| interest_calculation.interest_on_grace_reactivation string Returned | Determines whether to charge or waive interest for the billing period when the balance is paid off. Allowable Values: ACCRUE_FULL_CYCLE, ACCRUE_PAYMENT_DATE, WAIVE |
| interest_calculation.grace_days_application string Returned | Determines the last day of grace period based on which interest charges are calculated. Allowable Values: NEXT_CYCLE_DATE |
| interest_calculation.exclude_tran_types array of strings Conditionally returned | One or more transactions that are excluded from current billing period’s interest charge, but included in next. Allowable Values: LATE_PAYMENT_FEE, ANNUAL_FEE, MONTHLY_FEE, CASH_BACK_STATEMENT_CREDIT, RETURNED_PAYMENT_FEE, FOREIGN_TRANSACTION_FEE |
| payments object Conditionally returned | Contains the configurations for billing cycle day, payment due day, and fees. Allowable Values: Existing payments object |
| payments.billing_cycle_day integer Returned | Day of the month when the billing cycle starts. Allowable Values: 1–28 |
| 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 |
| payments.billing_cycle_frequency string Conditionally returned | Frequency at which the account is billed. Allowable Values: MONTHLY |
| 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 |
| 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 |
| 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 |
| 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 |
| 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 |
| payments.min_payment_calculation.include_overlimit_amount boolean Returned | Whether to include the overlimit amount when calculating the minimum payment. Allowable Values: true, false |
| 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 |
| 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 |
| 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 |
| 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 |
| 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 |
| 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 |
| 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 |
Sample response body
JSON
List credit product policies
Action:GETEndpoint:
/credit/policies/products
Retrieve an array of existing credit product policies.
This endpoint supports sorting and pagination.
URL query parameters
| Fields | Description |
|---|---|
| count integer Optional | Number of product policy resources to retrieve. Allowable Values: 1–100 |
| start_index integer Optional | Sort order index of the first resource in the returned array. Allowable Values: 0 min |
| sort_by string Optional | Field on which to sort. Prefix the field name with a hyphen (-) to sort in descending order. Omit the hyphen to sort in ascending order.NOTE: You must sort using system field names such as lastModifiedTime, and not by the field names appearing in response bodies such as last_modified_time.Allowable Values: lastModifiedTime, -lastModifiedTime |
Response body
| 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 | One or more credit product policies. Allowable Values: One or more credit product policy objects |
| data[].token string Conditionally returned | Unique identifier of the credit product policy. Allowable Values: 36 char max |
| data[].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[].card_products[].token string Conditionally returned | Unique identifier of the card product. Allowable Values: 36 char max |
| data[].card_products[].level string Conditionally returned | Level of the card product. Allowable Values: PREMIUM, TRADITIONAL |
| data[].card_products[].network string Conditionally returned | Name of the card network. Allowable Values: VISA, MASTERCARD, SANDBOX |
| data[].name string Conditionally returned | Name of the credit product policy. Allowable Values: 1 char min |
| data[].description string Conditionally returned | Description of the credit product policy. Allowable Values: 255 char max |
| data[].classification string Conditionally returned | Specifies for whom the credit product is intended. - CONSUMER - The credit product is intended for individual consumers.- SMALL_AND_MEDIUM_BUSINESS - The credit product is intended for small and medium business.Allowable Values: CONSUMER, SMALL_AND_MEDIUM_BUSINESS |
| data[].product_type string Conditionally returned | Type of credit product.REVOLVING - Allows users to continuously borrow and pay debts up to the credit limit.Allowable Values: REVOLVING |
| data[].product_sub_type string Conditionally returned | Subtype of the credit product type. - CREDIT_CARD - Card that enables the cardholder to make purchases on credit.- SECURED_CARD - Card backed by a user-funded deposit that enables the cardholder to make purchases on credit.Allowable Values: CREDIT_CARD, SECURED_CARD |
| data[].currency_code string Conditionally returned | Valid three-digit ISO 4217 currency code. Allowable Values: USD |
| data[].credit_line object Conditionally returned | Contains information on the credit line range. Allowable Values: Existing credit_line object |
| data[].credit_line.min decimal Returned | Minimum credit limit. Allowable Values: 0–999999999999.99 |
| data[].credit_line.max decimal Returned | Maximum credit limit. Allowable Values: 0–999999999999.99 |
| data[].usage array of strings Conditionally returned | One or more usage types for the credit product policy. Allowable Values: PURCHASEValid usage array |
| data[].interest_calculation object Conditionally returned | Contains the configurations for interest calculation. Allowable Values: Existing interest_calculation object |
| data[].interest_calculation.method string Returned | Method of interest calculation. Allowable Values: AVG_DAILY_BALANCE_WITH_NEW_TRANSACTIONS |
| data[].interest_calculation.day_count string Returned | Day-count convention. Allowable Values: ACTUAL |
| data[].interest_calculation.interest_application array of strings Returned | One or more balance types on which interest is applied. Allowable Values: PRINCIPAL, FEES, INTEREST |
| data[].interest_calculation.minimum_interest decimal Returned | When interest is applied, this value determines the minimum amount of interest that can be charged. Allowable Values: 0–999999999999.99 |
| data[].interest_calculation.interest_on_grace_reactivation string Returned | Determines whether to charge or waive interest for the billing period when the balance is paid off. Allowable Values: ACCRUE_FULL_CYCLE, ACCRUE_PAYMENT_DATE, WAIVE |
| data[].interest_calculation.grace_days_application string Returned | Determines the last day of grace period based on which interest charges are calculated. Allowable Values: NEXT_CYCLE_DATE |
| data[].interest_calculation.exclude_tran_types array of strings Conditionally returned | One or more transactions that are excluded from current billing period’s interest charge, but included in next. Allowable Values: LATE_PAYMENT_FEE, ANNUAL_FEE, MONTHLY_FEE, CASH_BACK_STATEMENT_CREDIT, RETURNED_PAYMENT_FEE, FOREIGN_TRANSACTION_FEE |
| data[].payments object Conditionally returned | Contains the configurations for billing cycle day, payment due day, and fees. Allowable Values: Existing payments object |
| data[].payments.billing_cycle_day integer Returned | Day of the month when the billing cycle starts. Allowable Values: 1–28 |
| data[].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[].payments.billing_cycle_frequency string Conditionally returned | Frequency at which the account is billed. Allowable Values: MONTHLY |
| data[].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[].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[].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[].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[].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[].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[].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[].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[].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[].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[].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[].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[].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 |
Sample response body
JSON
Retrieve credit product policy
Action:GETEndpoint:
/credit/policies/products/{token}
Retrieve a specific credit product policy.
URL path parameters
| Fields | Description |
|---|---|
| token string Required | Unique identifier of the credit product policy to retrieve. Send a GET request to /policies/products to retrieve existing credit product policy tokens.Allowable Values: Existing credit product policy token |
Response body
| Fields | Description |
|---|---|
| token string Conditionally returned | Unique identifier of the credit product policy. Allowable Values: 36 char max |
| 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 |
| card_products[].token string Conditionally returned | Unique identifier of the card product. Allowable Values: 36 char max |
| card_products[].level string Conditionally returned | Level of the card product. Allowable Values: PREMIUM, TRADITIONAL |
| card_products[].network string Conditionally returned | Name of the card network. Allowable Values: VISA, MASTERCARD, SANDBOX |
| name string Conditionally returned | Name of the credit product policy. Allowable Values: 1 char min |
| description string Conditionally returned | Description of the credit product policy. Allowable Values: 255 char max |
| classification string Conditionally returned | Specifies for whom the credit product is intended. - CONSUMER - The credit product is intended for individual consumers.- SMALL_AND_MEDIUM_BUSINESS - The credit product is intended for small and medium business.Allowable Values: CONSUMER, SMALL_AND_MEDIUM_BUSINESS |
| product_type string Conditionally returned | Type of credit product.REVOLVING - Allows users to continuously borrow and pay debts up to the credit limit.Allowable Values: REVOLVING |
| product_sub_type string Conditionally returned | Subtype of the credit product type. - CREDIT_CARD - Card that enables the cardholder to make purchases on credit.- SECURED_CARD - Card backed by a user-funded deposit that enables the cardholder to make purchases on credit.Allowable Values: CREDIT_CARD, SECURED_CARD |
| currency_code string Conditionally returned | Valid three-digit ISO 4217 currency code. Allowable Values: USD |
| credit_line object Conditionally returned | Contains information on the credit line range. Allowable Values: Existing credit_line object |
| credit_line.min decimal Returned | Minimum credit limit. Allowable Values: 0–999999999999.99 |
| credit_line.max decimal Returned | Maximum credit limit. Allowable Values: 0–999999999999.99 |
| usage array of strings Conditionally returned | One or more usage types for the credit product policy. Allowable Values: PURCHASEValid usage array |
| interest_calculation object Conditionally returned | Contains the configurations for interest calculation. Allowable Values: Existing interest_calculation object |
| interest_calculation.method string Returned | Method of interest calculation. Allowable Values: AVG_DAILY_BALANCE_WITH_NEW_TRANSACTIONS |
| interest_calculation.day_count string Returned | Day-count convention. Allowable Values: ACTUAL |
| interest_calculation.interest_application array of strings Returned | One or more balance types on which interest is applied. Allowable Values: PRINCIPAL, FEES, INTEREST |
| interest_calculation.minimum_interest decimal Returned | When interest is applied, this value determines the minimum amount of interest that can be charged. Allowable Values: 0–999999999999.99 |
| interest_calculation.interest_on_grace_reactivation string Returned | Determines whether to charge or waive interest for the billing period when the balance is paid off. Allowable Values: ACCRUE_FULL_CYCLE, ACCRUE_PAYMENT_DATE, WAIVE |
| interest_calculation.grace_days_application string Returned | Determines the last day of grace period based on which interest charges are calculated. Allowable Values: NEXT_CYCLE_DATE |
| interest_calculation.exclude_tran_types array of strings Conditionally returned | One or more transactions that are excluded from current billing period’s interest charge, but included in next. Allowable Values: LATE_PAYMENT_FEE, ANNUAL_FEE, MONTHLY_FEE, CASH_BACK_STATEMENT_CREDIT, RETURNED_PAYMENT_FEE, FOREIGN_TRANSACTION_FEE |
| payments object Conditionally returned | Contains the configurations for billing cycle day, payment due day, and fees. Allowable Values: Existing payments object |
| payments.billing_cycle_day integer Returned | Day of the month when the billing cycle starts. Allowable Values: 1–28 |
| 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 |
| payments.billing_cycle_frequency string Conditionally returned | Frequency at which the account is billed. Allowable Values: MONTHLY |
| 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 |
| 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 |
| 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 |
| 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 |
| 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 |
| payments.min_payment_calculation.include_overlimit_amount boolean Returned | Whether to include the overlimit amount when calculating the minimum payment. Allowable Values: true, false |
| 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 |
| 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 |
| 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 |
| 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 |
| 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 |
| 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 |
| 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 |
Sample response body
JSON
Update credit product policy
Action:PUTEndpoint:
/credit/policies/products/{token}
Update a specific credit product policy.
URL path parameters
| Fields | Description |
|---|---|
| token string Required | Unique identifier of the credit product policy to retrieve. Send a GET request to /policies/products to retrieve existing credit product policy tokens.Allowable Values: Existing credit product policy token |
Request body
| Fields | Description |
|---|---|
| card_products array of objects Required | One or more card products associated with the credit product policy. Allowable Values: One or more card_products objects |
| card_products[].token string Required | Unique identifier of the card product. Allowable Values: 36 char max |
| card_products[].level string Required | Level of the card product. Allowable Values: PREMIUM, TRADITIONAL |
| name string Required | Name of the credit product policy. Allowable Values: 1 char min |
| description string Optional | Description of the credit product policy. Allowable Values: 255 char max |
| classification string Required | Specifies for whom the credit product is intended. - CONSUMER - The credit product is intended for individual consumers.- SMALL_AND_MEDIUM_BUSINESS - The credit product is intended for small and medium business.Allowable Values: CONSUMER, SMALL_AND_MEDIUM_BUSINESS |
| product_type string Required | Type of credit product.REVOLVING - Allows users to continuously borrow and pay debts up to the credit limit.Allowable Values: REVOLVING |
| product_sub_type string Required | Subtype of the credit product type. - CREDIT_CARD - Card that enables the cardholder to make purchases on credit.- SECURED_CARD - Card backed by a user-funded deposit that enables the cardholder to make purchases on credit.Allowable Values: CREDIT_CARD, SECURED_CARD |
| currency_code string Required | Valid three-digit ISO 4217 currency code. Allowable Values: USD |
| credit_line object Required | Contains information on the credit line range. Allowable Values: Existing credit_line object |
| credit_line.min decimal Required | Minimum credit limit. Allowable Values: 0–999999999999.99 |
| credit_line.max decimal Required | Maximum credit limit. Allowable Values: 0–999999999999.99 |
| usage array of strings Required | One or more usage types for the credit product policy. Allowable Values: PURCHASE |
| interest_calculation object Required | Contains the configurations for interest calculation. Allowable Values: Existing interest_calculation object |
| interest_calculation.method string Required | Method of interest calculation. Allowable Values: AVG_DAILY_BALANCE_WITH_NEW_TRANSACTIONS |
| interest_calculation.day_count string Required | Day-count convention. Allowable Values: ACTUAL |
| interest_calculation.interest_application array of strings Required | One or more balance types on which interest is applied. Allowable Values: PRINCIPAL, FEES, INTEREST |
| interest_calculation.minimum_interest decimal Required | When interest is applied, this value determines the minimum amount of interest that can be charged. Allowable Values: 0–999999999999.99 |
| interest_calculation.interest_on_grace_reactivation string Required | Determines whether to charge or waive interest for the billing period when the balance is paid off. Allowable Values: ACCRUE_FULL_CYCLE, ACCRUE_PAYMENT_DATE, WAIVE |
| interest_calculation.grace_days_application string Required | Determines the last day of grace period based on which interest charges are calculated. Allowable Values: NEXT_CYCLE_DATE |
| interest_calculation.exclude_tran_types array of strings Optional | One or more transactions that are excluded from current billing period’s interest charge, but included in next. Allowable Values: LATE_PAYMENT_FEE, ANNUAL_FEE, MONTHLY_FEE, CASH_BACK_STATEMENT_CREDIT, RETURNED_PAYMENT_FEE, FOREIGN_TRANSACTION_FEE |
| payments object Required | Contains the configurations for billing cycle day, payment due day, and fees. Allowable Values: Existing payments object |
| payments.billing_cycle_day integer Required | Day of the month when the billing cycle starts. Allowable Values: 1–28 |
| payments.due_day integer Optional | 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 |
| payments.billing_cycle_frequency string Optional | Frequency at which the account is billed. Allowable Values: MONTHLY |
| payments.payment_due_interval integer Optional | Specifies the payment due interval that is used to determine the payment due date for a billing cycle. A value of -1 indicates one day prior to the next billing cycle date. For consumer programs, a minimum gap of 21 days is required between when a statement is delivered and the payment due date. Allowable Values: -1 min Positive integers greater than 0; -1 is the default value |
| payments.billing_cycle_day_strategy string Optional | Determines if the billing cycle day is manually set or determined dynamically during account creation based on cycling logic. Allowable Values: MANUAL |
| payments.allocation_order array of strings Required | Ordered list of balance types to which payments are allocated, from first to last. Allowable Values: INTEREST, FEES, PRINCIPAL |
| payments.min_payment_calculation object Required | Contains information used to calculate the minimum payment amount on a credit product policy. Allowable Values: Existing min_payment_calculation object |
| payments.min_payment_calculation.include_past_due_amount boolean Required | Whether to include the past due amount when calculating the minimum payment. Allowable Values: true, false |
| payments.min_payment_calculation.include_overlimit_amount boolean Required | Whether to include the overlimit amount when calculating the minimum payment. Allowable Values: true, false |
| payments.min_payment_calculation.min_payment_flat_amount decimal Optional | Minimum payment, expressed as a flat amount, due on the payment due day. Allowable Values: Format: 0.00 |
| payments.min_payment_calculation.min_payment_percentage object Optional | Contains information used to calculate the minimum payment amount when expressed as a percentage. Allowable Values: Existing min_payment_percentage object |
| payments.min_payment_calculation.min_payment_percentage.percentage_of_balance decimal Required | Minimum payment, expressed as a percentage of the total statement balance, due on the payment due day. Allowable Values: 0.0001–100 |
| payments.min_payment_calculation.min_payment_percentage.include_interest_charged boolean Required | Whether to include the amount of interest charged when calculating the minimum payment. Allowable Values: true, false |
| payments.min_payment_calculation.min_payment_percentage.include_all_fees_charged boolean Optional | Whether to include all fees charged when calculating the minimum payment. Allowable Values: true, false |
Sample request body
JSON
Response body
| Fields | Description |
|---|---|
| token string Conditionally returned | Unique identifier of the credit product policy. Allowable Values: 36 char max |
| 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 |
| card_products[].token string Conditionally returned | Unique identifier of the card product. Allowable Values: 36 char max |
| card_products[].level string Conditionally returned | Level of the card product. Allowable Values: PREMIUM, TRADITIONAL |
| card_products[].network string Conditionally returned | Name of the card network. Allowable Values: VISA, MASTERCARD, SANDBOX |
| name string Conditionally returned | Name of the credit product policy. Allowable Values: 1 char min |
| description string Conditionally returned | Description of the credit product policy. Allowable Values: 255 char max |
| classification string Conditionally returned | Specifies for whom the credit product is intended. - CONSUMER - The credit product is intended for individual consumers.- SMALL_AND_MEDIUM_BUSINESS - The credit product is intended for small and medium business.Allowable Values: CONSUMER, SMALL_AND_MEDIUM_BUSINESS |
| product_type string Conditionally returned | Type of credit product.REVOLVING - Allows users to continuously borrow and pay debts up to the credit limit.Allowable Values: REVOLVING |
| product_sub_type string Conditionally returned | Subtype of the credit product type. - CREDIT_CARD - Card that enables the cardholder to make purchases on credit.- SECURED_CARD - Card backed by a user-funded deposit that enables the cardholder to make purchases on credit.Allowable Values: CREDIT_CARD, SECURED_CARD |
| currency_code string Conditionally returned | Valid three-digit ISO 4217 currency code. Allowable Values: USD |
| credit_line object Conditionally returned | Contains information on the credit line range. Allowable Values: Existing credit_line object |
| credit_line.min decimal Returned | Minimum credit limit. Allowable Values: 0–999999999999.99 |
| credit_line.max decimal Returned | Maximum credit limit. Allowable Values: 0–999999999999.99 |
| usage array of strings Conditionally returned | One or more usage types for the credit product policy. Allowable Values: PURCHASEValid usage array |
| interest_calculation object Conditionally returned | Contains the configurations for interest calculation. Allowable Values: Existing interest_calculation object |
| interest_calculation.method string Returned | Method of interest calculation. Allowable Values: AVG_DAILY_BALANCE_WITH_NEW_TRANSACTIONS |
| interest_calculation.day_count string Returned | Day-count convention. Allowable Values: ACTUAL |
| interest_calculation.interest_application array of strings Returned | One or more balance types on which interest is applied. Allowable Values: PRINCIPAL, FEES, INTEREST |
| interest_calculation.minimum_interest decimal Returned | When interest is applied, this value determines the minimum amount of interest that can be charged. Allowable Values: 0–999999999999.99 |
| interest_calculation.interest_on_grace_reactivation string Returned | Determines whether to charge or waive interest for the billing period when the balance is paid off. Allowable Values: ACCRUE_FULL_CYCLE, ACCRUE_PAYMENT_DATE, WAIVE |
| interest_calculation.grace_days_application string Returned | Determines the last day of grace period based on which interest charges are calculated. Allowable Values: NEXT_CYCLE_DATE |
| interest_calculation.exclude_tran_types array of strings Conditionally returned | One or more transactions that are excluded from current billing period’s interest charge, but included in next. Allowable Values: LATE_PAYMENT_FEE, ANNUAL_FEE, MONTHLY_FEE, CASH_BACK_STATEMENT_CREDIT, RETURNED_PAYMENT_FEE, FOREIGN_TRANSACTION_FEE |
| payments object Conditionally returned | Contains the configurations for billing cycle day, payment due day, and fees. Allowable Values: Existing payments object |
| payments.billing_cycle_day integer Returned | Day of the month when the billing cycle starts. Allowable Values: 1–28 |
| 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 |
| payments.billing_cycle_frequency string Conditionally returned | Frequency at which the account is billed. Allowable Values: MONTHLY |
| 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 |
| 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 |
| 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 |
| 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 |
| 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 |
| payments.min_payment_calculation.include_overlimit_amount boolean Returned | Whether to include the overlimit amount when calculating the minimum payment. Allowable Values: true, false |
| 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 |
| 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 |
| 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 |
| 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 |
| 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 |
| 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 |
| 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 |
Sample response body
JSON
Clone credit product policy
Action:POSTEndpoint:
/credit/policies/products/{token}/clone
Create a new credit product policy based on an existing credit product policy.
URL path parameters
| Fields | Description |
|---|---|
| token string Required | Unique identifier of the credit product policy to clone. Send a GET request to /policies/products to retrieve existing credit product policy tokens.Allowable Values: Existing credit product policy token |
Response body
| Fields | Description |
|---|---|
| token string Conditionally returned | Unique identifier of the credit product policy. Allowable Values: 36 char max |
| 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 |
| card_products[].token string Conditionally returned | Unique identifier of the card product. Allowable Values: 36 char max |
| card_products[].level string Conditionally returned | Level of the card product. Allowable Values: PREMIUM, TRADITIONAL |
| card_products[].network string Conditionally returned | Name of the card network. Allowable Values: VISA, MASTERCARD, SANDBOX |
| name string Conditionally returned | Name of the credit product policy. Allowable Values: 1 char min |
| description string Conditionally returned | Description of the credit product policy. Allowable Values: 255 char max |
| classification string Conditionally returned | Specifies for whom the credit product is intended. - CONSUMER - The credit product is intended for individual consumers.- SMALL_AND_MEDIUM_BUSINESS - The credit product is intended for small and medium business.Allowable Values: CONSUMER, SMALL_AND_MEDIUM_BUSINESS |
| product_type string Conditionally returned | Type of credit product.REVOLVING - Allows users to continuously borrow and pay debts up to the credit limit.Allowable Values: REVOLVING |
| product_sub_type string Conditionally returned | Subtype of the credit product type. - CREDIT_CARD - Card that enables the cardholder to make purchases on credit.- SECURED_CARD - Card backed by a user-funded deposit that enables the cardholder to make purchases on credit.Allowable Values: CREDIT_CARD, SECURED_CARD |
| currency_code string Conditionally returned | Valid three-digit ISO 4217 currency code. Allowable Values: USD |
| credit_line object Conditionally returned | Contains information on the credit line range. Allowable Values: Existing credit_line object |
| credit_line.min decimal Returned | Minimum credit limit. Allowable Values: 0–999999999999.99 |
| credit_line.max decimal Returned | Maximum credit limit. Allowable Values: 0–999999999999.99 |
| usage array of strings Conditionally returned | One or more usage types for the credit product policy. Allowable Values: PURCHASEValid usage array |
| interest_calculation object Conditionally returned | Contains the configurations for interest calculation. Allowable Values: Existing interest_calculation object |
| interest_calculation.method string Returned | Method of interest calculation. Allowable Values: AVG_DAILY_BALANCE_WITH_NEW_TRANSACTIONS |
| interest_calculation.day_count string Returned | Day-count convention. Allowable Values: ACTUAL |
| interest_calculation.interest_application array of strings Returned | One or more balance types on which interest is applied. Allowable Values: PRINCIPAL, FEES, INTEREST |
| interest_calculation.minimum_interest decimal Returned | When interest is applied, this value determines the minimum amount of interest that can be charged. Allowable Values: 0–999999999999.99 |
| interest_calculation.interest_on_grace_reactivation string Returned | Determines whether to charge or waive interest for the billing period when the balance is paid off. Allowable Values: ACCRUE_FULL_CYCLE, ACCRUE_PAYMENT_DATE, WAIVE |
| interest_calculation.grace_days_application string Returned | Determines the last day of grace period based on which interest charges are calculated. Allowable Values: NEXT_CYCLE_DATE |
| interest_calculation.exclude_tran_types array of strings Conditionally returned | One or more transactions that are excluded from current billing period’s interest charge, but included in next. Allowable Values: LATE_PAYMENT_FEE, ANNUAL_FEE, MONTHLY_FEE, CASH_BACK_STATEMENT_CREDIT, RETURNED_PAYMENT_FEE, FOREIGN_TRANSACTION_FEE |
| payments object Conditionally returned | Contains the configurations for billing cycle day, payment due day, and fees. Allowable Values: Existing payments object |
| payments.billing_cycle_day integer Returned | Day of the month when the billing cycle starts. Allowable Values: 1–28 |
| 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 |
| payments.billing_cycle_frequency string Conditionally returned | Frequency at which the account is billed. Allowable Values: MONTHLY |
| 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 |
| 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 |
| 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 |
| 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 |
| 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 |
| payments.min_payment_calculation.include_overlimit_amount boolean Returned | Whether to include the overlimit amount when calculating the minimum payment. Allowable Values: true, false |
| 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 |
| 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 |
| 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 |
| 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 |
| 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 |
| 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 |
| 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 |
Sample response body
JSON
Create fee policy
Action:POSTEndpoint:
/credit/policies/fees
Create a new fee policy.
Request body
| Fields | Description |
|---|---|
| token string Optional | Unique identifier of the fee policy. Allowable Values: 36 char max |
| name string Required | Name of the fee policy. Allowable Values: 255 char max |
| description string Optional | Description of the fee policy. Allowable Values: 255 char max |
| account object Required | Contains information on the fees in an account’s fee policy. Allowable Values: Existing account object |
| account.late_payment object Optional | Contains information on the late payment fee. Allowable Values: Existing late_payment object |
| account.returned_payment object Optional | Contains information on the returned payment fee. Allowable Values: Existing returned_payment object |
| account.foreign_transaction_fee object Optional | Contains information on the foreign transaction fee. Allowable Values: Existing foreign_transaction_fee object |
| account.monthly_fee object Optional | Contains information on the monthly periodic fees. Allowable Values: Existing periodic_fees object |
| account.annual_fee object Optional | Contains information on the annual periodic fees. Allowable Values: Existing periodic_fees object |
Sample request body
JSON
Response body
| Fields | Description |
|---|---|
| token string Conditionally returned | Unique identifier of the fee policy. Allowable Values: 36 char max |
| name string Conditionally returned | Name of the fee policy. Allowable Values: 255 char max |
| description string Conditionally returned | Description of the fee policy. Allowable Values: 255 char max |
| account object Conditionally returned | Contains information on the fees in an account’s fee policy. Allowable Values: Existing account object |
| account.late_payment object Conditionally returned | Contains information on the late payment fee. Allowable Values: Existing late_payment object |
| account.returned_payment object Conditionally returned | Contains information on the returned payment fee. Allowable Values: Existing returned_payment object |
| account.foreign_transaction_fee object Conditionally returned | Contains information on the foreign transaction fee. Allowable Values: Existing foreign_transaction_fee object |
| account.monthly_fee object Conditionally returned | Contains information on the monthly periodic fees. Allowable Values: Existing periodic_fees object |
| account.annual_fee object Conditionally returned | Contains information on the annual periodic fees. Allowable Values: Existing periodic_fees object |
| 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 |
| 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 |
Sample response body
JSON
List fee policies
Action:GETEndpoint:
/credit/policies/fees
Retrieve an array of existing fee policies.
This endpoint supports sorting and pagination.
URL query parameters
| Fields | Description |
|---|---|
| count integer Optional | Number of fee policy resources to retrieve. Allowable Values: 1–100 |
| start_index integer Optional | Sort order index of the first resource in the returned array. Allowable Values: 0 min |
| sort_by string Optional | Field on which to sort. Prefix the field name with a hyphen (-) to sort in descending order. Omit the hyphen to sort in ascending order.NOTE: You must sort using system field names such as lastModifiedTime, and not by the field names appearing in response bodies such as last_modified_time.Allowable Values: lastModifiedTime, -lastModifiedTime |
Response body
| 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 | One or more fee policies. Allowable Values: One or more fee policy objects |
| data[].token string Conditionally returned | Unique identifier of the fee policy. Allowable Values: 36 char max |
| data[].name string Conditionally returned | Name of the fee policy. Allowable Values: 255 char max |
| data[].description string Conditionally returned | Description of the fee policy. Allowable Values: 255 char max |
| data[].account object Conditionally returned | Contains information on the fees in an account’s fee policy. Allowable Values: Existing account object |
| data[].account.late_payment object Conditionally returned | Contains information on the late payment fee. Allowable Values: Existing late_payment object |
| data[].account.returned_payment object Conditionally returned | Contains information on the returned payment fee. Allowable Values: Existing returned_payment object |
| data[].account.foreign_transaction_fee object Conditionally returned | Contains information on the foreign transaction fee. Allowable Values: Existing foreign_transaction_fee object |
| data[].account.monthly_fee object Conditionally returned | Contains information on the monthly periodic fees. Allowable Values: Existing periodic_fees object |
| data[].account.annual_fee object Conditionally returned | Contains information on the annual periodic fees. Allowable Values: Existing periodic_fees object |
| data[].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[].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 |
Sample response body
JSON
Retrieve fee policy
Action:GETEndpoint:
/credit/policies/fees/{token}
Retrieve a specific fee policy.
This endpoint supports sorting and pagination.
URL path parameters
| Fields | Description |
|---|---|
| token string Required | Unique identifier of the fee policy to retrieve. Send a GET request to /policies/fee to retrieve existing fee policy tokens.Allowable Values: Existing fee policy token |
Response body
| Fields | Description |
|---|---|
| token string Conditionally returned | Unique identifier of the fee policy. Allowable Values: 36 char max |
| name string Conditionally returned | Name of the fee policy. Allowable Values: 255 char max |
| description string Conditionally returned | Description of the fee policy. Allowable Values: 255 char max |
| account object Conditionally returned | Contains information on the fees in an account’s fee policy. Allowable Values: Existing account object |
| account.late_payment object Conditionally returned | Contains information on the late payment fee. Allowable Values: Existing late_payment object |
| account.returned_payment object Conditionally returned | Contains information on the returned payment fee. Allowable Values: Existing returned_payment object |
| account.foreign_transaction_fee object Conditionally returned | Contains information on the foreign transaction fee. Allowable Values: Existing foreign_transaction_fee object |
| account.monthly_fee object Conditionally returned | Contains information on the monthly periodic fees. Allowable Values: Existing periodic_fees object |
| account.annual_fee object Conditionally returned | Contains information on the annual periodic fees. Allowable Values: Existing periodic_fees object |
| 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 |
| 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 |
Sample response body
JSON
Update fee policy
Action:PUTEndpoint:
/credit/policies/fees/{token}
Update a specific fee policy.
URL path parameters
| Fields | Description |
|---|---|
| token string Required | Unique identifier of the fee policy to retrieve. Send a GET request to /policies/fee to retrieve existing fee policy tokens.Allowable Values: Existing fee policy token |
Request body
| Fields | Description |
|---|---|
| name string Required | Name of the fee policy. Allowable Values: 255 char max |
| description string Optional | Description of the fee policy. Allowable Values: 255 char max |
| account object Optional | Contains information on the fees in an account’s fee policy. Allowable Values: Existing account object |
| account.late_payment object Optional | Contains information on the late payment fee. Allowable Values: Existing late_payment object |
| account.returned_payment object Optional | Contains information on the returned payment fee. Allowable Values: Existing returned_payment object |
| account.foreign_transaction_fee object Optional | Contains information on the foreign transaction fee. Allowable Values: Existing foreign_transaction_fee object |
| account.monthly_fee object Optional | Contains information on the monthly periodic fees. Allowable Values: Existing periodic_fees object |
| account.annual_fee object Optional | Contains information on the annual periodic fees. Allowable Values: Existing periodic_fees object |
| periodic object Optional | Contains information on a specific periodic fee in a fee policy. Allowable Values: Existing periodic object |
| periodic.fee_amount decimal Optional | Amount of the fee. Allowable Values: 1–5000 |
| periodic.number_of_days_post_activation decimal Optional | Number of days after an account is activated that the initial fee is charged. For example, if the value in this field is 30, then the initial fee is charged 30 days after an account is activated.Allowable Values: 1–1000 |
| periodic.exclude_from_interest_calc boolean Optional | Whether the periodic fee is excluded from interest calculation. Allowable Values: true, false |
Sample request body
JSON
Response body
| Fields | Description |
|---|---|
| token string Conditionally returned | Unique identifier of the fee policy. Allowable Values: 36 char max |
| name string Conditionally returned | Name of the fee policy. Allowable Values: 255 char max |
| description string Conditionally returned | Description of the fee policy. Allowable Values: 255 char max |
| account object Conditionally returned | Contains information on the fees in an account’s fee policy. Allowable Values: Existing account object |
| account.late_payment object Conditionally returned | Contains information on the late payment fee. Allowable Values: Existing late_payment object |
| account.returned_payment object Conditionally returned | Contains information on the returned payment fee. Allowable Values: Existing returned_payment object |
| account.foreign_transaction_fee object Conditionally returned | Contains information on the foreign transaction fee. Allowable Values: Existing foreign_transaction_fee object |
| account.monthly_fee object Conditionally returned | Contains information on the monthly periodic fees. Allowable Values: Existing periodic_fees object |
| account.annual_fee object Conditionally returned | Contains information on the annual periodic fees. Allowable Values: Existing periodic_fees object |
| 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 |
| 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 |
Sample response body
JSON
Clone fee policy
Action:POSTEndpoint:
/credit/policies/fees/{token}/clone
Create a new fee policy based on an existing fee policy.
URL path parameters
| Fields | Description |
|---|---|
| token string Required | Unique identifier of the fee policy to clone. Send a GET request to /policies/fee to retrieve existing fee policy tokens.Allowable Values: Existing fee policy token |
Response body
| Fields | Description |
|---|---|
| token string Conditionally returned | Unique identifier of the fee policy. Allowable Values: 36 char max |
| name string Conditionally returned | Name of the fee policy. Allowable Values: 255 char max |
| description string Conditionally returned | Description of the fee policy. Allowable Values: 255 char max |
| account object Conditionally returned | Contains information on the fees in an account’s fee policy. Allowable Values: Existing account object |
| account.late_payment object Conditionally returned | Contains information on the late payment fee. Allowable Values: Existing late_payment object |
| account.returned_payment object Conditionally returned | Contains information on the returned payment fee. Allowable Values: Existing returned_payment object |
| account.foreign_transaction_fee object Conditionally returned | Contains information on the foreign transaction fee. Allowable Values: Existing foreign_transaction_fee object |
| account.monthly_fee object Conditionally returned | Contains information on the monthly periodic fees. Allowable Values: Existing periodic_fees object |
| account.annual_fee object Conditionally returned | Contains information on the annual periodic fees. Allowable Values: Existing periodic_fees object |
| 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 |
| 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 |
Sample response body
JSON
Create APR policy
Action:POSTEndpoint:
/credit/policies/aprs
Create a new annual percentage rate (APR) policy.
Request body
| Fields | Description |
|---|---|
| token string Optional | Unique identifier of the APR policy. Allowable Values: 36 char max |
| name string Required | Name of the APR policy. Allowable Values: 255 char max |
| description string Optional | Description of the APR policy. Allowable Values: 255 char max |
| purchases object Required | Contains information on the pricing strategy for purchases. Allowable Values: Existing purchases object |
| purchases.name string Optional | Name of the pricing strategy. Allowable Values: 255 char max |
| purchases.external_token string Optional | Unique identifier of the external pricing strategy for the credit program. Allowable Values: Valid external pricing strategy token |
| purchases.tiers array of objects Required | One or more risk tiers for a pricing strategy. Allowable Values: One or more tiers objects |
| purchases.tiers[].margin_rate decimal Required | Number of percentage points added to the prime rate, used to calculate a variable APR value. Allowable Values: Format: 0.00 |
Sample request body
JSON
Response body
| Fields | Description |
|---|---|
| token string Conditionally returned | Unique identifier of the APR policy. Allowable Values: 36 char max |
| name string Conditionally returned | Name of the APR policy. Allowable Values: 255 char max |
| description string Conditionally returned | Description of the APR policy. Allowable Values: 255 char max |
| purchases object Conditionally returned | Contains information on the pricing strategy for purchases. Allowable Values: Existing purchases object |
| purchases.name string Conditionally returned | Name of the pricing strategy. Allowable Values: 255 char max |
| purchases.external_token string Conditionally returned | Unique identifier of the pricing strategy on a credit program. Allowable Values: 36 char max |
| purchases.tiers array of objects Conditionally returned | One or more risk tiers for a pricing strategy. Allowable Values: One or more tiers objects |
| purchases.tiers[].margin_rate decimal Conditionally returned | Margin rate for the risk tier for a pricing strategy. Allowable Values: Format: 0.00 |
| purchases.tiers[].apr decimal Conditionally returned | Value of the APR. Allowable Values: Format: 0.00 |
| effective_date date Conditionally returned | Date the APR goes into effect, in UTC. Allowable Values: Format: yyyy-MM-dd |
| 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 |
| 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 |
Sample response body
JSON
List APR policies
Action:GETEndpoint:
/credit/policies/aprs
Retrieve an array of existing APR policies.
This endpoint supports sorting and pagination.
URL query parameters
| Fields | Description |
|---|---|
| count integer Optional | Number of APR policy 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 effectiveDate, and not by the field names appearing in response bodies such as effective_date.Allowable Values: effectiveDate, -effectiveDate |
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 | One or more APR policies. Allowable Values: One or more APR policy objects |
| data[].token string Conditionally returned | Unique identifier of the APR policy. Allowable Values: 36 char max |
| data[].name string Conditionally returned | Name of the APR policy. Allowable Values: 255 char max |
| data[].description string Conditionally returned | Description of the APR policy. Allowable Values: 255 char max |
| data[].purchases object Conditionally returned | Contains information on the pricing strategy for purchases. Allowable Values: Existing purchases object |
| data[].purchases.name string Conditionally returned | Name of the pricing strategy. Allowable Values: 255 char max |
| data[].purchases.external_token string Conditionally returned | Unique identifier of the pricing strategy on a credit program. Allowable Values: 36 char max |
| data[].purchases.tiers array of objects Conditionally returned | One or more risk tiers for a pricing strategy. Allowable Values: One or more tiers objects |
| data[].purchases.tiers[].margin_rate decimal Conditionally returned | Margin rate for the risk tier for a pricing strategy. Allowable Values: Format: 0.00 |
| data[].purchases.tiers[].apr decimal Conditionally returned | Value of the APR. Allowable Values: Format: 0.00 |
| data[].effective_date date Conditionally returned | Date the APR goes into effect, in UTC. Allowable Values: Format: yyyy-MM-dd |
| data[].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[].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 |
Sample response body
JSON
Retrieve APR policy
Action:GETEndpoint:
/credit/policies/aprs/{token}
Retrieve a specific annual percentage rate (APR) policy.
This endpoint supports sorting and pagination.
URL path parameters
| Fields | Description |
|---|---|
| token string Required | Unique identifier of the APR policy to retrieve. Send a GET request to /policies/aprs to retrieve existing APR policy tokens.Allowable Values: Existing APR policy token |
Response body
| Fields | Description |
|---|---|
| token string Conditionally returned | Unique identifier of the APR policy. Allowable Values: 36 char max |
| name string Conditionally returned | Name of the APR policy. Allowable Values: 255 char max |
| description string Conditionally returned | Description of the APR policy. Allowable Values: 255 char max |
| purchases object Conditionally returned | Contains information on the pricing strategy for purchases. Allowable Values: Existing purchases object |
| purchases.name string Conditionally returned | Name of the pricing strategy. Allowable Values: 255 char max |
| purchases.external_token string Conditionally returned | Unique identifier of the pricing strategy on a credit program. Allowable Values: 36 char max |
| purchases.tiers array of objects Conditionally returned | One or more risk tiers for a pricing strategy. Allowable Values: One or more tiers objects |
| purchases.tiers[].margin_rate decimal Conditionally returned | Margin rate for the risk tier for a pricing strategy. Allowable Values: Format: 0.00 |
| purchases.tiers[].apr decimal Conditionally returned | Value of the APR. Allowable Values: Format: 0.00 |
| effective_date date Conditionally returned | Date the APR goes into effect, in UTC. Allowable Values: Format: yyyy-MM-dd |
| 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 |
| 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 |
Sample response body
JSON
Update APR policy
Action:PUTEndpoint:
/credit/policies/aprs/{token}
Update a specific APR policy.
URL path parameters
| Fields | Description |
|---|---|
| token string Required | Unique identifier of the APR policy to update. Send a GET request to /policies/aprs to retrieve existing APR policy tokens.Allowable Values: Existing APR policy token |
Request body
| Fields | Description |
|---|---|
| token string Optional | Unique identifier of the APR policy. Allowable Values: 36 char max |
| name string Required | Name of the APR policy. Allowable Values: 255 char max |
| description string Optional | Description of the APR policy. Allowable Values: 255 char max |
| purchases object Optional | Contains information on the pricing strategy for purchases. Allowable Values: Existing purchases object |
| purchases.name string Optional | Name of the pricing strategy. Allowable Values: 255 char max |
| purchases.external_token string Optional | Unique identifier of the external pricing strategy for the credit program. Allowable Values: Valid external pricing strategy token |
| purchases.tiers array of objects Required | One or more risk tiers for a pricing strategy. Allowable Values: One or more tiers objects |
| purchases.tiers[].margin_rate decimal Required | Number of percentage points added to the prime rate, used to calculate a variable APR value. Allowable Values: Format: 0.00 |
Sample request body
JSON
Response body
| Fields | Description |
|---|---|
| token string Conditionally returned | Unique identifier of the APR policy. Allowable Values: 36 char max |
| name string Conditionally returned | Name of the APR policy. Allowable Values: 255 char max |
| description string Conditionally returned | Description of the APR policy. Allowable Values: 255 char max |
| purchases object Conditionally returned | Contains information on the pricing strategy for purchases. Allowable Values: Existing purchases object |
| purchases.name string Conditionally returned | Name of the pricing strategy. Allowable Values: 255 char max |
| purchases.external_token string Conditionally returned | Unique identifier of the pricing strategy on a credit program. Allowable Values: 36 char max |
| purchases.tiers array of objects Conditionally returned | One or more risk tiers for a pricing strategy. Allowable Values: One or more tiers objects |
| purchases.tiers[].margin_rate decimal Conditionally returned | Margin rate for the risk tier for a pricing strategy. Allowable Values: Format: 0.00 |
| purchases.tiers[].apr decimal Conditionally returned | Value of the APR. Allowable Values: Format: 0.00 |
| effective_date date Conditionally returned | Date the APR goes into effect, in UTC. Allowable Values: Format: yyyy-MM-dd |
| 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 |
| 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 |
Clone APR policy
Action:POSTEndpoint:
/credit/policies/aprs/{token}/clone
Create a new annual percentage rate (APR) policy based on an existing APR policy.
URL path parameters
| Fields | Description |
|---|---|
| token string Required | Unique identifier of the APR policy to clone. Send a GET request to /policies/aprs to retrieve existing APR policy tokens.Allowable Values: Existing APR policy token |
Response body
| Fields | Description |
|---|---|
| token string Conditionally returned | Unique identifier of the APR policy. Allowable Values: 36 char max |
| name string Conditionally returned | Name of the APR policy. Allowable Values: 255 char max |
| description string Conditionally returned | Description of the APR policy. Allowable Values: 255 char max |
| purchases object Conditionally returned | Contains information on the pricing strategy for purchases. Allowable Values: Existing purchases object |
| purchases.name string Conditionally returned | Name of the pricing strategy. Allowable Values: 255 char max |
| purchases.external_token string Conditionally returned | Unique identifier of the pricing strategy on a credit program. Allowable Values: 36 char max |
| purchases.tiers array of objects Conditionally returned | One or more risk tiers for a pricing strategy. Allowable Values: One or more tiers objects |
| purchases.tiers[].margin_rate decimal Conditionally returned | Margin rate for the risk tier for a pricing strategy. Allowable Values: Format: 0.00 |
| purchases.tiers[].apr decimal Conditionally returned | Value of the APR. Allowable Values: Format: 0.00 |
| effective_date date Conditionally returned | Date the APR goes into effect, in UTC. Allowable Values: Format: yyyy-MM-dd |
| 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 |
| 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 |
Sample response body
JSON
List APR schedules
Action:GETEndpoint:
/credit/policies/aprs/{token}/schedule
Retrieve an array of the historic annual percentage rate (APR) schedules on a specific APR policy.
This endpoint supports sorting and pagination.
URL path parameters
| Fields | Description |
|---|---|
| token string Required | Unique identifier of the APR policy on which to retrieve APR schedules. Send a GET request to /policies/aprs to retrieve existing product policy tokens.Allowable Values: Existing APR policy token |
URL query parameters
| Fields | Description |
|---|---|
| count integer Optional | Number of APR schedule resources to retrieve. Allowable Values: 1–100 |
| start_index integer Optional | Sort order index of the first resource in the returned array. Allowable Values: 0 min |
| sort_by string Optional | Field on which to sort. Prefix the field name with a hyphen (-) to sort in descending order. Omit the hyphen to sort in ascending order.NOTE: You must sort using system field names such as lastModifiedTime, and not by the field names appearing in response bodies such as last_modified_time.Allowable Values: lastModifiedTime, -lastModifiedTime |
Response body
| 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 | One or more APR policies. Allowable Values: One or more APR policy objects |
| data[].token string Conditionally returned | Unique identifier of the APR policy. Allowable Values: 36 char max |
| data[].name string Conditionally returned | Name of the APR policy. Allowable Values: 255 char max |
| data[].description string Conditionally returned | Description of the APR policy. Allowable Values: 255 char max |
| data[].purchases object Conditionally returned | Contains information on the pricing strategy for purchases. Allowable Values: Existing purchases object |
| data[].purchases.name string Conditionally returned | Name of the pricing strategy. Allowable Values: 255 char max |
| data[].purchases.external_token string Conditionally returned | Unique identifier of the pricing strategy on a credit program. Allowable Values: 36 char max |
| data[].purchases.tiers array of objects Conditionally returned | One or more risk tiers for a pricing strategy. Allowable Values: One or more tiers objects |
| data[].purchases.tiers[].margin_rate decimal Conditionally returned | Margin rate for the risk tier for a pricing strategy. Allowable Values: Format: 0.00 |
| data[].purchases.tiers[].apr decimal Conditionally returned | Value of the APR. Allowable Values: Format: 0.00 |
| data[].effective_date date Conditionally returned | Date the APR goes into effect, in UTC. Allowable Values: Format: yyyy-MM-dd |
| data[].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[].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 |
Sample response body
JSON
Create reward policy
Action:POSTEndpoint:
/credit/policies/rewards
Create a new reward policy.
Request body
| Fields | Description |
|---|---|
| token string Optional | Unique identifier of the reward policy. Allowable Values: 36 char max |
| name string Required | Name of the reward policy. Allowable Values: 255 char max |
| description string Optional | Description of the reward policy. Allowable Values: 255 char max |
| settlement_strategy string Required | Reward settlement strategy for a credit program. Allowable Values: STATEMENT, LIVE |
| accrual_strategy string Optional | 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 |
| rounding_strategy string Optional | 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 |
| rules array of objects Required | List of one or more reward rules. Allowable Values: Valid array of one or more rules objects |
| rules[].description string Required | The description of the rule. Allowable Values: 255 char max |
| rules[].type string Required | Type of rule. Allowable Values: MULTIPLIER_PER_TRANSACTION |
| rules[].calculation_type string Optional | Type of calculation to use to evaluate if a rule has been satisfied. Allowable Values: PER_TRANSACTION |
| rules[].multiplier decimal Optional | The reward multiplier to apply the transaction, where ‘1’ means 1x transaction amount. Allowable Values: Any integer |
| rules[].amount decimal Optional | The static amount to reward if the rule conditions are met. Allowable Values: Any integer |
| rules[].attributes object Optional | 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 |
| rules[].attributes.mcc array of strings Optional | 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 |
| rules[].attributes.mid string Optional | Merchant ID for the rule. Allowable Values: “255” |
| rules[].attributes.min_spend decimal Optional | Minimum spend amount. Allowable Values: 100 |
| rules[].attributes.max_spend decimal Optional | Maximum spend amount. Allowable Values: 150 |
| rules[].attributes.spend_total decimal Optional | Total spend amount. Allowable Values: 100 |
| rules[].attributes.spend_days integer Optional | 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 |
| conversions array of objects Required | List of one or more reward conversions. Allowable Values: Valid array of one or more conversion objects |
| conversions[].type string Required | Type of conversion. Allowable Values: STATEMENT_CREDIT |
| conversions[].conversion_rate decimal Required | The rate that points are worth with converting the REDEMPTION_TYPE indicated. Allowable Values: 0.001 min Format: 0.000 |
| conversions[].conversion_increment integer Required | The static amount to reward if the rule conditions are met. Allowable Values: Any integer |
| conversions[].currency string Optional | Type of currency used with the conversion rate. Allowable Values: Currency code, such as EUR or USD. |
| exclusions object Required | 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 |
| exclusions.use_default_exclusions boolean Optional | 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 |
| exclusions.custom_exclusions array of strings Optional | 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 |
Sample request body
JSON
Response body
| Fields | Description |
|---|---|
| token string Conditionally returned | Unique identifier of the reward policy. Allowable Values: 36 char max |
| name string Conditionally returned | Name of the reward policy. Allowable Values: 255 char max |
| description string Conditionally returned | Description of the reward policy. Allowable Values: 255 char max |
| settlement_strategy string Conditionally returned | Reward settlement strategy for a credit program. Allowable Values: STATEMENT, LIVE |
| 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 |
| 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 |
| rules array of objects Conditionally returned | A list of one or more reward rules. Allowable Values: Valid array of one or more rules objects |
| rules[].description string Returned | The description of the rule. Allowable Values: 255 char max |
| rules[].type string Returned | Type of rule. Allowable Values: MULTIPLIER_PER_TRANSACTION |
| rules[].calculation_type string Conditionally returned | Type of calculation to use to evaluate if a rule has been satisfied. Allowable Values: PER_TRANSACTION |
| rules[].multiplier decimal Conditionally returned | The reward multiplier to apply the transaction, where ‘1’ means 1x transaction amount. Allowable Values: Any integer |
| rules[].amount decimal Conditionally returned | The static amount to reward if the rule conditions are met. Allowable Values: Any integer |
| 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 |
| 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 |
| rules[].attributes.mid string Conditionally returned | Merchant ID for the rule. Allowable Values: “255” |
| rules[].attributes.min_spend decimal Conditionally returned | Minimum spend amount. Allowable Values: 100 |
| rules[].attributes.max_spend decimal Conditionally returned | Maximum spend amount. Allowable Values: 150 |
| rules[].attributes.spend_total decimal Conditionally returned | Total spend amount. Allowable Values: 100 |
| 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 |
| conversions array of objects Conditionally returned | List of one or more reward conversions. Allowable Values: Valid array of one or more conversion objects |
| conversions[].type string Returned | Type of conversion. Allowable Values: STATEMENT_CREDIT |
| 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 |
| conversions[].conversion_increment integer Returned | The static amount to reward if the rule conditions are met. Allowable Values: Any integer |
| conversions[].currency string Conditionally returned | Type of currency used with the conversion rate. Allowable Values: Currency code, such as EUR or USD. |
| 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 |
| 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 |
| 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 |
| 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 |
| 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 |
Sample response body
JSON
List reward policies
Action:GETEndpoint:
/credit/policies/rewards
Retrieve an array of reward policies.
This endpoint supports sorting and pagination.
URL query parameters
| Fields | Description |
|---|---|
| count integer Optional | Number of reward policy resources to retrieve. Allowable Values: 1–100 |
| start_index integer Optional | Sort order index of the first resource in the returned array. Allowable Values: 0 min |
| sort_by string Optional | Field on which to sort. Prefix the field name with a hyphen (-) to sort in descending order. Omit the hyphen to sort in ascending order.NOTE: You must sort using system field names such as lastModifiedTime, and not by the field names appearing in response bodies such as last_modified_time.Allowable Values: lastModifiedTime, -lastModifiedTime |
Response body
| 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 | List of one or more reward policies. Allowable Values: Valid array of one or more reward policy objects |
| data[].token string Conditionally returned | Unique identifier of the reward policy. Allowable Values: 36 char max |
| data[].name string Conditionally returned | Name of the reward policy. Allowable Values: 255 char max |
| data[].description string Conditionally returned | Description of the reward policy. Allowable Values: 255 char max |
| data[].settlement_strategy string Conditionally returned | Reward settlement strategy for a credit program. Allowable Values: STATEMENT, LIVE |
| data[].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[].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[].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[].rules[].description string Returned | The description of the rule. Allowable Values: 255 char max |
| data[].rules[].type string Returned | Type of rule. Allowable Values: MULTIPLIER_PER_TRANSACTION |
| data[].rules[].calculation_type string Conditionally returned | Type of calculation to use to evaluate if a rule has been satisfied. Allowable Values: PER_TRANSACTION |
| data[].rules[].multiplier decimal Conditionally returned | The reward multiplier to apply the transaction, where ‘1’ means 1x transaction amount. Allowable Values: Any integer |
| data[].rules[].amount decimal Conditionally returned | The static amount to reward if the rule conditions are met. Allowable Values: Any integer |
| data[].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[].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[].rules[].attributes.mid string Conditionally returned | Merchant ID for the rule. Allowable Values: “255” |
| data[].rules[].attributes.min_spend decimal Conditionally returned | Minimum spend amount. Allowable Values: 100 |
| data[].rules[].attributes.max_spend decimal Conditionally returned | Maximum spend amount. Allowable Values: 150 |
| data[].rules[].attributes.spend_total decimal Conditionally returned | Total spend amount. Allowable Values: 100 |
| data[].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[].conversions array of objects Conditionally returned | List of one or more reward conversions. Allowable Values: Valid array of one or more conversion objects |
| data[].conversions[].type string Returned | Type of conversion. Allowable Values: STATEMENT_CREDIT |
| data[].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[].conversions[].conversion_increment integer Returned | The static amount to reward if the rule conditions are met. Allowable Values: Any integer |
| data[].conversions[].currency string Conditionally returned | Type of currency used with the conversion rate. Allowable Values: Currency code, such as EUR or USD. |
| data[].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[].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[].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[].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[].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 |
Sample response body
JSON
Retrieve reward policy
Action:GETEndpoint:
/credit/policies/rewards/{token}
Retrieve a reward policy.
URL path parameters
| Fields | Description |
|---|---|
| token string Required | Unique identifier of the reward policy to retrieve. Send a GET request to /policies/rewards to retrieve existing reward policy tokens.Allowable Values: Existing reward policy token |
Response body
| Fields | Description |
|---|---|
| token string Conditionally returned | Unique identifier of the reward policy. Allowable Values: 36 char max |
| name string Conditionally returned | Name of the reward policy. Allowable Values: 255 char max |
| description string Conditionally returned | Description of the reward policy. Allowable Values: 255 char max |
| settlement_strategy string Conditionally returned | Reward settlement strategy for a credit program. Allowable Values: STATEMENT, LIVE |
| 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 |
| 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 |
| rules array of objects Conditionally returned | A list of one or more reward rules. Allowable Values: Valid array of one or more rules objects |
| rules[].description string Returned | The description of the rule. Allowable Values: 255 char max |
| rules[].type string Returned | Type of rule. Allowable Values: MULTIPLIER_PER_TRANSACTION |
| rules[].calculation_type string Conditionally returned | Type of calculation to use to evaluate if a rule has been satisfied. Allowable Values: PER_TRANSACTION |
| rules[].multiplier decimal Conditionally returned | The reward multiplier to apply the transaction, where ‘1’ means 1x transaction amount. Allowable Values: Any integer |
| rules[].amount decimal Conditionally returned | The static amount to reward if the rule conditions are met. Allowable Values: Any integer |
| 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 |
| 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 |
| rules[].attributes.mid string Conditionally returned | Merchant ID for the rule. Allowable Values: “255” |
| rules[].attributes.min_spend decimal Conditionally returned | Minimum spend amount. Allowable Values: 100 |
| rules[].attributes.max_spend decimal Conditionally returned | Maximum spend amount. Allowable Values: 150 |
| rules[].attributes.spend_total decimal Conditionally returned | Total spend amount. Allowable Values: 100 |
| 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 |
| conversions array of objects Conditionally returned | List of one or more reward conversions. Allowable Values: Valid array of one or more conversion objects |
| conversions[].type string Returned | Type of conversion. Allowable Values: STATEMENT_CREDIT |
| 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 |
| conversions[].conversion_increment integer Returned | The static amount to reward if the rule conditions are met. Allowable Values: Any integer |
| conversions[].currency string Conditionally returned | Type of currency used with the conversion rate. Allowable Values: Currency code, such as EUR or USD. |
| 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 |
| 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 |
| 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 |
| 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 |
| 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 |
Sample response body
JSON
Update reward policy
Action:PUTEndpoint:
/credit/policies/rewards/{token}
Update a reward policy.
URL path parameters
| Fields | Description |
|---|---|
| token string Required | Unique identifier of the reward policy to update. Send a GET request to /policies/rewards to retrieve existing reward policy tokens.Allowable Values: Existing reward policy token |
Request body
| Fields | Description |
|---|---|
| token string Optional | Unique identifier of the reward policy. Allowable Values: 36 char max |
| name string Required | Name of the reward policy. Allowable Values: 255 char max |
| description string Optional | Description of the reward policy. Allowable Values: 255 char max |
| settlement_strategy string Required | Reward settlement strategy for a credit program. Allowable Values: STATEMENT, LIVE |
| accrual_strategy string Optional | 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 |
| rounding_strategy string Optional | 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 |
| rules array of objects Required | List of one or more reward rules. Allowable Values: Valid array of one or more rules objects |
| rules[].description string Required | The description of the rule. Allowable Values: 255 char max |
| rules[].type string Required | Type of rule. Allowable Values: MULTIPLIER_PER_TRANSACTION |
| rules[].calculation_type string Optional | Type of calculation to use to evaluate if a rule has been satisfied. Allowable Values: PER_TRANSACTION |
| rules[].multiplier decimal Optional | The reward multiplier to apply the transaction, where ‘1’ means 1x transaction amount. Allowable Values: Any integer |
| rules[].amount decimal Optional | The static amount to reward if the rule conditions are met. Allowable Values: Any integer |
| rules[].attributes object Optional | 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 |
| rules[].attributes.mcc array of strings Optional | 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 |
| rules[].attributes.mid string Optional | Merchant ID for the rule. Allowable Values: “255” |
| rules[].attributes.min_spend decimal Optional | Minimum spend amount. Allowable Values: 100 |
| rules[].attributes.max_spend decimal Optional | Maximum spend amount. Allowable Values: 150 |
| rules[].attributes.spend_total decimal Optional | Total spend amount. Allowable Values: 100 |
| rules[].attributes.spend_days integer Optional | 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 |
| conversions array of objects Required | List of one or more reward conversions. Allowable Values: Valid array of one or more conversion objects |
| conversions[].type string Required | Type of conversion. Allowable Values: STATEMENT_CREDIT |
| conversions[].conversion_rate decimal Required | The rate that points are worth with converting the REDEMPTION_TYPE indicated. Allowable Values: 0.001 min Format: 0.000 |
| conversions[].conversion_increment integer Required | The static amount to reward if the rule conditions are met. Allowable Values: Any integer |
| conversions[].currency string Optional | Type of currency used with the conversion rate. Allowable Values: Currency code, such as EUR or USD. |
| exclusions object Required | 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 |
| exclusions.use_default_exclusions boolean Optional | 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 |
| exclusions.custom_exclusions array of strings Optional | 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 |
Response body
| Fields | Description |
|---|---|
| token string Conditionally returned | Unique identifier of the reward policy. Allowable Values: 36 char max |
| name string Conditionally returned | Name of the reward policy. Allowable Values: 255 char max |
| description string Conditionally returned | Description of the reward policy. Allowable Values: 255 char max |
| settlement_strategy string Conditionally returned | Reward settlement strategy for a credit program. Allowable Values: STATEMENT, LIVE |
| 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 |
| 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 |
| rules array of objects Conditionally returned | A list of one or more reward rules. Allowable Values: Valid array of one or more rules objects |
| rules[].description string Returned | The description of the rule. Allowable Values: 255 char max |
| rules[].type string Returned | Type of rule. Allowable Values: MULTIPLIER_PER_TRANSACTION |
| rules[].calculation_type string Conditionally returned | Type of calculation to use to evaluate if a rule has been satisfied. Allowable Values: PER_TRANSACTION |
| rules[].multiplier decimal Conditionally returned | The reward multiplier to apply the transaction, where ‘1’ means 1x transaction amount. Allowable Values: Any integer |
| rules[].amount decimal Conditionally returned | The static amount to reward if the rule conditions are met. Allowable Values: Any integer |
| 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 |
| 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 |
| rules[].attributes.mid string Conditionally returned | Merchant ID for the rule. Allowable Values: “255” |
| rules[].attributes.min_spend decimal Conditionally returned | Minimum spend amount. Allowable Values: 100 |
| rules[].attributes.max_spend decimal Conditionally returned | Maximum spend amount. Allowable Values: 150 |
| rules[].attributes.spend_total decimal Conditionally returned | Total spend amount. Allowable Values: 100 |
| 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 |
| conversions array of objects Conditionally returned | List of one or more reward conversions. Allowable Values: Valid array of one or more conversion objects |
| conversions[].type string Returned | Type of conversion. Allowable Values: STATEMENT_CREDIT |
| 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 |
| conversions[].conversion_increment integer Returned | The static amount to reward if the rule conditions are met. Allowable Values: Any integer |
| conversions[].currency string Conditionally returned | Type of currency used with the conversion rate. Allowable Values: Currency code, such as EUR or USD. |
| 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 |
| 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 |
| 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 |
| 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 |
| 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 |
Sample response body
JSON
Clone reward policy
Action:POSTEndpoint:
/credit/policies/rewards/{token}/clone
Create a new reward policy based on existing reward policy.
URL path parameters
| Fields | Description |
|---|---|
| token string Required | Unique identifier of the reward policy to clone. Send a GET request to /policies/rewards to retrieve existing reward policy tokens.Allowable Values: Existing reward policy token |
Response body
| Fields | Description |
|---|---|
| token string Conditionally returned | Unique identifier of the reward policy. Allowable Values: 36 char max |
| name string Conditionally returned | Name of the reward policy. Allowable Values: 255 char max |
| description string Conditionally returned | Description of the reward policy. Allowable Values: 255 char max |
| settlement_strategy string Conditionally returned | Reward settlement strategy for a credit program. Allowable Values: STATEMENT, LIVE |
| 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 |
| 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 |
| rules array of objects Conditionally returned | A list of one or more reward rules. Allowable Values: Valid array of one or more rules objects |
| rules[].description string Returned | The description of the rule. Allowable Values: 255 char max |
| rules[].type string Returned | Type of rule. Allowable Values: MULTIPLIER_PER_TRANSACTION |
| rules[].calculation_type string Conditionally returned | Type of calculation to use to evaluate if a rule has been satisfied. Allowable Values: PER_TRANSACTION |
| rules[].multiplier decimal Conditionally returned | The reward multiplier to apply the transaction, where ‘1’ means 1x transaction amount. Allowable Values: Any integer |
| rules[].amount decimal Conditionally returned | The static amount to reward if the rule conditions are met. Allowable Values: Any integer |
| 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 |
| 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 |
| rules[].attributes.mid string Conditionally returned | Merchant ID for the rule. Allowable Values: “255” |
| rules[].attributes.min_spend decimal Conditionally returned | Minimum spend amount. Allowable Values: 100 |
| rules[].attributes.max_spend decimal Conditionally returned | Maximum spend amount. Allowable Values: 150 |
| rules[].attributes.spend_total decimal Conditionally returned | Total spend amount. Allowable Values: 100 |
| 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 |
| conversions array of objects Conditionally returned | List of one or more reward conversions. Allowable Values: Valid array of one or more conversion objects |
| conversions[].type string Returned | Type of conversion. Allowable Values: STATEMENT_CREDIT |
| 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 |
| conversions[].conversion_increment integer Returned | The static amount to reward if the rule conditions are met. Allowable Values: Any integer |
| conversions[].currency string Conditionally returned | Type of currency used with the conversion rate. Allowable Values: Currency code, such as EUR or USD. |
| 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 |
| 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 |
| 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 |
| 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 |
| 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 |
Sample response body
JSON