Credit Accounts
Use the credit accounts endpoints to create and manage accounts on Marqeta’s credit platform. A credit account centers around a single line of credit that can be accessed by one or more cards. An account’s attributes, such as the credit limit, APR, and fees, are inherited from the policies on its associated bundle.
For more on accounts, see About Credit Accounts.
Create account
Copy section link
Action: POST
Endpoint: /credit/accounts
Create a new credit account.
Request body
Copy section link
| Fields | Description |
|---|---|
token
string
|
Unique identifier of the credit account. Allowable Values: 36 char max |
name
string
|
Name of the credit account. Allowable Values: 255 char max |
description
string
|
Description for the credit account. Allowable Values: 255 char max |
bundle_token
string
|
Unique identifier of the associated bundle. You must pass either Allowable Values: Existing bundle token |
credit_product_token
string
|
Unique identifier of the associated credit product. This field is required if passing You must pass either both Allowable Values: Existing credit product token |
user_token
string
|
Unique identifier of the primary account holder. Allowable Values: Existing user token |
application_token
string
|
Unique identifier of the associated credit account application. Allowable Values: 36 char max |
external_offer_id
string
|
Unique identifier you provide of the associated external credit offer. This field is required if passing You must pass either both Allowable Values: Your credit offer ID. |
credit_limit
decimal
|
Maximum balance the credit account can carry. Allowable Values: 0–1000000 |
config
object
|
Contains information relevant for configuring an account’s billing cycle day, payment due day, fees, and more. 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.e_disclosure_active
boolean
|
A value of Allowable Values:
Default value: |
config.card_level
string
|
The level of the credit card. Allowable Values:
|
config.fees
array of objects
|
Contains one or more fees associated with the credit account. Allowable Values: One or more |
config.fees[].type
string
|
Type of fee. Allowable Values:
|
config.fees[].schedule
array of objects
|
Contains one or more fee schedules. Allowable Values: One or more |
config.fees[].schedule[].method
string
|
Method used to calculate the fee value. Allowable Values:
|
config.fees[].schedule[].value
decimal
|
Amount of the fee. Allowable Values: 0–9999.9999 |
config.fees[].schedule[].effective_date
datetime
|
Date and time when the fee goes into effect, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
config.rewards
array of objects
|
Contains one or more rewards associated with the credit account. Allowable Values: One or more |
config.rewards[].type
string
|
Type of reward. Allowable Values:
|
config.rewards[].method
string
|
Method, either a flat amount or a percentage. NOTE:
Only Allowable Values:
|
config.rewards[].value
decimal
|
Value of the reward, either a flat reward amount or percentage value. Allowable Values: 0–100 |
config.payment_holds
object
|
Contains configurations for a payment hold. Allowable Values: Existing |
config.payment_holds.ach_hold_days
integer
|
Number of days to hold an ACH payment. Allowable Values: 0–7 |
config.payment_holds.check_hold_days
integer
|
Number of days to hold a check payment. Allowable Values: 0–7 |
usages
array of objects
|
Contains one or more You can pass only one Allowable Values: One or more |
usages[].type
string
|
Type of balance.
Allowable Values:
|
usages[].aprs
array of objects
|
Contains one or more annual percentage rates (APRs) associated with the type of balance on the credit account. Allowable Values: One or more |
usages[].aprs[].type
string
|
Type of APR.
Allowable Values:
|
usages[].aprs[].schedule
array of objects
|
Contains one or more Allowable Values: One or more |
usages[].aprs[].schedule[].type
string
|
Indicates whether the APR value is fixed or variable. Allowable Values:
|
usages[].aprs[].schedule[].value
decimal
|
Percentage value of the APR. If the APR type is When backdating an APR, this value cannot be greater than the value of the effective APR on the backdated date. Allowable Values: 0–100 |
usages[].aprs[].schedule[].margin
decimal
|
The number of percentage points added to the prime rate, used to calculate a variable value. Used for variable values only. Allowable Values: Format: 0.00 |
usages[].fees
array of objects
|
Contains one or more fees associated with the usage type. Allowable Values: One or more |
usages[].fees[].type
string
|
Type of fee. NOTE:
Only Allowable Values:
|
usages[].fees[].method
string
|
Method, either a flat amount or a percentage. NOTE:
Only Allowable Values:
|
usages[].fees[].value
decimal
|
Value of the fee, either a flat fee amount or percentage value. Allowable Values: 0–9999.9999 |
Response body
Copy section link
| Fields | Description |
|---|---|
token
string
|
Unique identifier of the credit account. Allowable Values: 36 char max |
name
string
|
Name of the credit account. Allowable Values: 255 char max |
description
string
|
Description for the credit account. Allowable Values: 255 char max |
currency_code
string
|
A valid three-digit ISO 4217 currency code Allowable Values:
|
status
string
|
Status of the credit account. Allowable Values:
|
activation_time
datetime
|
Date and time when the credit account was activated on Marqeta’s credit platform, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
created_time
datetime
|
Date and time when the credit account 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 account was last updated on Marqeta’s credit platform, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
type
string
|
Type of credit account. Allowable Values:
|
bundle_token
string
|
Unique identifier of the associated bundle product. Allowable Values: Existing token |
credit_product_token
string
|
Unique identifier of the associated credit product. Allowable Values: Existing credit product token |
user_token
string
|
Unique identifier of the primary account holder. Allowable Values: Existing user token |
external_offer_id
string
|
Unique identifier you provide of the associated external credit offer. Allowable Values: Your external offer ID. |
credit_limit
decimal
|
Maximum balance the credit account can carry. Allowable Values: 0–1000000 |
current_balance
decimal
|
Current purchase balance on the credit account. Allowable Values: Format: 0.00 |
available_credit
decimal
|
Amount of credit available for use on the credit account. Allowable Values: Format: 0.00 |
remaining_statement_balance
decimal
|
Amount remaining on the latest statement’s balance, after it’s adjusted for payments, returned payments, and applicable credits that occurred after the latest statement’s closing date. Allowable Values: Format: 0.00 |
remaining_min_payment_due
decimal
|
Amount remaining on the latest statement’s minimum payment, after it’s adjusted for payments, returned payments, and applicable credits that occurred after the latest statement’s closing date. Allowable Values: Format: 0.00 |
latest_statement_cycle_type
string
|
Type of cycle.
Allowable Values:
|
config
object
|
Contains information returned when configuring an account’s billing cycle day, payment due day, fees, and more. 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.e_disclosure_active
boolean
|
A value of Allowable Values:
Default value: |
config.card_level
string
|
The level of the credit card. Allowable Values:
|
config.fees
array of objects
|
Contains one or more fees associated with the credit account. Allowable Values: One or more |
config.fees[].type
string
|
Type of fee. Allowable Values:
|
config.fees[].active
boolean
|
Whether the fee is active. Allowable Values:
|
config.fees[].created_date
datetime
|
Date and time when the fee was created on Marqeta’s credit platform, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
config.fees[].updated_date
datetime
|
Date and time when the fee was last updated on Marqeta’s credit platform, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
config.fees[].schedule
array of objects
|
Contains one or more fee schedules. Allowable Values: One or more |
config.fees[].schedule[].method
string
|
Method used to calculate the fee value. Allowable Values:
|
config.fees[].schedule[].value
decimal
|
Amount of the fee. Allowable Values: 0–9999.9999 |
config.fees[].schedule[].effective_date
datetime
|
Date and time when the fee goes into effect, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
config.rewards
array of objects
|
Contains one or more rewards associated with the credit account. Allowable Values: One or more |
config.rewards[].type
string
|
Type of reward. Allowable Values:
|
config.rewards[].method
string
|
Method, either a flat amount or a percentage. NOTE:
Only Allowable Values:
|
config.rewards[].value
decimal
|
Value of the reward, either a flat reward amount or percentage value. Allowable Values: 0–100 |
config.payment_holds
object
|
Contains configurations for a payment hold. Allowable Values: Existing |
config.payment_holds.ach_hold_days
integer
|
Number of days to hold an ACH payment. Allowable Values: 0–7 |
config.payment_holds.check_hold_days
integer
|
Number of days to hold a check payment. Allowable Values: 0–7 |
config.min_payment
object
|
Contains configurations for a minimum payment override on a credit account, which overrides the minimum payment configurations on the associated credit product. Allowable Values: Existing |
config.min_payment.override_start_time
datetime
|
Date and time when the minimum payment override starts, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
config.min_payment.override_end_time
datetime
|
Date and time when the minimum payment override ends, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
config.min_payment.min_payment_flat_amount
decimal
|
Flat amount of the minimum payment override. Allowable Values: 0 min |
config.min_payment.min_payment_percentage
decimal
|
Percentage of the total statement balance used to calculate the minimum payment override amount. Allowable Values: 0 min |
config.min_payment.active
boolean
|
Whether the minimum payment override is currently active. Allowable Values:
|
usages
array of objects
|
Contains one or more Allowable Values: One or more |
usages[].type
string
|
Type of balance.
Allowable Values:
|
usages[].aprs
array of objects
|
Contains one or more APRs associated with the type of balance on the credit account Allowable Values: One or more |
usages[].aprs[].type
string
|
Type of APR.
Allowable Values:
|
usages[].aprs[].active
boolean
|
Whether the APR is active. Allowable Values:
|
usages[].aprs[].created_date
datetime
|
Date and time when the APR was created on Marqeta’s credit platform, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
usages[].aprs[].updated_date
datetime
|
Date and time when the APR was last updated on Marqeta’s credit platform, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
usages[].aprs[].schedule
array of objects
|
Contains one or more Allowable Values: One or more |
usages[].aprs[].schedule[].type
string
|
Indicates whether the APR value is fixed or variable. Allowable Values:
|
usages[].aprs[].schedule[].value
decimal
|
Percentage value of the APR. If the APR type is When backdating an APR, this value cannot be greater than the value of the effective APR on the backdated date. Allowable Values: 0–100 |
usages[].aprs[].schedule[].margin
decimal
|
The number of percentage points added to the prime rate, used to calculate a variable value. Used for variable values only. Allowable Values: Format: 0.00 |
usages[].aprs[].schedule[].effective_date
datetime
|
Date and time when the APR goes into effect, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
usages[].aprs[].schedule[].apply_next_cycle
boolean
|
Whether the APR is ignored for the current billing cycle and applied on the next. Allowable Values:
Default value: |
usages[].fees
array of objects
|
Contains one or more fees associated with the usage type. Allowable Values: One or more |
usages[].fees[].type
string
|
Type of fee. NOTE:
Only Allowable Values:
|
usages[].fees[].method
string
|
Method, either a flat amount or a percentage. NOTE:
Only Allowable Values:
|
usages[].fees[].value
decimal
|
Value of the fee, either a flat fee amount or percentage value. Allowable Values: 0–9999.9999 |
List accounts
Copy section link
Action: GET
Endpoint: /credit/accounts
Retrieve an array of credit accounts.
This endpoint supports sorting and pagination.
URL query parameters
Copy section link
| Fields | Description |
|---|---|
card_token
string
|
The unique identifier of the credit card associated with the account. Allowable Values: Existing card token |
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 first 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 accounts. Allowable Values: One or more credit accounts |
data[].token
string
|
Unique identifier of the credit account. Allowable Values: 36 char max |
data[].name
string
|
Name of the credit account. Allowable Values: 255 char max |
data[].description
string
|
Description for the credit account. Allowable Values: 255 char max |
data[].currency_code
string
|
A valid three-digit ISO 4217 currency code Allowable Values:
|
data[].status
string
|
Status of the credit account. Allowable Values:
|
data[].activation_time
datetime
|
Date and time when the credit account was activated on Marqeta’s credit platform, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
data[].created_time
datetime
|
Date and time when the credit account 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 account was last updated on Marqeta’s credit platform, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
data[].type
string
|
Type of credit account. Allowable Values:
|
data[].bundle_token
string
|
Unique identifier of the associated bundle product. Allowable Values: Existing token |
data[].credit_product_token
string
|
Unique identifier of the associated credit product. Allowable Values: Existing credit product token |
data[].user_token
string
|
Unique identifier of the primary account holder. Allowable Values: Existing user token |
data[].external_offer_id
string
|
Unique identifier you provide of the associated external credit offer. Allowable Values: Your external offer ID. |
data[].credit_limit
decimal
|
Maximum balance the credit account can carry. Allowable Values: 0–1000000 |
data[].current_balance
decimal
|
Current purchase balance on the credit account. Allowable Values: Format: 0.00 |
data[].available_credit
decimal
|
Amount of credit available for use on the credit account. Allowable Values: Format: 0.00 |
data[].remaining_statement_balance
decimal
|
Amount remaining on the latest statement’s balance, after it’s adjusted for payments, returned payments, and applicable credits that occurred after the latest statement’s closing date. Allowable Values: Format: 0.00 |
data[].remaining_min_payment_due
decimal
|
Amount remaining on the latest statement’s minimum payment, after it’s adjusted for payments, returned payments, and applicable credits that occurred after the latest statement’s closing date. Allowable Values: Format: 0.00 |
data[].latest_statement_cycle_type
string
|
Type of cycle.
Allowable Values:
|
data[].config
object
|
Contains information returned when configuring an account’s billing cycle day, payment due day, fees, and more. 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.e_disclosure_active
boolean
|
A value of Allowable Values:
Default value: |
data[].config.card_level
string
|
The level of the credit card. Allowable Values:
|
data[].config.fees
array of objects
|
Contains one or more fees associated with the credit account. Allowable Values: One or more |
data[].config.fees[].type
string
|
Type of fee. Allowable Values:
|
data[].config.fees[].active
boolean
|
Whether the fee is active. Allowable Values:
|
data[].config.fees[].created_date
datetime
|
Date and time when the fee was created on Marqeta’s credit platform, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
data[].config.fees[].updated_date
datetime
|
Date and time when the fee was last updated on Marqeta’s credit platform, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
data[].config.fees[].schedule
array of objects
|
Contains one or more fee schedules. Allowable Values: One or more |
data[].config.fees[].schedule[].method
string
|
Method used to calculate the fee value. Allowable Values:
|
data[].config.fees[].schedule[].value
decimal
|
Amount of the fee. Allowable Values: 0–9999.9999 |
data[].config.fees[].schedule[].effective_date
datetime
|
Date and time when the fee goes into effect, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
data[].config.rewards
array of objects
|
Contains one or more rewards associated with the credit account. Allowable Values: One or more |
data[].config.rewards[].type
string
|
Type of reward. Allowable Values:
|
data[].config.rewards[].method
string
|
Method, either a flat amount or a percentage. NOTE:
Only Allowable Values:
|
data[].config.rewards[].value
decimal
|
Value of the reward, either a flat reward amount or percentage value. Allowable Values: 0–100 |
data[].config.payment_holds
object
|
Contains configurations for a payment hold. Allowable Values: Existing |
data[].config.payment_holds.ach_hold_days
integer
|
Number of days to hold an ACH payment. Allowable Values: 0–7 |
data[].config.payment_holds.check_hold_days
integer
|
Number of days to hold a check payment. Allowable Values: 0–7 |
data[].config.min_payment
object
|
Contains configurations for a minimum payment override on a credit account, which overrides the minimum payment configurations on the associated credit product. Allowable Values: Existing |
data[].config.min_payment.override_start_time
datetime
|
Date and time when the minimum payment override starts, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
data[].config.min_payment.override_end_time
datetime
|
Date and time when the minimum payment override ends, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
data[].config.min_payment.min_payment_flat_amount
decimal
|
Flat amount of the minimum payment override. Allowable Values: 0 min |
data[].config.min_payment.min_payment_percentage
decimal
|
Percentage of the total statement balance used to calculate the minimum payment override amount. Allowable Values: 0 min |
data[].config.min_payment.active
boolean
|
Whether the minimum payment override is currently active. Allowable Values:
|
data[].usages
array of objects
|
Contains one or more Allowable Values: One or more |
data[].usages[].type
string
|
Type of balance.
Allowable Values:
|
data[].usages[].aprs
array of objects
|
Contains one or more APRs associated with the type of balance on the credit account Allowable Values: One or more |
data[].usages[].aprs[].type
string
|
Type of APR.
Allowable Values:
|
data[].usages[].aprs[].active
boolean
|
Whether the APR is active. Allowable Values:
|
data[].usages[].aprs[].created_date
datetime
|
Date and time when the APR was created on Marqeta’s credit platform, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
data[].usages[].aprs[].updated_date
datetime
|
Date and time when the APR was last updated on Marqeta’s credit platform, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
data[].usages[].aprs[].schedule
array of objects
|
Contains one or more Allowable Values: One or more |
data[].usages[].aprs[].schedule[].type
string
|
Indicates whether the APR value is fixed or variable. Allowable Values:
|
data[].usages[].aprs[].schedule[].value
decimal
|
Percentage value of the APR. If the APR type is When backdating an APR, this value cannot be greater than the value of the effective APR on the backdated date. Allowable Values: 0–100 |
data[].usages[].aprs[].schedule[].margin
decimal
|
The number of percentage points added to the prime rate, used to calculate a variable value. Used for variable values only. Allowable Values: Format: 0.00 |
data[].usages[].aprs[].schedule[].effective_date
datetime
|
Date and time when the APR goes into effect, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
data[].usages[].aprs[].schedule[].apply_next_cycle
boolean
|
Whether the APR is ignored for the current billing cycle and applied on the next. Allowable Values:
Default value: |
data[].usages[].fees
array of objects
|
Contains one or more fees associated with the usage type. Allowable Values: One or more |
data[].usages[].fees[].type
string
|
Type of fee. NOTE:
Only Allowable Values:
|
data[].usages[].fees[].method
string
|
Method, either a flat amount or a percentage. NOTE:
Only Allowable Values:
|
data[].usages[].fees[].value
decimal
|
Value of the fee, either a flat fee amount or percentage value. Allowable Values: 0–9999.9999 |
Retrieve account
Copy section link
Action: GET
Endpoint: /credit/accounts/{account_token}
Retrieve a credit account.
URL path parameters
Copy section link
| Fields | Description |
|---|---|
account_token
string
|
The unique identifier of the credit account to retrieve. Send a Allowable Values: Existing account token |
Response body
Copy section link
| Fields | Description |
|---|---|
token
string
|
Unique identifier of the credit account. Allowable Values: 36 char max |
name
string
|
Name of the credit account. Allowable Values: 255 char max |
description
string
|
Description for the credit account. Allowable Values: 255 char max |
currency_code
string
|
A valid three-digit ISO 4217 currency code Allowable Values:
|
status
string
|
Status of the credit account. Allowable Values:
|
activation_time
datetime
|
Date and time when the credit account was activated on Marqeta’s credit platform, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
created_time
datetime
|
Date and time when the credit account 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 account was last updated on Marqeta’s credit platform, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
type
string
|
Type of credit account. Allowable Values:
|
bundle_token
string
|
Unique identifier of the associated bundle product. Allowable Values: Existing token |
credit_product_token
string
|
Unique identifier of the associated credit product. Allowable Values: Existing credit product token |
user_token
string
|
Unique identifier of the primary account holder. Allowable Values: Existing user token |
external_offer_id
string
|
Unique identifier you provide of the associated external credit offer. Allowable Values: Your external offer ID. |
credit_limit
decimal
|
Maximum balance the credit account can carry. Allowable Values: 0–1000000 |
current_balance
decimal
|
Current purchase balance on the credit account. Allowable Values: Format: 0.00 |
available_credit
decimal
|
Amount of credit available for use on the credit account. Allowable Values: Format: 0.00 |
remaining_statement_balance
decimal
|
Amount remaining on the latest statement’s balance, after it’s adjusted for payments, returned payments, and applicable credits that occurred after the latest statement’s closing date. Allowable Values: Format: 0.00 |
remaining_min_payment_due
decimal
|
Amount remaining on the latest statement’s minimum payment, after it’s adjusted for payments, returned payments, and applicable credits that occurred after the latest statement’s closing date. Allowable Values: Format: 0.00 |
latest_statement_cycle_type
string
|
Type of cycle.
Allowable Values:
|
config
object
|
Contains information returned when configuring an account’s billing cycle day, payment due day, fees, and more. 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.e_disclosure_active
boolean
|
A value of Allowable Values:
Default value: |
config.card_level
string
|
The level of the credit card. Allowable Values:
|
config.fees
array of objects
|
Contains one or more fees associated with the credit account. Allowable Values: One or more |
config.fees[].type
string
|
Type of fee. Allowable Values:
|
config.fees[].active
boolean
|
Whether the fee is active. Allowable Values:
|
config.fees[].created_date
datetime
|
Date and time when the fee was created on Marqeta’s credit platform, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
config.fees[].updated_date
datetime
|
Date and time when the fee was last updated on Marqeta’s credit platform, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
config.fees[].schedule
array of objects
|
Contains one or more fee schedules. Allowable Values: One or more |
config.fees[].schedule[].method
string
|
Method used to calculate the fee value. Allowable Values:
|
config.fees[].schedule[].value
decimal
|
Amount of the fee. Allowable Values: 0–9999.9999 |
config.fees[].schedule[].effective_date
datetime
|
Date and time when the fee goes into effect, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
config.rewards
array of objects
|
Contains one or more rewards associated with the credit account. Allowable Values: One or more |
config.rewards[].type
string
|
Type of reward. Allowable Values:
|
config.rewards[].method
string
|
Method, either a flat amount or a percentage. NOTE:
Only Allowable Values:
|
config.rewards[].value
decimal
|
Value of the reward, either a flat reward amount or percentage value. Allowable Values: 0–100 |
config.payment_holds
object
|
Contains configurations for a payment hold. Allowable Values: Existing |
config.payment_holds.ach_hold_days
integer
|
Number of days to hold an ACH payment. Allowable Values: 0–7 |
config.payment_holds.check_hold_days
integer
|
Number of days to hold a check payment. Allowable Values: 0–7 |
config.min_payment
object
|
Contains configurations for a minimum payment override on a credit account, which overrides the minimum payment configurations on the associated credit product. Allowable Values: Existing |
config.min_payment.override_start_time
datetime
|
Date and time when the minimum payment override starts, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
config.min_payment.override_end_time
datetime
|
Date and time when the minimum payment override ends, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
config.min_payment.min_payment_flat_amount
decimal
|
Flat amount of the minimum payment override. Allowable Values: 0 min |
config.min_payment.min_payment_percentage
decimal
|
Percentage of the total statement balance used to calculate the minimum payment override amount. Allowable Values: 0 min |
config.min_payment.active
boolean
|
Whether the minimum payment override is currently active. Allowable Values:
|
usages
array of objects
|
Contains one or more Allowable Values: One or more |
usages[].type
string
|
Type of balance.
Allowable Values:
|
usages[].aprs
array of objects
|
Contains one or more APRs associated with the type of balance on the credit account Allowable Values: One or more |
usages[].aprs[].type
string
|
Type of APR.
Allowable Values:
|
usages[].aprs[].active
boolean
|
Whether the APR is active. Allowable Values:
|
usages[].aprs[].created_date
datetime
|
Date and time when the APR was created on Marqeta’s credit platform, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
usages[].aprs[].updated_date
datetime
|
Date and time when the APR was last updated on Marqeta’s credit platform, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
usages[].aprs[].schedule
array of objects
|
Contains one or more Allowable Values: One or more |
usages[].aprs[].schedule[].type
string
|
Indicates whether the APR value is fixed or variable. Allowable Values:
|
usages[].aprs[].schedule[].value
decimal
|
Percentage value of the APR. If the APR type is When backdating an APR, this value cannot be greater than the value of the effective APR on the backdated date. Allowable Values: 0–100 |
usages[].aprs[].schedule[].margin
decimal
|
The number of percentage points added to the prime rate, used to calculate a variable value. Used for variable values only. Allowable Values: Format: 0.00 |
usages[].aprs[].schedule[].effective_date
datetime
|
Date and time when the APR goes into effect, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
usages[].aprs[].schedule[].apply_next_cycle
boolean
|
Whether the APR is ignored for the current billing cycle and applied on the next. Allowable Values:
Default value: |
usages[].fees
array of objects
|
Contains one or more fees associated with the usage type. Allowable Values: One or more |
usages[].fees[].type
string
|
Type of fee. NOTE:
Only Allowable Values:
|
usages[].fees[].method
string
|
Method, either a flat amount or a percentage. NOTE:
Only Allowable Values:
|
usages[].fees[].value
decimal
|
Value of the fee, either a flat fee amount or percentage value. Allowable Values: 0–9999.9999 |
Update account
Copy section link
Action: PUT
Endpoint: /credit/accounts/{account_token}
Update a credit account.
URL path parameters
Copy section link
| Fields | Description |
|---|---|
account_token
string
|
The unique identifier of the credit account to update. Send a Allowable Values: Existing account token |
Request body
Copy section link
| Fields | Description |
|---|---|
config
object
|
Contains information relevant for updating configurations for electronic disclosures, fees, payment holds, and minimum payment. Allowable Values: Existing |
config.e_disclosure_active
boolean
|
A value of Allowable Values:
Default value: |
config.fees
array of objects
|
Contains one or more fees associated with the credit account. Allowable Values: One or more |
config.fees[].type
string
|
Type of fee. Allowable Values:
|
config.fees[].schedule
array of objects
|
Contains one or more fee schedules. Allowable Values: One or more |
config.fees[].schedule[].method
string
|
Method used to calculate the fee value. Allowable Values:
|
config.fees[].schedule[].value
decimal
|
Amount of the fee. Allowable Values: 0–9999.9999 |
config.fees[].schedule[].effective_date
datetime
|
Date and time when the fee goes into effect, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
config.payment_holds
object
|
Contains configurations for a payment hold. Allowable Values: Existing |
config.payment_holds.ach_hold_days
integer
|
Number of days to hold an ACH payment. Allowable Values: 0–7 |
config.payment_holds.check_hold_days
integer
|
Number of days to hold a check payment. Allowable Values: 0–7 |
config.min_payment
object
|
Contains configurations for a minimum payment override on a credit account, which overrides the minimum payment configurations on the associated credit product. Allowable Values: Existing |
config.min_payment.override_start_time
datetime
|
Date and time when the minimum payment override starts, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
config.min_payment.override_end_time
datetime
|
Date and time when the minimum payment override ends, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
config.min_payment.min_payment_flat_amount
decimal
|
Flat amount of the minimum payment override. Allowable Values: 0 min |
config.min_payment.min_payment_percentage
decimal
|
Percentage of the total statement balance used to calculate the minimum payment override amount. Allowable Values: 0 min |
config.min_payment.active
boolean
|
Whether the minimum payment override is currently active. Allowable Values:
|
usages
array of objects
|
Contains one or more You can pass only one Allowable Values: One or more |
usages[].type
string
|
Type of balance.
Allowable Values:
|
usages[].aprs
array of objects
|
Contains one or more annual percentage rates (APRs) associated with the credit account. Allowable Values: One or more |
usages[].aprs[].type
string
|
Type of APR.
Allowable Values:
|
usages[].aprs[].schedule
array of objects
|
Contains one or more Allowable Values: One or more |
usages[].aprs[].schedule[].type
string
|
Indicates whether the APR value is fixed or variable. Allowable Values:
|
usages[].aprs[].schedule[].margin
decimal
|
The number of percentage points added to the prime rate, used to calculate a variable value. Used for variable values only. Allowable Values: Format: 0.00 |
usages[].aprs[].schedule[].value
decimal
|
Percentage value of the APR. If the APR type is When backdating an APR, this value cannot be greater than the value of the effective APR on the backdated date. Allowable Values: 0–100 |
usages[].aprs[].schedule[].effective_date
datetime
|
Date and time when the APR goes into effect, in UTC. If you do not include a date-time value, the system uses the date and time when the API request was received. NOTE:
When passing multiple Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
usages[].aprs[].schedule[].apply_next_cycle
boolean
|
Whether the APR can be ignored for the current billing cycle and applied on the next. Allowable Values:
Default value: |
credit_limit
object
|
Contains information on the credit limit. Allowable Values: Existing |
credit_limit.value
decimal
|
Maximum balance the credit account can carry. Allowable Values: 0–999999999999.99 |
latest_statement_cycle_type
string
|
Type of cycle.
Allowable Values:
|
Response body
Copy section link
| Fields | Description |
|---|---|
token
string
|
Unique identifier of the credit account. Allowable Values: 36 char max |
name
string
|
Name of the credit account. Allowable Values: 255 char max |
description
string
|
Description for the credit account. Allowable Values: 255 char max |
currency_code
string
|
A valid three-digit ISO 4217 currency code Allowable Values:
|
status
string
|
Status of the credit account. Allowable Values:
|
activation_time
datetime
|
Date and time when the credit account was activated on Marqeta’s credit platform, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
created_time
datetime
|
Date and time when the credit account 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 account was last updated on Marqeta’s credit platform, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
type
string
|
Type of credit account. Allowable Values:
|
bundle_token
string
|
Unique identifier of the associated bundle product. Allowable Values: Existing token |
credit_product_token
string
|
Unique identifier of the associated credit product. Allowable Values: Existing credit product token |
user_token
string
|
Unique identifier of the primary account holder. Allowable Values: Existing user token |
external_offer_id
string
|
Unique identifier you provide of the associated external credit offer. Allowable Values: Your external offer ID. |
credit_limit
decimal
|
Maximum balance the credit account can carry. Allowable Values: 0–1000000 |
current_balance
decimal
|
Current purchase balance on the credit account. Allowable Values: Format: 0.00 |
available_credit
decimal
|
Amount of credit available for use on the credit account. Allowable Values: Format: 0.00 |
remaining_statement_balance
decimal
|
Amount remaining on the latest statement’s balance, after it’s adjusted for payments, returned payments, and applicable credits that occurred after the latest statement’s closing date. Allowable Values: Format: 0.00 |
remaining_min_payment_due
decimal
|
Amount remaining on the latest statement’s minimum payment, after it’s adjusted for payments, returned payments, and applicable credits that occurred after the latest statement’s closing date. Allowable Values: Format: 0.00 |
latest_statement_cycle_type
string
|
Type of cycle.
Allowable Values:
|
config
object
|
Contains information returned when configuring an account’s billing cycle day, payment due day, fees, and more. 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.e_disclosure_active
boolean
|
A value of Allowable Values:
Default value: |
config.card_level
string
|
The level of the credit card. Allowable Values:
|
config.fees
array of objects
|
Contains one or more fees associated with the credit account. Allowable Values: One or more |
config.fees[].type
string
|
Type of fee. Allowable Values:
|
config.fees[].active
boolean
|
Whether the fee is active. Allowable Values:
|
config.fees[].created_date
datetime
|
Date and time when the fee was created on Marqeta’s credit platform, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
config.fees[].updated_date
datetime
|
Date and time when the fee was last updated on Marqeta’s credit platform, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
config.fees[].schedule
array of objects
|
Contains one or more fee schedules. Allowable Values: One or more |
config.fees[].schedule[].method
string
|
Method used to calculate the fee value. Allowable Values:
|
config.fees[].schedule[].value
decimal
|
Amount of the fee. Allowable Values: 0–9999.9999 |
config.fees[].schedule[].effective_date
datetime
|
Date and time when the fee goes into effect, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
config.rewards
array of objects
|
Contains one or more rewards associated with the credit account. Allowable Values: One or more |
config.rewards[].type
string
|
Type of reward. Allowable Values:
|
config.rewards[].method
string
|
Method, either a flat amount or a percentage. NOTE:
Only Allowable Values:
|
config.rewards[].value
decimal
|
Value of the reward, either a flat reward amount or percentage value. Allowable Values: 0–100 |
config.payment_holds
object
|
Contains configurations for a payment hold. Allowable Values: Existing |
config.payment_holds.ach_hold_days
integer
|
Number of days to hold an ACH payment. Allowable Values: 0–7 |
config.payment_holds.check_hold_days
integer
|
Number of days to hold a check payment. Allowable Values: 0–7 |
config.min_payment
object
|
Contains configurations for a minimum payment override on a credit account, which overrides the minimum payment configurations on the associated credit product. Allowable Values: Existing |
config.min_payment.override_start_time
datetime
|
Date and time when the minimum payment override starts, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
config.min_payment.override_end_time
datetime
|
Date and time when the minimum payment override ends, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
config.min_payment.min_payment_flat_amount
decimal
|
Flat amount of the minimum payment override. Allowable Values: 0 min |
config.min_payment.min_payment_percentage
decimal
|
Percentage of the total statement balance used to calculate the minimum payment override amount. Allowable Values: 0 min |
config.min_payment.active
boolean
|
Whether the minimum payment override is currently active. Allowable Values:
|
usages
array of objects
|
Contains one or more Allowable Values: One or more |
usages[].type
string
|
Type of balance.
Allowable Values:
|
usages[].aprs
array of objects
|
Contains one or more APRs associated with the type of balance on the credit account Allowable Values: One or more |
usages[].aprs[].type
string
|
Type of APR.
Allowable Values:
|
usages[].aprs[].active
boolean
|
Whether the APR is active. Allowable Values:
|
usages[].aprs[].created_date
datetime
|
Date and time when the APR was created on Marqeta’s credit platform, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
usages[].aprs[].updated_date
datetime
|
Date and time when the APR was last updated on Marqeta’s credit platform, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
usages[].aprs[].schedule
array of objects
|
Contains one or more Allowable Values: One or more |
usages[].aprs[].schedule[].type
string
|
Indicates whether the APR value is fixed or variable. Allowable Values:
|
usages[].aprs[].schedule[].value
decimal
|
Percentage value of the APR. If the APR type is When backdating an APR, this value cannot be greater than the value of the effective APR on the backdated date. Allowable Values: 0–100 |
usages[].aprs[].schedule[].margin
decimal
|
The number of percentage points added to the prime rate, used to calculate a variable value. Used for variable values only. Allowable Values: Format: 0.00 |
usages[].aprs[].schedule[].effective_date
datetime
|
Date and time when the APR goes into effect, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
usages[].aprs[].schedule[].apply_next_cycle
boolean
|
Whether the APR is ignored for the current billing cycle and applied on the next. Allowable Values:
Default value: |
usages[].fees
array of objects
|
Contains one or more fees associated with the usage type. Allowable Values: One or more |
usages[].fees[].type
string
|
Type of fee. NOTE:
Only Allowable Values:
|
usages[].fees[].method
string
|
Method, either a flat amount or a percentage. NOTE:
Only Allowable Values:
|
usages[].fees[].value
decimal
|
Value of the fee, either a flat fee amount or percentage value. Allowable Values: 0–9999.9999 |