Policies (Beta)
Note
This feature is currently in limited-availability beta and subject to change. To learn more about the beta program for this feature, contact your Marqeta Customer Service representative.The Marqeta credit platform’s policies feature enables you to customize the configurations of policies for documents (such as disclosures), credit products, fees, APRs, and rewards. You can choose the specific policies to add to a bundle that contain the exact configurations needed to launch a new credit program or help manage an existing one. The configurations of each policy in a bundle determine the characteristics and attributes of the bundle’s associated credit accounts, reward programs, disclosures, and more. For more on how to create a bundle, see Bundles.
Important
To create and manage policies, you must use the Marqeta Dashboard. For more on policies in the dashboard, see Managing Credit Programs in the Marqeta Dashboard.
The following endpoints are displayed for reference purposes only.
Create document policy
Copy section link
Action: POST
Endpoint: /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
Copy section link
| Fields | Description |
|---|---|
token
string
|
Unique identifier of the document policy. Allowable Values: 36 char max |
name
string
|
Name of the document policy. Allowable Values: 255 char max |
summary_of_credit_terms
object
|
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.asset_token
string
|
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
|
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
|
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.asset_token
string
|
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
|
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
|
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.template_token
string
|
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
|
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.asset_token
string
|
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
|
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.asset_token
string
|
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
|
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.asset_token
string
|
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
|
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.asset_token
string
|
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
|
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.asset_token
string
|
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
|
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.template_token
string
|
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
|
Contains information on the Notice of Adverse Action (NOAA) used when an application is declined for single reason. Allowable Values: Existing |
noaa_single_reason.template_token
string
|
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
|
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.template_token
string
|
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
|
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.template_token
string
|
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 |
Response body
Copy section link
| Fields | Description |
|---|---|
token
string
|
Unique identifier of the document policy. Allowable Values: 36 char max |
name
string
|
Name of the document policy. Allowable Values: 255 char max |
summary_of_credit_terms
object
|
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.asset_token
string
|
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
|
Contains one or more URLs for an asset. Allowable Values: One or more |
summary_of_credit_terms.asset_urls.pdf
string
|
URL to the PDF version of the asset. Allowable Values: A valid URL |
summary_of_credit_terms.asset_urls.png
string
|
URL to the PNG version of the asset. Allowable Values: A valid URL |
summary_of_credit_terms.asset_urls.html
string
|
URL to the HTML version of the asset. Allowable Values: A valid URL |
summary_of_credit_terms.asset_created_time
datetime
|
Date and time when the asset was created. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
summary_of_credit_terms.template_token
string
|
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
|
Contains one or more URLs for a template. Allowable Values: One or more |
summary_of_credit_terms.template_urls.html
string
|
URL to the HTML version of the document template. Allowable Values: A valid URL |
summary_of_credit_terms.template_created_time
datetime
|
Date and time when the template was created. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
rewards_disclosure
object
|
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.asset_token
string
|
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
|
Contains one or more URLs for an asset. Allowable Values: One or more |
rewards_disclosure.asset_urls.pdf
string
|
URL to the PDF version of the asset. Allowable Values: A valid URL |
rewards_disclosure.asset_urls.png
string
|
URL to the PNG version of the asset. Allowable Values: A valid URL |
rewards_disclosure.asset_urls.html
string
|
URL to the HTML version of the asset. Allowable Values: A valid URL |
rewards_disclosure.asset_created_time
datetime
|
Date and time when the asset was created. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
rewards_disclosure.template_token
string
|
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
|
Contains one or more URLs for a template. Allowable Values: One or more |
rewards_disclosure.template_urls.html
string
|
URL to the HTML version of the document template. Allowable Values: A valid URL |
rewards_disclosure.template_created_time
datetime
|
Date and time when the template was created. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
terms_schedule
object
|
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.template_token
string
|
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
|
Contains one or more URLs for a template. Allowable Values: One or more |
terms_schedule.template_urls.html
string
|
URL to the HTML version of the document template. Allowable Values: A valid URL |
terms_schedule.template_created_time
datetime
|
Date and time when the template was created. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
benefits_disclosure_traditional
object
|
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.asset_token
string
|
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
|
Contains one or more URLs for an asset. Allowable Values: One or more |
benefits_disclosure_traditional.asset_urls.pdf
string
|
URL to the PDF version of the asset. Allowable Values: A valid URL |
benefits_disclosure_traditional.asset_urls.png
string
|
URL to the PNG version of the asset. Allowable Values: A valid URL |
benefits_disclosure_traditional.asset_urls.html
string
|
URL to the HTML version of the asset. Allowable Values: A valid URL |
benefits_disclosure_traditional.asset_created_time
datetime
|
Date and time when the asset was created. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
benefits_disclosure_premium
object
|
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.asset_token
string
|
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
|
Contains one or more URLs for an asset. Allowable Values: One or more |
benefits_disclosure_premium.asset_urls.pdf
string
|
URL to the PDF version of the asset. Allowable Values: A valid URL |
benefits_disclosure_premium.asset_urls.png
string
|
URL to the PNG version of the asset. Allowable Values: A valid URL |
benefits_disclosure_premium.asset_urls.html
string
|
URL to the HTML version of the asset. Allowable Values: A valid URL |
benefits_disclosure_premium.asset_created_time
datetime
|
Date and time when the asset was created. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
privacy_policy
object
|
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.asset_token
string
|
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
|
Contains one or more URLs for an asset. Allowable Values: One or more |
privacy_policy.asset_urls.pdf
string
|
URL to the PDF version of the asset. Allowable Values: A valid URL |
privacy_policy.asset_urls.png
string
|
URL to the PNG version of the asset. Allowable Values: A valid URL |
privacy_policy.asset_urls.html
string
|
URL to the HTML version of the asset. Allowable Values: A valid URL |
privacy_policy.asset_created_time
datetime
|
Date and time when the asset was created. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
e_disclosure
object
|
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.asset_token
string
|
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
|
Contains one or more URLs for an asset. Allowable Values: One or more |
e_disclosure.asset_urls.pdf
string
|
URL to the PDF version of the asset. Allowable Values: A valid URL |
e_disclosure.asset_urls.png
string
|
URL to the PNG version of the asset. Allowable Values: A valid URL |
e_disclosure.asset_urls.html
string
|
URL to the HTML version of the asset. Allowable Values: A valid URL |
e_disclosure.asset_created_time
datetime
|
Date and time when the asset was created. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
card_member_agreement
object
|
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.asset_token
string
|
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
|
Contains one or more URLs for an asset. Allowable Values: One or more |
card_member_agreement.asset_urls.pdf
string
|
URL to the PDF version of the asset. Allowable Values: A valid URL |
card_member_agreement.asset_urls.png
string
|
URL to the PNG version of the asset. Allowable Values: A valid URL |
card_member_agreement.asset_urls.html
string
|
URL to the HTML version of the asset. Allowable Values: A valid URL |
card_member_agreement.asset_created_time
datetime
|
Date and time when the asset was created. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
account_statement
object
|
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.template_token
string
|
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
|
Contains one or more URLs for a template. Allowable Values: One or more |
account_statement.template_urls.html
string
|
URL to the HTML version of the document template. Allowable Values: A valid URL |
account_statement.template_created_time
datetime
|
Date and time when the template was created. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
noaa_single_reason
object
|
Contains information on the Notice of Adverse Action (NOAA) used when an application is declined for single reason. Allowable Values: Existing |
noaa_single_reason.template_token
string
|
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
|
Contains one or more URLs for a template. Allowable Values: One or more |
noaa_single_reason.template_urls.html
string
|
URL to the HTML version of the document template. Allowable Values: A valid URL |
noaa_single_reason.template_created_time
datetime
|
Date and time when the template was created. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
noaa_single_reason_with_dodd_frank
object
|
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.template_token
string
|
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
|
Contains one or more URLs for a template. Allowable Values: One or more |
noaa_single_reason_with_dodd_frank.template_urls.html
string
|
URL to the HTML version of the document template. Allowable Values: A valid URL |
noaa_single_reason_with_dodd_frank.template_created_time
datetime
|
Date and time when the template was created. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
noaa_multiple_reason_with_dodd_frank
object
|
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.template_token
string
|
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
|
Contains one or more URLs for a template. Allowable Values: One or more |
noaa_multiple_reason_with_dodd_frank.template_urls.html
string
|
URL to the HTML version of the document template. Allowable Values: A valid URL |
noaa_multiple_reason_with_dodd_frank.template_created_time
datetime
|
Date and time when the template was created. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
created_time
datetime
|
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
|
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 |
List document policies
Copy section link
Action: GET
Endpoint: /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
Copy section link
| Fields | Description |
|---|---|
count
integer
|
The number of resources to retrieve. Allowable Values: 1–100 |
start_index
integer
|
Sort order index of the first resource in the returned array. Allowable Values: 0 min |
sort_by
string
|
Field on which to sort.
Prefix the field name with a hyphen ( NOTE:
You must sort using system field names such as Allowable Values:
|
Response body
Copy section link
| Fields | Description |
|---|---|
count
integer
|
Number of resources returned. Allowable Values: 1-10 |
start_index
integer
|
Sort order index of the first resource in the returned array. Allowable Values: Any integer |
end_index
integer
|
Sort order index of the last resource in the returned array. Allowable Values: Any integer |
is_more
boolean
|
A value of Allowable Values:
|
data
array of objects
|
One or more document policies. Allowable Values: One or more document policy objects |
data[].token
string
|
Unique identifier of the document policy. Allowable Values: 36 char max |
data[].name
string
|
Name of the document policy. Allowable Values: 255 char max |
data[].summary_of_credit_terms
object
|
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 |
data[].summary_of_credit_terms.asset_token
string
|
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
|
Contains one or more URLs for an asset. Allowable Values: One or more |
data[].summary_of_credit_terms.asset_urls.pdf
string
|
URL to the PDF version of the asset. Allowable Values: A valid URL |
data[].summary_of_credit_terms.asset_urls.png
string
|
URL to the PNG version of the asset. Allowable Values: A valid URL |
data[].summary_of_credit_terms.asset_urls.html
string
|
URL to the HTML version of the asset. Allowable Values: A valid URL |
data[].summary_of_credit_terms.asset_created_time
datetime
|
Date and time when the asset was created. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
data[].summary_of_credit_terms.template_token
string
|
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
|
Contains one or more URLs for a template. Allowable Values: One or more |
data[].summary_of_credit_terms.template_urls.html
string
|
URL to the HTML version of the document template. Allowable Values: A valid URL |
data[].summary_of_credit_terms.template_created_time
datetime
|
Date and time when the template was created. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
data[].rewards_disclosure
object
|
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 |
data[].rewards_disclosure.asset_token
string
|
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
|
Contains one or more URLs for an asset. Allowable Values: One or more |
data[].rewards_disclosure.asset_urls.pdf
string
|
URL to the PDF version of the asset. Allowable Values: A valid URL |
data[].rewards_disclosure.asset_urls.png
string
|
URL to the PNG version of the asset. Allowable Values: A valid URL |
data[].rewards_disclosure.asset_urls.html
string
|
URL to the HTML version of the asset. Allowable Values: A valid URL |
data[].rewards_disclosure.asset_created_time
datetime
|
Date and time when the asset was created. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
data[].rewards_disclosure.template_token
string
|
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
|
Contains one or more URLs for a template. Allowable Values: One or more |
data[].rewards_disclosure.template_urls.html
string
|
URL to the HTML version of the document template. Allowable Values: A valid URL |
data[].rewards_disclosure.template_created_time
datetime
|
Date and time when the template was created. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
data[].terms_schedule
object
|
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 |
data[].terms_schedule.template_token
string
|
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
|
Contains one or more URLs for a template. Allowable Values: One or more |
data[].terms_schedule.template_urls.html
string
|
URL to the HTML version of the document template. Allowable Values: A valid URL |
data[].terms_schedule.template_created_time
datetime
|
Date and time when the template was created. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
data[].benefits_disclosure_traditional
object
|
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 |
data[].benefits_disclosure_traditional.asset_token
string
|
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
|
Contains one or more URLs for an asset. Allowable Values: One or more |
data[].benefits_disclosure_traditional.asset_urls.pdf
string
|
URL to the PDF version of the asset. Allowable Values: A valid URL |
data[].benefits_disclosure_traditional.asset_urls.png
string
|
URL to the PNG version of the asset. Allowable Values: A valid URL |
data[].benefits_disclosure_traditional.asset_urls.html
string
|
URL to the HTML version of the asset. Allowable Values: A valid URL |
data[].benefits_disclosure_traditional.asset_created_time
datetime
|
Date and time when the asset was created. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
data[].benefits_disclosure_premium
object
|
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 |
data[].benefits_disclosure_premium.asset_token
string
|
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
|
Contains one or more URLs for an asset. Allowable Values: One or more |
data[].benefits_disclosure_premium.asset_urls.pdf
string
|
URL to the PDF version of the asset. Allowable Values: A valid URL |
data[].benefits_disclosure_premium.asset_urls.png
string
|
URL to the PNG version of the asset. Allowable Values: A valid URL |
data[].benefits_disclosure_premium.asset_urls.html
string
|
URL to the HTML version of the asset. Allowable Values: A valid URL |
data[].benefits_disclosure_premium.asset_created_time
datetime
|
Date and time when the asset was created. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
data[].privacy_policy
object
|
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 |
data[].privacy_policy.asset_token
string
|
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
|
Contains one or more URLs for an asset. Allowable Values: One or more |
data[].privacy_policy.asset_urls.pdf
string
|
URL to the PDF version of the asset. Allowable Values: A valid URL |
data[].privacy_policy.asset_urls.png
string
|
URL to the PNG version of the asset. Allowable Values: A valid URL |
data[].privacy_policy.asset_urls.html
string
|
URL to the HTML version of the asset. Allowable Values: A valid URL |
data[].privacy_policy.asset_created_time
datetime
|
Date and time when the asset was created. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
data[].e_disclosure
object
|
Contains information on the eDisclosure, which is a pre-application disclosure that states that users are to receive their disclosures electronically. Allowable Values: Existing |
data[].e_disclosure.asset_token
string
|
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
|
Contains one or more URLs for an asset. Allowable Values: One or more |
data[].e_disclosure.asset_urls.pdf
string
|
URL to the PDF version of the asset. Allowable Values: A valid URL |
data[].e_disclosure.asset_urls.png
string
|
URL to the PNG version of the asset. Allowable Values: A valid URL |
data[].e_disclosure.asset_urls.html
string
|
URL to the HTML version of the asset. Allowable Values: A valid URL |
data[].e_disclosure.asset_created_time
datetime
|
Date and time when the asset was created. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
data[].card_member_agreement
object
|
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 |
data[].card_member_agreement.asset_token
string
|
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
|
Contains one or more URLs for an asset. Allowable Values: One or more |
data[].card_member_agreement.asset_urls.pdf
string
|
URL to the PDF version of the asset. Allowable Values: A valid URL |
data[].card_member_agreement.asset_urls.png
string
|
URL to the PNG version of the asset. Allowable Values: A valid URL |
data[].card_member_agreement.asset_urls.html
string
|
URL to the HTML version of the asset. Allowable Values: A valid URL |
data[].card_member_agreement.asset_created_time
datetime
|
Date and time when the asset was created. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
data[].account_statement
object
|
Contains information on the Account Statement, which outlines the information that appears on the statements generated for a credit account. Allowable Values: Existing |
data[].account_statement.template_token
string
|
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
|
Contains one or more URLs for a template. Allowable Values: One or more |
data[].account_statement.template_urls.html
string
|
URL to the HTML version of the document template. Allowable Values: A valid URL |
data[].account_statement.template_created_time
datetime
|
Date and time when the template was created. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
data[].noaa_single_reason
object
|
Contains information on the Notice of Adverse Action (NOAA) used when an application is declined for single reason. Allowable Values: Existing |
data[].noaa_single_reason.template_token
string
|
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
|
Contains one or more URLs for a template. Allowable Values: One or more |
data[].noaa_single_reason.template_urls.html
string
|
URL to the HTML version of the document template. Allowable Values: A valid URL |
data[].noaa_single_reason.template_created_time
datetime
|
Date and time when the template was created. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
data[].noaa_single_reason_with_dodd_frank
object
|
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 |
data[].noaa_single_reason_with_dodd_frank.template_token
string
|
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
|
Contains one or more URLs for a template. Allowable Values: One or more |
data[].noaa_single_reason_with_dodd_frank.template_urls.html
string
|
URL to the HTML version of the document template. Allowable Values: A valid URL |
data[].noaa_single_reason_with_dodd_frank.template_created_time
datetime
|
Date and time when the template was created. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
data[].noaa_multiple_reason_with_dodd_frank
object
|
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 |
data[].noaa_multiple_reason_with_dodd_frank.template_token
string
|
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
|
Contains one or more URLs for a template. Allowable Values: One or more |
data[].noaa_multiple_reason_with_dodd_frank.template_urls.html
string
|
URL to the HTML version of the document template. Allowable Values: A valid URL |
data[].noaa_multiple_reason_with_dodd_frank.template_created_time
datetime
|
Date and time when the template was created. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
data[].created_time
datetime
|
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
|
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 |
Retrieve document policy
Copy section link
Action: GET
Endpoint: /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
Copy section link
| Fields | Description |
|---|---|
token
string
|
The unique identifier of the document policy to retrieve. Send a Allowable Values: Existing document policy token |
Response body
Copy section link
| Fields | Description |
|---|---|
token
string
|
Unique identifier of the document policy. Allowable Values: 36 char max |
name
string
|
Name of the document policy. Allowable Values: 255 char max |
summary_of_credit_terms
object
|
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.asset_token
string
|
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
|
Contains one or more URLs for an asset. Allowable Values: One or more |
summary_of_credit_terms.asset_urls.pdf
string
|
URL to the PDF version of the asset. Allowable Values: A valid URL |
summary_of_credit_terms.asset_urls.png
string
|
URL to the PNG version of the asset. Allowable Values: A valid URL |
summary_of_credit_terms.asset_urls.html
string
|
URL to the HTML version of the asset. Allowable Values: A valid URL |
summary_of_credit_terms.asset_created_time
datetime
|
Date and time when the asset was created. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
summary_of_credit_terms.template_token
string
|
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
|
Contains one or more URLs for a template. Allowable Values: One or more |
summary_of_credit_terms.template_urls.html
string
|
URL to the HTML version of the document template. Allowable Values: A valid URL |
summary_of_credit_terms.template_created_time
datetime
|
Date and time when the template was created. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
rewards_disclosure
object
|
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.asset_token
string
|
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
|
Contains one or more URLs for an asset. Allowable Values: One or more |
rewards_disclosure.asset_urls.pdf
string
|
URL to the PDF version of the asset. Allowable Values: A valid URL |
rewards_disclosure.asset_urls.png
string
|
URL to the PNG version of the asset. Allowable Values: A valid URL |
rewards_disclosure.asset_urls.html
string
|
URL to the HTML version of the asset. Allowable Values: A valid URL |
rewards_disclosure.asset_created_time
datetime
|
Date and time when the asset was created. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
rewards_disclosure.template_token
string
|
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
|
Contains one or more URLs for a template. Allowable Values: One or more |
rewards_disclosure.template_urls.html
string
|
URL to the HTML version of the document template. Allowable Values: A valid URL |
rewards_disclosure.template_created_time
datetime
|
Date and time when the template was created. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
terms_schedule
object
|
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.template_token
string
|
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
|
Contains one or more URLs for a template. Allowable Values: One or more |
terms_schedule.template_urls.html
string
|
URL to the HTML version of the document template. Allowable Values: A valid URL |
terms_schedule.template_created_time
datetime
|
Date and time when the template was created. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
benefits_disclosure_traditional
object
|
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.asset_token
string
|
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
|
Contains one or more URLs for an asset. Allowable Values: One or more |
benefits_disclosure_traditional.asset_urls.pdf
string
|
URL to the PDF version of the asset. Allowable Values: A valid URL |
benefits_disclosure_traditional.asset_urls.png
string
|
URL to the PNG version of the asset. Allowable Values: A valid URL |
benefits_disclosure_traditional.asset_urls.html
string
|
URL to the HTML version of the asset. Allowable Values: A valid URL |
benefits_disclosure_traditional.asset_created_time
datetime
|
Date and time when the asset was created. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
benefits_disclosure_premium
object
|
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.asset_token
string
|
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
|
Contains one or more URLs for an asset. Allowable Values: One or more |
benefits_disclosure_premium.asset_urls.pdf
string
|
URL to the PDF version of the asset. Allowable Values: A valid URL |
benefits_disclosure_premium.asset_urls.png
string
|
URL to the PNG version of the asset. Allowable Values: A valid URL |
benefits_disclosure_premium.asset_urls.html
string
|
URL to the HTML version of the asset. Allowable Values: A valid URL |
benefits_disclosure_premium.asset_created_time
datetime
|
Date and time when the asset was created. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
privacy_policy
object
|
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.asset_token
string
|
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
|
Contains one or more URLs for an asset. Allowable Values: One or more |
privacy_policy.asset_urls.pdf
string
|
URL to the PDF version of the asset. Allowable Values: A valid URL |
privacy_policy.asset_urls.png
string
|
URL to the PNG version of the asset. Allowable Values: A valid URL |
privacy_policy.asset_urls.html
string
|
URL to the HTML version of the asset. Allowable Values: A valid URL |
privacy_policy.asset_created_time
datetime
|
Date and time when the asset was created. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
e_disclosure
object
|
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.asset_token
string
|
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
|
Contains one or more URLs for an asset. Allowable Values: One or more |
e_disclosure.asset_urls.pdf
string
|
URL to the PDF version of the asset. Allowable Values: A valid URL |
e_disclosure.asset_urls.png
string
|
URL to the PNG version of the asset. Allowable Values: A valid URL |
e_disclosure.asset_urls.html
string
|
URL to the HTML version of the asset. Allowable Values: A valid URL |
e_disclosure.asset_created_time
datetime
|
Date and time when the asset was created. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
card_member_agreement
object
|
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.asset_token
string
|
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
|
Contains one or more URLs for an asset. Allowable Values: One or more |
card_member_agreement.asset_urls.pdf
string
|
URL to the PDF version of the asset. Allowable Values: A valid URL |
card_member_agreement.asset_urls.png
string
|
URL to the PNG version of the asset. Allowable Values: A valid URL |
card_member_agreement.asset_urls.html
string
|
URL to the HTML version of the asset. Allowable Values: A valid URL |
card_member_agreement.asset_created_time
datetime
|
Date and time when the asset was created. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
account_statement
object
|
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.template_token
string
|
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
|
Contains one or more URLs for a template. Allowable Values: One or more |
account_statement.template_urls.html
string
|
URL to the HTML version of the document template. Allowable Values: A valid URL |
account_statement.template_created_time
datetime
|
Date and time when the template was created. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
noaa_single_reason
object
|
Contains information on the Notice of Adverse Action (NOAA) used when an application is declined for single reason. Allowable Values: Existing |
noaa_single_reason.template_token
string
|
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
|
Contains one or more URLs for a template. Allowable Values: One or more |
noaa_single_reason.template_urls.html
string
|
URL to the HTML version of the document template. Allowable Values: A valid URL |
noaa_single_reason.template_created_time
datetime
|
Date and time when the template was created. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
noaa_single_reason_with_dodd_frank
object
|
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.template_token
string
|
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
|
Contains one or more URLs for a template. Allowable Values: One or more |
noaa_single_reason_with_dodd_frank.template_urls.html
string
|
URL to the HTML version of the document template. Allowable Values: A valid URL |
noaa_single_reason_with_dodd_frank.template_created_time
datetime
|
Date and time when the template was created. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
noaa_multiple_reason_with_dodd_frank
object
|
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.template_token
string
|
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
|
Contains one or more URLs for a template. Allowable Values: One or more |
noaa_multiple_reason_with_dodd_frank.template_urls.html
string
|
URL to the HTML version of the document template. Allowable Values: A valid URL |
noaa_multiple_reason_with_dodd_frank.template_created_time
datetime
|
Date and time when the template was created. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
created_time
datetime
|
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
|
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 |
Update document policy
Copy section link
Action: PUT
Endpoint: /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
Copy section link
| Fields | Description |
|---|---|
token
string
|
The unique identifier of the document policy to update. Send a Allowable Values: Existing document policy token |
Request body
Copy section link
| Fields | Description |
|---|---|
name
string
|
Name of the document policy. Allowable Values: 255 char max |
summary_of_credit_terms
object
|
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.asset_token
string
|
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
|
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
|
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.asset_token
string
|
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
|
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
|
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.template_token
string
|
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
|
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.asset_token
string
|
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
|
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.asset_token
string
|
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
|
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.asset_token
string
|
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
|
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.asset_token
string
|
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
|
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.asset_token
string
|
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
|
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.template_token
string
|
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
|
Contains information on the Notice of Adverse Action (NOAA) used when an application is declined for single reason. Allowable Values: Existing |
noaa_single_reason.template_token
string
|
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
|
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.template_token
string
|
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
|
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.template_token
string
|
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 |
Response body
Copy section link
| Fields | Description |
|---|---|
token
string
|
Unique identifier of the document policy. Allowable Values: 36 char max |
name
string
|
Name of the document policy. Allowable Values: 255 char max |
summary_of_credit_terms
object
|
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.asset_token
string
|
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
|
Contains one or more URLs for an asset. Allowable Values: One or more |
summary_of_credit_terms.asset_urls.pdf
string
|
URL to the PDF version of the asset. Allowable Values: A valid URL |
summary_of_credit_terms.asset_urls.png
string
|
URL to the PNG version of the asset. Allowable Values: A valid URL |
summary_of_credit_terms.asset_urls.html
string
|
URL to the HTML version of the asset. Allowable Values: A valid URL |
summary_of_credit_terms.asset_created_time
datetime
|
Date and time when the asset was created. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
summary_of_credit_terms.template_token
string
|
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
|
Contains one or more URLs for a template. Allowable Values: One or more |
summary_of_credit_terms.template_urls.html
string
|
URL to the HTML version of the document template. Allowable Values: A valid URL |
summary_of_credit_terms.template_created_time
datetime
|
Date and time when the template was created. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
rewards_disclosure
object
|
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.asset_token
string
|
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
|
Contains one or more URLs for an asset. Allowable Values: One or more |
rewards_disclosure.asset_urls.pdf
string
|
URL to the PDF version of the asset. Allowable Values: A valid URL |
rewards_disclosure.asset_urls.png
string
|
URL to the PNG version of the asset. Allowable Values: A valid URL |
rewards_disclosure.asset_urls.html
string
|
URL to the HTML version of the asset. Allowable Values: A valid URL |
rewards_disclosure.asset_created_time
datetime
|
Date and time when the asset was created. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
rewards_disclosure.template_token
string
|
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
|
Contains one or more URLs for a template. Allowable Values: One or more |
rewards_disclosure.template_urls.html
string
|
URL to the HTML version of the document template. Allowable Values: A valid URL |
rewards_disclosure.template_created_time
datetime
|
Date and time when the template was created. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
terms_schedule
object
|
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.template_token
string
|
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
|
Contains one or more URLs for a template. Allowable Values: One or more |
terms_schedule.template_urls.html
string
|
URL to the HTML version of the document template. Allowable Values: A valid URL |
terms_schedule.template_created_time
datetime
|
Date and time when the template was created. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
benefits_disclosure_traditional
object
|
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.asset_token
string
|
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
|
Contains one or more URLs for an asset. Allowable Values: One or more |
benefits_disclosure_traditional.asset_urls.pdf
string
|
URL to the PDF version of the asset. Allowable Values: A valid URL |
benefits_disclosure_traditional.asset_urls.png
string
|
URL to the PNG version of the asset. Allowable Values: A valid URL |
benefits_disclosure_traditional.asset_urls.html
string
|
URL to the HTML version of the asset. Allowable Values: A valid URL |
benefits_disclosure_traditional.asset_created_time
datetime
|
Date and time when the asset was created. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
benefits_disclosure_premium
object
|
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.asset_token
string
|
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
|
Contains one or more URLs for an asset. Allowable Values: One or more |
benefits_disclosure_premium.asset_urls.pdf
string
|
URL to the PDF version of the asset. Allowable Values: A valid URL |
benefits_disclosure_premium.asset_urls.png
string
|
URL to the PNG version of the asset. Allowable Values: A valid URL |
benefits_disclosure_premium.asset_urls.html
string
|
URL to the HTML version of the asset. Allowable Values: A valid URL |
benefits_disclosure_premium.asset_created_time
datetime
|
Date and time when the asset was created. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
privacy_policy
object
|
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.asset_token
string
|
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
|
Contains one or more URLs for an asset. Allowable Values: One or more |
privacy_policy.asset_urls.pdf
string
|
URL to the PDF version of the asset. Allowable Values: A valid URL |
privacy_policy.asset_urls.png
string
|
URL to the PNG version of the asset. Allowable Values: A valid URL |
privacy_policy.asset_urls.html
string
|
URL to the HTML version of the asset. Allowable Values: A valid URL |
privacy_policy.asset_created_time
datetime
|
Date and time when the asset was created. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
e_disclosure
object
|
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.asset_token
string
|
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
|
Contains one or more URLs for an asset. Allowable Values: One or more |
e_disclosure.asset_urls.pdf
string
|
URL to the PDF version of the asset. Allowable Values: A valid URL |
e_disclosure.asset_urls.png
string
|
URL to the PNG version of the asset. Allowable Values: A valid URL |
e_disclosure.asset_urls.html
string
|
URL to the HTML version of the asset. Allowable Values: A valid URL |
e_disclosure.asset_created_time
datetime
|
Date and time when the asset was created. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
card_member_agreement
object
|
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.asset_token
string
|
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
|
Contains one or more URLs for an asset. Allowable Values: One or more |
card_member_agreement.asset_urls.pdf
string
|
URL to the PDF version of the asset. Allowable Values: A valid URL |
card_member_agreement.asset_urls.png
string
|
URL to the PNG version of the asset. Allowable Values: A valid URL |
card_member_agreement.asset_urls.html
string
|
URL to the HTML version of the asset. Allowable Values: A valid URL |
card_member_agreement.asset_created_time
datetime
|
Date and time when the asset was created. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
account_statement
object
|
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.template_token
string
|
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
|
Contains one or more URLs for a template. Allowable Values: One or more |
account_statement.template_urls.html
string
|
URL to the HTML version of the document template. Allowable Values: A valid URL |
account_statement.template_created_time
datetime
|
Date and time when the template was created. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
noaa_single_reason
object
|
Contains information on the Notice of Adverse Action (NOAA) used when an application is declined for single reason. Allowable Values: Existing |
noaa_single_reason.template_token
string
|
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
|
Contains one or more URLs for a template. Allowable Values: One or more |
noaa_single_reason.template_urls.html
string
|
URL to the HTML version of the document template. Allowable Values: A valid URL |
noaa_single_reason.template_created_time
datetime
|
Date and time when the template was created. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
noaa_single_reason_with_dodd_frank
object
|
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.template_token
string
|
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
|
Contains one or more URLs for a template. Allowable Values: One or more |
noaa_single_reason_with_dodd_frank.template_urls.html
string
|
URL to the HTML version of the document template. Allowable Values: A valid URL |
noaa_single_reason_with_dodd_frank.template_created_time
datetime
|
Date and time when the template was created. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
noaa_multiple_reason_with_dodd_frank
object
|
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.template_token
string
|
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
|
Contains one or more URLs for a template. Allowable Values: One or more |
noaa_multiple_reason_with_dodd_frank.template_urls.html
string
|
URL to the HTML version of the document template. Allowable Values: A valid URL |
noaa_multiple_reason_with_dodd_frank.template_created_time
datetime
|
Date and time when the template was created. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
created_time
datetime
|
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
|
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 |
Clone document policy
Copy section link
Action: POST
Endpoint: /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
Copy section link
| Fields | Description |
|---|---|
token
string
|
The unique identifier of the document policy to clone. Send a Allowable Values: Existing document policy token |
Response body
Copy section link
| Fields | Description |
|---|---|
token
string
|
Unique identifier of the document policy. Allowable Values: 36 char max |
name
string
|
Name of the document policy. Allowable Values: 255 char max |
summary_of_credit_terms
object
|
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.asset_token
string
|
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
|
Contains one or more URLs for an asset. Allowable Values: One or more |
summary_of_credit_terms.asset_urls.pdf
string
|
URL to the PDF version of the asset. Allowable Values: A valid URL |
summary_of_credit_terms.asset_urls.png
string
|
URL to the PNG version of the asset. Allowable Values: A valid URL |
summary_of_credit_terms.asset_urls.html
string
|
URL to the HTML version of the asset. Allowable Values: A valid URL |
summary_of_credit_terms.asset_created_time
datetime
|
Date and time when the asset was created. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
summary_of_credit_terms.template_token
string
|
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
|
Contains one or more URLs for a template. Allowable Values: One or more |
summary_of_credit_terms.template_urls.html
string
|
URL to the HTML version of the document template. Allowable Values: A valid URL |
summary_of_credit_terms.template_created_time
datetime
|
Date and time when the template was created. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
rewards_disclosure
object
|
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.asset_token
string
|
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
|
Contains one or more URLs for an asset. Allowable Values: One or more |
rewards_disclosure.asset_urls.pdf
string
|
URL to the PDF version of the asset. Allowable Values: A valid URL |
rewards_disclosure.asset_urls.png
string
|
URL to the PNG version of the asset. Allowable Values: A valid URL |
rewards_disclosure.asset_urls.html
string
|
URL to the HTML version of the asset. Allowable Values: A valid URL |
rewards_disclosure.asset_created_time
datetime
|
Date and time when the asset was created. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
rewards_disclosure.template_token
string
|
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
|
Contains one or more URLs for a template. Allowable Values: One or more |
rewards_disclosure.template_urls.html
string
|
URL to the HTML version of the document template. Allowable Values: A valid URL |
rewards_disclosure.template_created_time
datetime
|
Date and time when the template was created. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
terms_schedule
object
|
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.template_token
string
|
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
|
Contains one or more URLs for a template. Allowable Values: One or more |
terms_schedule.template_urls.html
string
|
URL to the HTML version of the document template. Allowable Values: A valid URL |
terms_schedule.template_created_time
datetime
|
Date and time when the template was created. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
benefits_disclosure_traditional
object
|
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.asset_token
string
|
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
|
Contains one or more URLs for an asset. Allowable Values: One or more |
benefits_disclosure_traditional.asset_urls.pdf
string
|
URL to the PDF version of the asset. Allowable Values: A valid URL |
benefits_disclosure_traditional.asset_urls.png
string
|
URL to the PNG version of the asset. Allowable Values: A valid URL |
benefits_disclosure_traditional.asset_urls.html
string
|
URL to the HTML version of the asset. Allowable Values: A valid URL |
benefits_disclosure_traditional.asset_created_time
datetime
|
Date and time when the asset was created. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
benefits_disclosure_premium
object
|
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.asset_token
string
|
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
|
Contains one or more URLs for an asset. Allowable Values: One or more |
benefits_disclosure_premium.asset_urls.pdf
string
|
URL to the PDF version of the asset. Allowable Values: A valid URL |
benefits_disclosure_premium.asset_urls.png
string
|
URL to the PNG version of the asset. Allowable Values: A valid URL |
benefits_disclosure_premium.asset_urls.html
string
|
URL to the HTML version of the asset. Allowable Values: A valid URL |
benefits_disclosure_premium.asset_created_time
datetime
|
Date and time when the asset was created. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
privacy_policy
object
|
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.asset_token
string
|
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
|
Contains one or more URLs for an asset. Allowable Values: One or more |
privacy_policy.asset_urls.pdf
string
|
URL to the PDF version of the asset. Allowable Values: A valid URL |
privacy_policy.asset_urls.png
string
|
URL to the PNG version of the asset. Allowable Values: A valid URL |
privacy_policy.asset_urls.html
string
|
URL to the HTML version of the asset. Allowable Values: A valid URL |
privacy_policy.asset_created_time
datetime
|
Date and time when the asset was created. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
e_disclosure
object
|
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.asset_token
string
|
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
|
Contains one or more URLs for an asset. Allowable Values: One or more |
e_disclosure.asset_urls.pdf
string
|
URL to the PDF version of the asset. Allowable Values: A valid URL |
e_disclosure.asset_urls.png
string
|
URL to the PNG version of the asset. Allowable Values: A valid URL |
e_disclosure.asset_urls.html
string
|
URL to the HTML version of the asset. Allowable Values: A valid URL |
e_disclosure.asset_created_time
datetime
|
Date and time when the asset was created. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
card_member_agreement
object
|
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.asset_token
string
|
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
|
Contains one or more URLs for an asset. Allowable Values: One or more |
card_member_agreement.asset_urls.pdf
string
|
URL to the PDF version of the asset. Allowable Values: A valid URL |
card_member_agreement.asset_urls.png
string
|
URL to the PNG version of the asset. Allowable Values: A valid URL |
card_member_agreement.asset_urls.html
string
|
URL to the HTML version of the asset. Allowable Values: A valid URL |
card_member_agreement.asset_created_time
datetime
|
Date and time when the asset was created. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
account_statement
object
|
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.template_token
string
|
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
|
Contains one or more URLs for a template. Allowable Values: One or more |
account_statement.template_urls.html
string
|
URL to the HTML version of the document template. Allowable Values: A valid URL |
account_statement.template_created_time
datetime
|
Date and time when the template was created. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
noaa_single_reason
object
|
Contains information on the Notice of Adverse Action (NOAA) used when an application is declined for single reason. Allowable Values: Existing |
noaa_single_reason.template_token
string
|
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
|
Contains one or more URLs for a template. Allowable Values: One or more |
noaa_single_reason.template_urls.html
string
|
URL to the HTML version of the document template. Allowable Values: A valid URL |
noaa_single_reason.template_created_time
datetime
|
Date and time when the template was created. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
noaa_single_reason_with_dodd_frank
object
|
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.template_token
string
|
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
|
Contains one or more URLs for a template. Allowable Values: One or more |
noaa_single_reason_with_dodd_frank.template_urls.html
string
|
URL to the HTML version of the document template. Allowable Values: A valid URL |
noaa_single_reason_with_dodd_frank.template_created_time
datetime
|
Date and time when the template was created. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
noaa_multiple_reason_with_dodd_frank
object
|
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.template_token
string
|
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
|
Contains one or more URLs for a template. Allowable Values: One or more |
noaa_multiple_reason_with_dodd_frank.template_urls.html
string
|
URL to the HTML version of the document template. Allowable Values: A valid URL |
noaa_multiple_reason_with_dodd_frank.template_created_time
datetime
|
Date and time when the template was created. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
created_time
datetime
|
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
|
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 |
Create credit product policy
Copy section link
Action: POST
Endpoint: /credit/policies/products
Create a new credit product policy.
Request body
Copy section link
| Fields | Description |
|---|---|
token
string
|
Unique identifier of the credit product policy. Allowable Values: 36 char max |
card_products
array of objects
|
One or more card products associated with the credit product policy. Allowable Values: One or more |
card_products[].token
string
|
Unique identifier of the card product. Allowable Values: 36 char max |
card_products[].level
string
|
Level of the card product. Allowable Values:
|
name
string
|
Name of the credit product policy. Allowable Values: 1 char min |
description
string
|
Description of the credit product policy. Allowable Values: 255 char max |
classification
string
|
Specifies for whom the credit product is intended.
Allowable Values:
|
product_type
string
|
Type of credit product.
Allowable Values:
|
product_sub_type
string
|
Subtype of the credit product type.
Allowable Values:
|
currency_code
string
|
A valid three-digit ISO 4217 currency code Allowable Values:
|
credit_line
object
|
Contains information on the credit line range. Allowable Values: Existing |
credit_line.min
decimal
|
Minimum credit limit. Allowable Values: 0–999999999999.99 |
credit_line.max
decimal
|
Maximum credit limit. Allowable Values: 0–999999999999.99 |
usage
array of strings
|
One or more usage types for the credit product policy. Allowable Values:
|
interest_calculation
object
|
Contains the configurations for interest calculation. Allowable Values: Existing |
interest_calculation.method
string
|
Method of interest calculation. Allowable Values:
|
interest_calculation.day_count
string
|
Day-count convention. Allowable Values:
|
interest_calculation.interest_application
array of strings
|
One or more balance types on which interest is applied. Allowable Values:
|
interest_calculation.minimum_interest
decimal
|
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
|
Determines whether to charge or waive interest for the billing period when the balance is paid off. Allowable Values:
|
interest_calculation.grace_days_application
string
|
Determines the last day of grace period based on which interest charges are calculated. Allowable Values:
|
interest_calculation.application_of_credits
object
|
Contains information on the cycle type and billing cycle day when credits are applied in the daily balance calculation. Allowable Values: Existing |
interest_calculation.application_of_credits.cycle_type
string
|
Type of cycle.
Allowable Values:
|
interest_calculation.application_of_credits.day
integer
|
Day of the billing cycle when credits are applied. Allowable Values: 1–31 |
interest_calculation.exclude_tran_types
array of strings
|
One or more transactions that are excluded from current billing period’s interest charge, but included in next. Allowable Values:
|
payments
object
|
Contains the configurations for billing cycle day, payment due day, and fees. Allowable Values: Existing |
payments.billing_cycle_day
integer
|
Day of month the billing cycle starts. Allowable Values: 1 |
payments.due_day
integer
|
Day of month the payment for the previous billing cycle is due. Allowable Values: 31 |
payments.allocation_order
array of strings
|
Ordered list of balance types to which payments are allocated, from first to last. Allowable Values:
|
payments.min_payment_calculation
object
|
Contains information used to calculate the minimum payment amount on a credit product policy. Allowable Values: Existing |
payments.min_payment_calculation.include_past_due_amount
boolean
|
Whether to include the past due amount when calculating the minimum payment. Allowable Values:
|
payments.min_payment_calculation.include_overlimit_amount
boolean
|
Whether to include the overlimit amount when calculating the minimum payment. Allowable Values:
|
payments.min_payment_calculation.min_payment_flat_amount
decimal
|
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
|
Contains information used to calculate the minimum payment amount when expressed as a percentage. Allowable Values: Existing |
payments.min_payment_calculation.min_payment_percentage.percentage_of_balance
decimal
|
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
|
Whether to include the amount of interest charged when calculating the minimum payment. Allowable Values:
|
payments.min_payment_calculation.min_payment_percentage.include_fees_charged
array of strings
|
One or more fee types to include when calculating the minimum payment. Allowable Values:
|
Response body
Copy section link
| Fields | Description |
|---|---|
token
string
|
Unique identifier of the credit product policy. Allowable Values: 36 char max |
card_products
array of objects
|
One or more card products associated with the credit product policy. Allowable Values: One or more |
card_products[].token
string
|
Unique identifier of the card product. Allowable Values: 36 char max |
card_products[].level
string
|
Level of the card product. Allowable Values:
|
card_products[].network
string
|
Name of the card network. Allowable Values:
|
name
string
|
Name of the credit product policy. Allowable Values: 1 char min |
description
string
|
Description of the credit product policy. Allowable Values: 255 char max |
classification
string
|
Specifies for whom the credit product is intended.
Allowable Values:
|
product_type
string
|
Type of credit product.
Allowable Values:
|
product_sub_type
string
|
Subtype of the credit product type.
Allowable Values:
|
currency_code
string
|
A valid three-digit ISO 4217 currency code Allowable Values:
|
credit_line
object
|
Contains information on the credit line range. Allowable Values: Existing |
credit_line.min
decimal
|
Minimum credit limit. Allowable Values: 0–999999999999.99 |
credit_line.max
decimal
|
Maximum credit limit. Allowable Values: 0–999999999999.99 |
usage
array of strings
|
One or more usage types for the credit product policy. Allowable Values:
Valid |
interest_calculation
object
|
Contains the configurations for interest calculation. Allowable Values: Existing |
interest_calculation.method
string
|
Method of interest calculation. Allowable Values:
|
interest_calculation.day_count
string
|
Day-count convention. Allowable Values:
|
interest_calculation.interest_application
array of strings
|
One or more balance types on which interest is applied. Allowable Values:
|
interest_calculation.minimum_interest
decimal
|
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
|
Determines whether to charge or waive interest for the billing period when the balance is paid off. Allowable Values:
|
interest_calculation.grace_days_application
string
|
Determines the last day of grace period based on which interest charges are calculated. Allowable Values:
|
interest_calculation.application_of_credits
object
|
Contains information on the cycle type and billing cycle day when credits are applied in the daily balance calculation. Allowable Values: Existing |
interest_calculation.application_of_credits.cycle_type
string
|
Type of cycle.
Allowable Values:
|
interest_calculation.application_of_credits.day
integer
|
Day of the billing cycle when credits are applied. Allowable Values: 1–31 |
interest_calculation.exclude_tran_types
array of strings
|
One or more transactions that are excluded from current billing period’s interest charge, but included in next. Allowable Values:
|
payments
object
|
Contains the configurations for billing cycle day, payment due day, and fees. Allowable Values: Existing |
payments.billing_cycle_day
integer
|
Day of month the billing cycle starts. Allowable Values: 1 |
payments.due_day
integer
|
Day of month the payment for the previous billing cycle is due. Allowable Values: 31 |
payments.allocation_order
array of strings
|
Ordered list of balance types to which payments are allocated, from first to last. Allowable Values:
|
payments.min_payment_calculation
object
|
Contains information used to calculate the minimum payment amount on a credit product policy. Allowable Values: Existing |
payments.min_payment_calculation.include_past_due_amount
boolean
|
Whether to include the past due amount when calculating the minimum payment. Allowable Values:
|
payments.min_payment_calculation.include_overlimit_amount
boolean
|
Whether to include the overlimit amount when calculating the minimum payment. Allowable Values:
|
payments.min_payment_calculation.min_payment_flat_amount
decimal
|
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
|
Contains information used to calculate the minimum payment amount when expressed as a percentage. Allowable Values: Existing |
payments.min_payment_calculation.min_payment_percentage.percentage_of_balance
decimal
|
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
|
Whether to include the amount of interest charged when calculating the minimum payment. Allowable Values:
|
payments.min_payment_calculation.min_payment_percentage.include_fees_charged
array of strings
|
One or more fee types to include when calculating the minimum payment. Allowable Values:
|
created_time
datetime
|
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
|
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 |
List credit product policies
Copy section link
Action: GET
Endpoint: /credit/policies/products
Retrieve an array of existing credit product policies.
This endpoint supports sorting and pagination.
URL query parameters
Copy section link
| Fields | Description |
|---|---|
count
integer
|
The number of resources to retrieve. Allowable Values: 1–100 |
start_index
integer
|
Sort order index of the first resource in the returned array. Allowable Values: 0 min |
sort_by
string
|
Field on which to sort.
Prefix the field name with a hyphen ( NOTE:
You must sort using system field names such as Allowable Values:
|
Response body
Copy section link
| Fields | Description |
|---|---|
count
integer
|
Number of resources returned. Allowable Values: 1-10 |
start_index
integer
|
Sort order index of the first resource in the returned array. Allowable Values: Any integer |
end_index
integer
|
Sort order index of the last resource in the returned array. Allowable Values: Any integer |
is_more
boolean
|
A value of Allowable Values:
|
data
array of objects
|
One or more credit product policies. Allowable Values: One or more credit product policy objects |
data[].token
string
|
Unique identifier of the credit product policy. Allowable Values: 36 char max |
data[].card_products
array of objects
|
One or more card products associated with the credit product policy. Allowable Values: One or more |
data[].card_products[].token
string
|
Unique identifier of the card product. Allowable Values: 36 char max |
data[].card_products[].level
string
|
Level of the card product. Allowable Values:
|
data[].card_products[].network
string
|
Name of the card network. Allowable Values:
|
data[].name
string
|
Name of the credit product policy. Allowable Values: 1 char min |
data[].description
string
|
Description of the credit product policy. Allowable Values: 255 char max |
data[].classification
string
|
Specifies for whom the credit product is intended.
Allowable Values:
|
data[].product_type
string
|
Type of credit product.
Allowable Values:
|
data[].product_sub_type
string
|
Subtype of the credit product type.
Allowable Values:
|
data[].currency_code
string
|
A valid three-digit ISO 4217 currency code Allowable Values:
|
data[].credit_line
object
|
Contains information on the credit line range. Allowable Values: Existing |
data[].credit_line.min
decimal
|
Minimum credit limit. Allowable Values: 0–999999999999.99 |
data[].credit_line.max
decimal
|
Maximum credit limit. Allowable Values: 0–999999999999.99 |
data[].usage
array of strings
|
One or more usage types for the credit product policy. Allowable Values:
Valid |
data[].interest_calculation
object
|
Contains the configurations for interest calculation. Allowable Values: Existing |
data[].interest_calculation.method
string
|
Method of interest calculation. Allowable Values:
|
data[].interest_calculation.day_count
string
|
Day-count convention. Allowable Values:
|
data[].interest_calculation.interest_application
array of strings
|
One or more balance types on which interest is applied. Allowable Values:
|
data[].interest_calculation.minimum_interest
decimal
|
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
|
Determines whether to charge or waive interest for the billing period when the balance is paid off. Allowable Values:
|
data[].interest_calculation.grace_days_application
string
|
Determines the last day of grace period based on which interest charges are calculated. Allowable Values:
|
data[].interest_calculation.application_of_credits
object
|
Contains information on the cycle type and billing cycle day when credits are applied in the daily balance calculation. Allowable Values: Existing |
data[].interest_calculation.application_of_credits.cycle_type
string
|
Type of cycle.
Allowable Values:
|
data[].interest_calculation.application_of_credits.day
integer
|
Day of the billing cycle when credits are applied. Allowable Values: 1–31 |
data[].interest_calculation.exclude_tran_types
array of strings
|
One or more transactions that are excluded from current billing period’s interest charge, but included in next. Allowable Values:
|
data[].payments
object
|
Contains the configurations for billing cycle day, payment due day, and fees. Allowable Values: Existing |
data[].payments.billing_cycle_day
integer
|
Day of month the billing cycle starts. Allowable Values: 1 |
data[].payments.due_day
integer
|
Day of month the payment for the previous billing cycle is due. Allowable Values: 31 |
data[].payments.allocation_order
array of strings
|
Ordered list of balance types to which payments are allocated, from first to last. Allowable Values:
|
data[].payments.min_payment_calculation
object
|
Contains information used to calculate the minimum payment amount on a credit product policy. Allowable Values: Existing |
data[].payments.min_payment_calculation.include_past_due_amount
boolean
|
Whether to include the past due amount when calculating the minimum payment. Allowable Values:
|
data[].payments.min_payment_calculation.include_overlimit_amount
boolean
|
Whether to include the overlimit amount when calculating the minimum payment. Allowable Values:
|
data[].payments.min_payment_calculation.min_payment_flat_amount
decimal
|
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
|
Contains information used to calculate the minimum payment amount when expressed as a percentage. Allowable Values: Existing |
data[].payments.min_payment_calculation.min_payment_percentage.percentage_of_balance
decimal
|
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
|
Whether to include the amount of interest charged when calculating the minimum payment. Allowable Values:
|
data[].payments.min_payment_calculation.min_payment_percentage.include_fees_charged
array of strings
|
One or more fee types to include when calculating the minimum payment. Allowable Values:
|
data[].created_time
datetime
|
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
|
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 |
Retrieve credit product policy
Copy section link
Action: GET
Endpoint: /credit/policies/products/{token}
Retrieve a specific credit product policy.
URL path parameters
Copy section link
| Fields | Description |
|---|---|
token
string
|
The unique identifier of the credit product policy to retrieve. Send a Allowable Values: Existing credit product policy token |
Response body
Copy section link
| Fields | Description |
|---|---|
token
string
|
Unique identifier of the credit product policy. Allowable Values: 36 char max |
card_products
array of objects
|
One or more card products associated with the credit product policy. Allowable Values: One or more |
card_products[].token
string
|
Unique identifier of the card product. Allowable Values: 36 char max |
card_products[].level
string
|
Level of the card product. Allowable Values:
|
card_products[].network
string
|
Name of the card network. Allowable Values:
|
name
string
|
Name of the credit product policy. Allowable Values: 1 char min |
description
string
|
Description of the credit product policy. Allowable Values: 255 char max |
classification
string
|
Specifies for whom the credit product is intended.
Allowable Values:
|
product_type
string
|
Type of credit product.
Allowable Values:
|
product_sub_type
string
|
Subtype of the credit product type.
Allowable Values:
|
currency_code
string
|
A valid three-digit ISO 4217 currency code Allowable Values:
|
credit_line
object
|
Contains information on the credit line range. Allowable Values: Existing |
credit_line.min
decimal
|
Minimum credit limit. Allowable Values: 0–999999999999.99 |
credit_line.max
decimal
|
Maximum credit limit. Allowable Values: 0–999999999999.99 |
usage
array of strings
|
One or more usage types for the credit product policy. Allowable Values:
Valid |
interest_calculation
object
|
Contains the configurations for interest calculation. Allowable Values: Existing |
interest_calculation.method
string
|
Method of interest calculation. Allowable Values:
|
interest_calculation.day_count
string
|
Day-count convention. Allowable Values:
|
interest_calculation.interest_application
array of strings
|
One or more balance types on which interest is applied. Allowable Values:
|
interest_calculation.minimum_interest
decimal
|
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
|
Determines whether to charge or waive interest for the billing period when the balance is paid off. Allowable Values:
|
interest_calculation.grace_days_application
string
|
Determines the last day of grace period based on which interest charges are calculated. Allowable Values:
|
interest_calculation.application_of_credits
object
|
Contains information on the cycle type and billing cycle day when credits are applied in the daily balance calculation. Allowable Values: Existing |
interest_calculation.application_of_credits.cycle_type
string
|
Type of cycle.
Allowable Values:
|
interest_calculation.application_of_credits.day
integer
|
Day of the billing cycle when credits are applied. Allowable Values: 1–31 |
interest_calculation.exclude_tran_types
array of strings
|
One or more transactions that are excluded from current billing period’s interest charge, but included in next. Allowable Values:
|
payments
object
|
Contains the configurations for billing cycle day, payment due day, and fees. Allowable Values: Existing |
payments.billing_cycle_day
integer
|
Day of month the billing cycle starts. Allowable Values: 1 |
payments.due_day
integer
|
Day of month the payment for the previous billing cycle is due. Allowable Values: 31 |
payments.allocation_order
array of strings
|
Ordered list of balance types to which payments are allocated, from first to last. Allowable Values:
|
payments.min_payment_calculation
object
|
Contains information used to calculate the minimum payment amount on a credit product policy. Allowable Values: Existing |
payments.min_payment_calculation.include_past_due_amount
boolean
|
Whether to include the past due amount when calculating the minimum payment. Allowable Values:
|
payments.min_payment_calculation.include_overlimit_amount
boolean
|
Whether to include the overlimit amount when calculating the minimum payment. Allowable Values:
|
payments.min_payment_calculation.min_payment_flat_amount
decimal
|
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
|
Contains information used to calculate the minimum payment amount when expressed as a percentage. Allowable Values: Existing |
payments.min_payment_calculation.min_payment_percentage.percentage_of_balance
decimal
|
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
|
Whether to include the amount of interest charged when calculating the minimum payment. Allowable Values:
|
payments.min_payment_calculation.min_payment_percentage.include_fees_charged
array of strings
|
One or more fee types to include when calculating the minimum payment. Allowable Values:
|
created_time datetime |