Credit Products
Important
This feature is being deprecated and replaced by credit product policies, which is part of the bundles feature. For more on policies and bundles in a credit program, see Credit Programs in the Marqeta Dashboard.The credit products feature on Marqeta’s credit platform enables you to create and manage a credit product and customize its characteristics, such as the credit line range and required fees or APRs. Credit product characteristics determine the behaviors and attributes of associated credit accounts. For more on credit products, see About Credit Products.
To receive webhook notifications when product transition events occur, see Credit product transition events in Event Types.
Important
To create and manage credit products, you must use the Marqeta Dashboard. For more, see Credit Products in the Marqeta Dashboard.
The following endpoints are displayed for reference purposes only.
Create credit product
Copy section link
Action: POST
Endpoint: /credit/products
Create a credit product.
Request body
Copy section link
| Fields | Description |
|---|---|
token
string
|
Unique identifier of the credit product. Allowable Values: 36 char max |
card_product_tokens
array of strings
|
One or more associated card product tokens. Allowable Values: Existing card product tokens |
name
string
|
Name of the credit product. Allowable Values: 255 char max |
description
string
|
Description of the credit product. Allowable Values: 255 char max |
status
string
|
Status of the credit product.
Allowable Values:
|
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. Allowable Values:
|
min_payment_percentage
decimal
|
Minimum payment, expressed as a percentage of the total statement balance, due on the payment due day. Allowable Values: 0.0001–100 |
min_payment_flat_amount
decimal
|
Minimum payment, expressed as a flat amount, due on the payment due day. Allowable Values: 0.01 min |
min_payment_calculation
object
|
Contains information used to calculate the minimum payment amount. Allowable Values: Existing |
min_payment_calculation.include_past_due_amount
boolean
|
Whether to include the past due amount when calculating the minimum payment. Allowable Values:
|
min_payment_calculation.min_payment_percentage
object
|
Contains information used to calculate the minimum payment percentage. Allowable Values: Existing |
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 |
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:
|
min_payment_calculation.min_payment_flat_amount
decimal
|
Minimum payment, expressed as a flat amount, due on the payment due day. Allowable Values: 0.01 min |
payment_allocation_order
array of strings
|
Ordered list of balance types to which payments are allocated, from first to last. 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:
|
config
object
|
Contains information on configurations for billing cycle day, payment due day, and fees. Allowable Values: Existing |
config.billing_cycle_day
integer
|
Day of month the billing cycle starts. Allowable Values: 1 |
config.payment_due_day
integer
|
Day of month the payment for the previous billing cycle is due. Allowable Values: 31 |
config.fees
array of strings
|
One or more fee types. Allowable Values:
|
config.periodic_fees
array of objects
|
Contains one or more periodic fees. Allowable Values: One or more |
config.periodic_fees[].frequency
string
|
How frequently the fee is charged. Allowable Values:
|
config.periodic_fees[].number_of_days_post_activation
integer
|
The number of days after an account is activated that the initial fee is charged.
For example, if the value in this field is Allowable Values: 1–1000 |
Response body
Copy section link
| Fields | Description |
|---|---|
token
string
|
Unique identifier of the credit product. Allowable Values: 36 char max |
parent_product_token
string
|
Unique identifier of the parent credit product. Allowable Values: Existing credit product token |
card_product_tokens
array of strings
|
One or more associated card product tokens. Allowable Values: Existing card product tokens |
name
string
|
Name of the credit product. Allowable Values: 255 char max |
description
string
|
Description of the credit product. Allowable Values: 255 char max |
status
string
|
Status of the credit product.
Allowable Values:
|
created_time
datetime
|
Date and time when the credit product 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 was last updated on Marqeta’s credit platform, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
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. Allowable Values:
|
min_payment_percentage
decimal
|
Minimum payment, expressed as a percentage of the total statement balance, due on the payment due day. Allowable Values: 0.0001–100 |
min_payment_flat_amount
decimal
|
Minimum payment, expressed as a flat amount, due on the payment due day. Allowable Values: 0.01 min |
min_payment_calculation
object
|
Contains information used to calculate the minimum payment amount. Allowable Values: Existing |
min_payment_calculation.include_past_due_amount
boolean
|
Whether to include the past due amount when calculating the minimum payment. Allowable Values:
|
min_payment_calculation.min_payment_percentage
object
|
Contains information used to calculate the minimum payment percentage. Allowable Values: Existing |
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 |
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:
|
min_payment_calculation.min_payment_flat_amount
decimal
|
Minimum payment, expressed as a flat amount, due on the payment due day. Allowable Values: 0.01 min |
payment_allocation_order
array of strings
|
Ordered list of balance types to which payments are allocated, from first to last. 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:
|
config
object
|
Contains information on configurations for billing cycle day, payment due day, and fees. Allowable Values: Existing |
config.billing_cycle_day
integer
|
Day of month the billing cycle starts. Allowable Values: 1 |
config.payment_due_day
integer
|
Day of month the payment for the previous billing cycle is due. Allowable Values: 31 |
config.fees
array of strings
|
One or more fee types. Allowable Values:
|
config.periodic_fees
array of objects
|
Contains one or more periodic fees. Allowable Values: One or more |
config.periodic_fees[].frequency
string
|
How frequently the fee is charged. Allowable Values:
|
config.periodic_fees[].number_of_days_post_activation
integer
|
The number of days after an account is activated that the initial fee is charged.
For example, if the value in this field is Allowable Values: 1–1000 |
List credit products
Copy section link
Action: GET
Endpoint: /credit/products
Retrieve an array of credit products.
This endpoint supports sorting and pagination.
URL query parameters
Copy section link
| Fields | Description |
|---|---|
status
array of strings
|
An array of statuses by which to filter credit products. Allowable Values:
|
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
|
Contains one or more credit product objects. Allowable Values: One or more credit product objects |
data[].token
string
|
Unique identifier of the credit product. Allowable Values: 36 char max |
data[].parent_product_token
string
|
Unique identifier of the parent credit product. Allowable Values: Existing credit product token |
data[].card_product_tokens
array of strings
|
One or more associated card product tokens. Allowable Values: Existing card product tokens |
data[].name
string
|
Name of the credit product. Allowable Values: 255 char max |
data[].description
string
|
Description of the credit product. Allowable Values: 255 char max |
data[].status
string
|
Status of the credit product.
Allowable Values:
|
data[].created_time
datetime
|
Date and time when the credit product 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 was last updated on Marqeta’s credit platform, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
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. Allowable Values:
|
data[].min_payment_percentage
decimal
|
Minimum payment, expressed as a percentage of the total statement balance, due on the payment due day. Allowable Values: 0.0001–100 |
data[].min_payment_flat_amount
decimal
|
Minimum payment, expressed as a flat amount, due on the payment due day. Allowable Values: 0.01 min |
data[].min_payment_calculation
object
|
Contains information used to calculate the minimum payment amount. Allowable Values: Existing |
data[].min_payment_calculation.include_past_due_amount
boolean
|
Whether to include the past due amount when calculating the minimum payment. Allowable Values:
|
data[].min_payment_calculation.min_payment_percentage
object
|
Contains information used to calculate the minimum payment percentage. Allowable Values: Existing |
data[].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[].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[].min_payment_calculation.min_payment_flat_amount
decimal
|
Minimum payment, expressed as a flat amount, due on the payment due day. Allowable Values: 0.01 min |
data[].payment_allocation_order
array of strings
|
Ordered list of balance types to which payments are allocated, from first to last. Allowable Values:
|
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[].config
object
|
Contains information on configurations for billing cycle day, payment due day, and fees. Allowable Values: Existing |
data[].config.billing_cycle_day
integer
|
Day of month the billing cycle starts. Allowable Values: 1 |
data[].config.payment_due_day
integer
|
Day of month the payment for the previous billing cycle is due. Allowable Values: 31 |
data[].config.fees
array of strings
|
One or more fee types. Allowable Values:
|
data[].config.periodic_fees
array of objects
|
Contains one or more periodic fees. Allowable Values: One or more |
data[].config.periodic_fees[].frequency
string
|
How frequently the fee is charged. Allowable Values:
|
data[].config.periodic_fees[].number_of_days_post_activation
integer
|
The number of days after an account is activated that the initial fee is charged.
For example, if the value in this field is Allowable Values: 1–1000 |
Retrieve credit product
Copy section link
Action: GET
Endpoint: /credit/products/{token}
Retrieve a credit product.
URL path parameters
Copy section link
| Fields | Description |
|---|---|
token
string
|
The unique identifier of the credit product to retrieve. Send a Allowable Values: Existing credit product token |
Response body
Copy section link
| Fields | Description |
|---|---|
token
string
|
Unique identifier of the credit product. Allowable Values: 36 char max |
parent_product_token
string
|
Unique identifier of the parent credit product. Allowable Values: Existing credit product token |
card_product_tokens
array of strings
|
One or more associated card product tokens. Allowable Values: Existing card product tokens |
name
string
|
Name of the credit product. Allowable Values: 255 char max |
description
string
|
Description of the credit product. Allowable Values: 255 char max |
status
string
|
Status of the credit product.
Allowable Values:
|
created_time
datetime
|
Date and time when the credit product 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 was last updated on Marqeta’s credit platform, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
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. Allowable Values:
|
min_payment_percentage
decimal
|
Minimum payment, expressed as a percentage of the total statement balance, due on the payment due day. Allowable Values: 0.0001–100 |
min_payment_flat_amount
decimal
|
Minimum payment, expressed as a flat amount, due on the payment due day. Allowable Values: 0.01 min |
min_payment_calculation
object
|
Contains information used to calculate the minimum payment amount. Allowable Values: Existing |
min_payment_calculation.include_past_due_amount
boolean
|
Whether to include the past due amount when calculating the minimum payment. Allowable Values:
|
min_payment_calculation.min_payment_percentage
object
|
Contains information used to calculate the minimum payment percentage. Allowable Values: Existing |
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 |
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:
|
min_payment_calculation.min_payment_flat_amount
decimal
|
Minimum payment, expressed as a flat amount, due on the payment due day. Allowable Values: 0.01 min |
payment_allocation_order
array of strings
|
Ordered list of balance types to which payments are allocated, from first to last. 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:
|
config
object
|
Contains information on configurations for billing cycle day, payment due day, and fees. Allowable Values: Existing |
config.billing_cycle_day
integer
|
Day of month the billing cycle starts. Allowable Values: 1 |
config.payment_due_day
integer
|
Day of month the payment for the previous billing cycle is due. Allowable Values: 31 |
config.fees
array of strings
|
One or more fee types. Allowable Values:
|
config.periodic_fees
array of objects
|
Contains one or more periodic fees. Allowable Values: One or more |
config.periodic_fees[].frequency
string
|
How frequently the fee is charged. Allowable Values:
|
config.periodic_fees[].number_of_days_post_activation
integer
|
The number of days after an account is activated that the initial fee is charged.
For example, if the value in this field is Allowable Values: 1–1000 |
Retrieve credit product lineage
Copy section link
Action: GET
Endpoint: /credit/products/{token}/lineage
Retrieve the lineage of a credit product, which is an array of related credit products whose lineage can be traced back to the same original credit product.
This endpoint supports sorting and pagination.
URL path parameters
Copy section link
| Fields | Description |
|---|---|
token
string
|
The unique identifier of the credit product whose lineage you want to retrieve. Send a Allowable Values: Existing credit product token |
URL query parameters
Copy section link
| Fields | Description |
|---|---|
status
array of strings
|
An array of statuses by which to filter credit products. Allowable Values:
|
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
|
Contains one or more credit product objects. Allowable Values: One or more credit product objects |
data[].token
string
|
Unique identifier of the credit product. Allowable Values: 36 char max |
data[].parent_product_token
string
|
Unique identifier of the parent credit product. Allowable Values: Existing credit product token |
data[].card_product_tokens
array of strings
|
One or more associated card product tokens. Allowable Values: Existing card product tokens |
data[].name
string
|
Name of the credit product. Allowable Values: 255 char max |
data[].description
string
|
Description of the credit product. Allowable Values: 255 char max |
data[].status
string
|
Status of the credit product.
Allowable Values:
|
data[].created_time
datetime
|
Date and time when the credit product 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 was last updated on Marqeta’s credit platform, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
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. Allowable Values:
|
data[].min_payment_percentage
decimal
|
Minimum payment, expressed as a percentage of the total statement balance, due on the payment due day. Allowable Values: 0.0001–100 |
data[].min_payment_flat_amount
decimal
|
Minimum payment, expressed as a flat amount, due on the payment due day. Allowable Values: 0.01 min |
data[].min_payment_calculation
object
|
Contains information used to calculate the minimum payment amount. Allowable Values: Existing |
data[].min_payment_calculation.include_past_due_amount
boolean
|
Whether to include the past due amount when calculating the minimum payment. Allowable Values:
|
data[].min_payment_calculation.min_payment_percentage
object
|
Contains information used to calculate the minimum payment percentage. Allowable Values: Existing |
data[].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[].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[].min_payment_calculation.min_payment_flat_amount
decimal
|
Minimum payment, expressed as a flat amount, due on the payment due day. Allowable Values: 0.01 min |
data[].payment_allocation_order
array of strings
|
Ordered list of balance types to which payments are allocated, from first to last. Allowable Values:
|
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[].config
object
|
Contains information on configurations for billing cycle day, payment due day, and fees. Allowable Values: Existing |
data[].config.billing_cycle_day
integer
|
Day of month the billing cycle starts. Allowable Values: 1 |
data[].config.payment_due_day
integer
|
Day of month the payment for the previous billing cycle is due. Allowable Values: 31 |
data[].config.fees
array of strings
|
One or more fee types. Allowable Values:
|
data[].config.periodic_fees
array of objects
|
Contains one or more periodic fees. Allowable Values: One or more |
data[].config.periodic_fees[].frequency
string
|
How frequently the fee is charged. Allowable Values:
|
data[].config.periodic_fees[].number_of_days_post_activation
integer
|
The number of days after an account is activated that the initial fee is charged.
For example, if the value in this field is Allowable Values: 1–1000 |