/
50 minute read
September 1, 2022

Credit Accounts

Use the /credit/accounts endpoint 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 derived from the policies on its associated bundle.

For more on accounts, see About Credit Accounts.

Create account

Action: POST
Endpoint: /credit/accounts

Create a new credit account.

Request body

Fields Description

token

string
Optional

Unique identifier of the credit account.

Allowable Values:

36 char max

name

string
Optional

Name of the credit account.

Allowable Values:

description

string
Optional

Description for the credit account.

Allowable Values:

Any string

bundle_token

string
Optional

Unique identifier of the associated bundle.

You must pass either bundle_token or both credit_product_token and external_offer_id.

Allowable Values:

Existing bundle token

credit_product_token

string
Optional

Unique identifier of the associated credit product.

This field is required if passing external_offer_id.

You must pass either both credit_product_token and external_offer_id or bundle_token.

Allowable Values:

Existing credit product token

user_token

string
Required

Unique identifier of the primary account holder.

Allowable Values:

Existing user token

application_token

string
Optional

Unique identifier of the associated credit account application.

Allowable Values:

36 char max

external_offer_id

string
Optional

Unique identifier you provide of the associated external credit offer.

This field is required if passing credit_product_token.

You must pass either both external_offer_id and credit_product_token or bundle_token.

Allowable Values:

Your credit offer ID.

credit_limit

decimal
Required

Maximum balance the credit account can carry.

Allowable Values:

0–1000000

config

object
Optional

Contains information relevant for configuring an account’s billing cycle day, payment due day, fees, and more.

Allowable Values:

config.billing_cycle_day

integer
Optional

Day of month the billing cycle starts.

Allowable Values:

1

config.payment_due_day

integer
Optional

Day of month the payment for the previous billing cycle is due.

Allowable Values:

31

config.e_disclosure_active

boolean
Optional

A value of true indicates that the account holder consents to receiving disclosures and statements electronically.

Allowable Values:

true, false

Default value:
false

config.card_level

string
Optional

The level of the credit card.

Allowable Values:

PREMIUM, TRADITIONAL, NA

config.fees

array of objects
Optional

Contains one or more fees associated with the credit account.

Allowable Values:

One or more fees objects

config.fees[].type

string
Required

Type of fee.

Allowable Values:

LATE_PAYMENT_FEE, RETURNED_PAYMENT_FEE, MONTHLY_FEE, ANNUAL_FEE

config.fees[].schedule

array of objects
Required

Contains one or more fee schedules.

Allowable Values:

One or more schedule objects

config.fees[].schedule[].method

string
Required

Method used to calculate the fee value.

Allowable Values:

FLAT

config.fees[].schedule[].value

decimal
Required

Amount of the fee.

Allowable Values:

0–9999.9999

config.fees[].schedule[].effective_date

datetime
Optional

Date the fee becomes effective.

Allowable Values:

config.rewards

array of objects
Optional

Contains one or more rewards associated with the credit account.

Allowable Values:

One or more rewards objects

config.rewards[].type

string
Required

Type of reward.

Allowable Values:

AUTO_CASH_BACK, CASH_BACK

config.rewards[].method

string
Required

Method, either a flat amount or a percentage.

NOTE: Only FLAT is currently supported.

Allowable Values:

PERCENTAGE, FLAT

config.rewards[].value

decimal
Optional

Value of the reward, either a flat reward amount or percentage value.

Allowable Values:

0–100

config.payment_holds

object
Optional

Contains configurations for a payment hold.

Allowable Values:

config.payment_holds.ach_hold_days

integer
Optional

Number of days to hold an ACH payment.

Allowable Values:

0–7

config.payment_holds.check_hold_days

integer
Optional

Number of days to hold a check payment.

Allowable Values:

0–7

usages

array of objects
Required

Contains one or more usages objects that contain information on how a credit account is used and what types of balances are permitted on the account.

You can pass only one usages object per usages.type.

Allowable Values:

One or more usages objects

usages[].type

string
Required

Type of balance.

  • PURCHASE - The balance on purchases.

Allowable Values:

PURCHASE

usages[].aprs

array of objects
Required

Contains one or more annual percentage rates (APRs) associated with the type of balance on the credit account.

Allowable Values:

One or more aprs objects

usages[].aprs[].type

string
Required

Type of APR.

  • GO_TO - Default APR rate that is applicable when any promotional periods expire.

  • PROMOTIONAL - A temporary rate that is applicable for a specified period of time.

Allowable Values:

GO_TO, PROMOTIONAL

usages[].aprs[].schedule

array of objects
Required

Contains one or more schedule objects, which contain information on the annual percentage rates (APRs) associated with the type of balance on the credit account and when they are effective.

Allowable Values:

One or more schedule objects

usages[].aprs[].schedule[].type

string
Optional

Indicates whether the APR value is fixed or variable.

Allowable Values:

FIXED, VARIABLE

usages[].aprs[].schedule[].value

decimal
Required

Percentage value of the APR.

If the APR type is FIXED, this is the value of the fixed rate. If the APR type is VARIABLE, the value is calculated by adding the margin to the prime rate that was stored on Marqeta’s credit platform when your credit program was created.

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
Optional

The number of percentage points added to the prime rate, used to calculate a variable value.

Used for variable values only.

Allowable Values:

usages[].fees

array of objects
Optional

Contains one or more fees associated with the credit account.

Allowable Values:

One or more fees objects

usages[].fees[].type

string
Required

Type of fee.

NOTE: Only RETURNED_PAYMENT_FEE, LATE_PAYMENT_FEE, ANNUAL_FEE, and MONTHLY_FEE are currently supported. Do not pass other fees types.

Allowable Values:

FOREIGN_TRANSACTION_FEE, OVER_LIMIT_FEE, LATE_PAYMENT_FEE, RETURNED_PAYMENT_FEE, CARD_REPLACEMENT_FEE, MINIMUM_INTEREST_FEE, MINIMUM_INTEREST_FEE_REVERSAL, ANNUAL_FEE, MONTHLY_FEE

usages[].fees[].method

string
Required

Method, either a flat amount or a percentage.

NOTE: Only FLAT is currently supported.

Allowable Values:

PERCENTAGE, FLAT

usages[].fees[].value

decimal
Optional

Value of the fee, either a flat fee amount or percentage value.

Allowable Values:

0–9999.9999

Sample request body

JSON
Copied

Is this helpful?

Yes
No

Response body

Fields Description

token

string
Returned

Unique identifier of the credit account.

Allowable Values:

36 char max

name

string
Conditionally returned

Name of the credit account.

Allowable Values:

description

string
Conditionally returned

Description for the credit account.

Allowable Values:

Any string

currency_code

string
Returned

A valid three-digit ISO 4217 currency code

Allowable Values:

USD

status

string
Returned

Status of the credit account.

Allowable Values:

UNACTIVATED, ACTIVE, SUSPENDED, TERMINATED, CHARGE_OFF

activation_time

datetime
Conditionally returned

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
Returned

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
Returned

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
Conditionally returned

Type of credit account.

Allowable Values:

CONSUMER, BUSINESS

bundle_token

string
Conditionally returned

Unique identifier of the associated bundle product.

Allowable Values:

Existing token

credit_product_token

string
Returned

Unique identifier of the associated credit product.

Allowable Values:

Existing credit product token

user_token

string
Returned

Unique identifier of the primary account holder.

Allowable Values:

Existing user token

external_offer_id

string
Conditionally returned

Unique identifier you provide of the associated external credit offer.

Allowable Values:

Your external offer ID.

credit_limit

decimal
Returned

Maximum balance the credit account can carry.

Allowable Values:

0–1000000

current_balance

decimal
Returned

Current purchase balance on the credit account.

Allowable Values:

available_credit

decimal
Returned

Amount of credit available for use on the credit account.

Allowable Values:

remaining_statement_balance

decimal
Returned

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:

remaining_min_payment_due

decimal
Returned

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:

latest_statement_cycle_type

string
Returned

Type of cycle.

  • BEGINNING_REVOLVING - Account is beginning to revolve and just started carrying a balance from the previous month.

  • REVOLVING - Account is revolving and has been carrying a balance from month to month for more than one month.

  • END_REVOLVING - Account is no longer revolving and the previous month’s balance is paid off.

  • TRANSACTING - Account is not revolving and the balance is paid off each month.

Allowable Values:

BEGINNING_REVOLVING, REVOLVING, END_REVOLVING, TRANSACTING

When creating an account, only TRANSACTING is allowed.

config

object
Returned

Contains information returned when configuring an account’s billing cycle day, payment due day, fees, and more.

Allowable Values:

config.billing_cycle_day

integer
Conditionally returned

Day of month the billing cycle starts.

Allowable Values:

1

config.payment_due_day

integer
Conditionally returned

Day of month the payment for the previous billing cycle is due.

Allowable Values:

31

config.e_disclosure_active

boolean
Conditionally returned

A value of true indicates that the account holder consents to receiving disclosures and statements electronically.

Allowable Values:

true, false

Default value:
false

config.card_level

string
Conditionally returned

The level of the credit card.

Allowable Values:

PREMIUM, TRADITIONAL, NA

config.fees

array of objects
Conditionally returned

Contains one or more fees associated with the credit account.

Allowable Values:

One or more fees objects

config.fees[].type

string
Conditionally returned

Type of fee.

Allowable Values:

LATE_PAYMENT_FEE, RETURNED_PAYMENT_FEE, MONTHLY_FEE, ANNUAL_FEE

config.fees[].active

boolean
Conditionally returned

Whether the fee is active.

Allowable Values:

config.fees[].created_date

datetime
Conditionally returned

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
Conditionally returned

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
Conditionally returned

Contains one or more fee schedules.

Allowable Values:

One or more schedule objects

config.fees[].schedule[].method

string
Returned

Method used to calculate the fee value.

Allowable Values:

FLAT

config.fees[].schedule[].value

decimal
Returned

Amount of the fee.

Allowable Values:

0–9999.9999

config.fees[].schedule[].effective_date

datetime
Conditionally returned

Date the fee becomes effective.

Allowable Values:

config.rewards

array of objects
Conditionally returned

Contains one or more rewards associated with the credit account.

Allowable Values:

One or more rewards objects

config.rewards[].type

string
Returned

Type of reward.

Allowable Values:

AUTO_CASH_BACK, CASH_BACK

config.rewards[].method

string
Returned

Method, either a flat amount or a percentage.

NOTE: Only FLAT is currently supported.

Allowable Values:

PERCENTAGE, FLAT

config.rewards[].value

decimal
Conditionally returned

Value of the reward, either a flat reward amount or percentage value.

Allowable Values:

0–100

config.payment_holds

object
Conditionally returned

Contains configurations for a payment hold.

Allowable Values:

config.payment_holds.ach_hold_days

integer
Conditionally returned

Number of days to hold an ACH payment.

Allowable Values:

0–7

config.payment_holds.check_hold_days

integer
Conditionally returned

Number of days to hold a check payment.

Allowable Values:

0–7

config.min_payment

object
Conditionally returned

Contains configurations for a minimum payment override on a credit account, which overrides the minimum payment configurations on the associated credit product.

Allowable Values:

config.min_payment.override_start_time

datetime
Conditionally returned

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
Conditionally returned

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
Conditionally returned

Flat amount of the minimum payment override.

Allowable Values:

0 min

config.min_payment.min_payment_percentage

decimal
Conditionally returned

Percentage of the total statement balance used to calculate the minimum payment override amount.

Allowable Values:

0 min

config.min_payment.active

boolean
Conditionally returned

Whether the minimum payment override is currently active.

Allowable Values:

usages

array of objects
Returned

Contains one or more usages objects that contain information on how a credit account is used and what types of balances are permitted on the account.

Allowable Values:

One or more usages objects

usages[].type

string
Returned

Type of balance.

  • PURCHASE - The balance on purchases.

Allowable Values:

PURCHASE

usages[].aprs

array of objects
Returned

Contains one or more APRs associated with the type of balance on the credit account

Allowable Values:

One or more aprs objects

usages[].aprs[].type

string
Returned

Type of APR.

  • GO_TO - Default APR rate that is applicable when any promotional periods expire.

  • PROMOTIONAL - A temporary rate that is applicable for a specified period of time.

Allowable Values:

GO_TO, PROMOTIONAL

usages[].aprs[].active

boolean
Conditionally returned

Whether the APR is active.

Allowable Values:

usages[].aprs[].created_date

datetime
Conditionally returned

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
Conditionally returned

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
Returned

Contains one or more schedule objects, which contain information about the annual percentage rates (APRs) associated with the type of balance on the credit account and when they are effective.

Allowable Values:

One or more schedule objects

usages[].aprs[].schedule[].type

string
Conditionally returned

Indicates whether the APR value is fixed or variable.

Allowable Values:

FIXED, VARIABLE

usages[].aprs[].schedule[].value

decimal
Returned

Percentage value of the APR.

If the APR type is FIXED, this is the value of the fixed rate. If the APR type is VARIABLE, the value is calculated by adding the margin to the prime rate that was stored on Marqeta’s credit platform when your credit program was created.

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
Conditionally returned

The number of percentage points added to the prime rate, used to calculate a variable value.

Used for variable values only.

Allowable Values:

usages[].aprs[].schedule[].effective_date

datetime
Conditionally returned

Date and time when the APR becomes effective.

Allowable Values:

Format: yyyy-MM-ddThh:mm:ssZ

usages[].aprs[].schedule[].apply_next_cycle

boolean
Conditionally returned

Whether the APR is ignored for the current billing cycle and applied on the next.

Allowable Values:

true, false

Default value:
false

usages[].fees

array of objects
Conditionally returned

Contains one or more fees associated with the credit account.

Allowable Values:

One or more fees objects

usages[].fees[].type

string
Returned

Type of fee.

NOTE: Only RETURNED_PAYMENT_FEE, LATE_PAYMENT_FEE, ANNUAL_FEE, and MONTHLY_FEE are currently supported. Do not pass other fees types.

Allowable Values:

FOREIGN_TRANSACTION_FEE, OVER_LIMIT_FEE, LATE_PAYMENT_FEE, RETURNED_PAYMENT_FEE, CARD_REPLACEMENT_FEE, MINIMUM_INTEREST_FEE, MINIMUM_INTEREST_FEE_REVERSAL, ANNUAL_FEE, MONTHLY_FEE

usages[].fees[].method

string
Returned

Method, either a flat amount or a percentage.

NOTE: Only FLAT is currently supported.

Allowable Values:

PERCENTAGE, FLAT

usages[].fees[].value

decimal
Conditionally returned

Value of the fee, either a flat fee amount or percentage value.

Allowable Values:

0–9999.9999

Sample response body

JSON
Copied

Is this helpful?

Yes
No

List accounts

Action: GET
Endpoint: /credit/accounts

Retrieve an array of credit accounts.

This endpoint supports sorting and pagination.

URL query parameters

Fields Description

card_token

string
Optional

The unique identifier of the credit card associated with the account.

Allowable Values:

Existing card token

count

integer
Optional

The number of resources to retrieve.

Allowable Values:

1–100

start_index

integer
Optional

Sort order index of the first resource in the returned array.

Allowable Values:

0 min

sort_by

string
Optional

Field on which to sort. Prefix the field name with a hyphen (-) to sort in descending order. Omit the hyphen to sort in ascending order.

NOTE: You must sort using system field names such as lastModifiedTime, and not by the field names appearing in response bodies such as last_modified_time.

Allowable Values:

lastModifiedTime, -lastModifiedTime

Response body

Fields Description

count

integer
Returned

Number of resources returned.

Allowable Values:

1-10

start_index

integer
Returned

Sort order index of the first resource in the returned array.

Allowable Values:

Any integer

end_index

integer
Returned

Sort order index of the first resource in the returned array.

Allowable Values:

Any integer

is_more

boolean
Returned

A value of true indicates that more unreturned resources exist.

Allowable Values:

true, false

data

array of objects
Returned

Contains one or more credit accounts.

Allowable Values:

One or more credit accounts

data[].token

string
Returned

Unique identifier of the credit account.

Allowable Values:

36 char max

data[].name

string
Conditionally returned

Name of the credit account.

Allowable Values:

data[].description

string
Conditionally returned

Description for the credit account.

Allowable Values:

Any string

data[].currency_code

string
Returned

A valid three-digit ISO 4217 currency code

Allowable Values:

USD

data[].status

string
Returned

Status of the credit account.

Allowable Values:

UNACTIVATED, ACTIVE, SUSPENDED, TERMINATED, CHARGE_OFF

data[].activation_time

datetime
Conditionally returned

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
Returned

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
Returned

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
Conditionally returned

Type of credit account.

Allowable Values:

CONSUMER, BUSINESS

data[].bundle_token

string
Conditionally returned

Unique identifier of the associated bundle product.

Allowable Values:

Existing token

data[].credit_product_token

string
Returned

Unique identifier of the associated credit product.

Allowable Values:

Existing credit product token

data[].user_token

string
Returned

Unique identifier of the primary account holder.

Allowable Values:

Existing user token

data[].external_offer_id

string
Conditionally returned

Unique identifier you provide of the associated external credit offer.

Allowable Values:

Your external offer ID.

data[].credit_limit

decimal
Returned

Maximum balance the credit account can carry.

Allowable Values:

0–1000000

data[].current_balance

decimal
Returned

Current purchase balance on the credit account.

Allowable Values:

data[].available_credit

decimal
Returned

Amount of credit available for use on the credit account.

Allowable Values:

data[].remaining_statement_balance

decimal
Returned

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:

data[].remaining_min_payment_due

decimal
Returned

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:

data[].latest_statement_cycle_type

string
Returned

Type of cycle.

  • BEGINNING_REVOLVING - Account is beginning to revolve and just started carrying a balance from the previous month.

  • REVOLVING - Account is revolving and has been carrying a balance from month to month for more than one month.

  • END_REVOLVING - Account is no longer revolving and the previous month’s balance is paid off.

  • TRANSACTING - Account is not revolving and the balance is paid off each month.

Allowable Values:

BEGINNING_REVOLVING, REVOLVING, END_REVOLVING, TRANSACTING

When creating an account, only TRANSACTING is allowed.

data[].config

object
Returned

Contains information returned when configuring an account’s billing cycle day, payment due day, fees, and more.

Allowable Values:

data[].config.billing_cycle_day

integer
Conditionally returned

Day of month the billing cycle starts.

Allowable Values:

1

data[].config.payment_due_day

integer
Conditionally returned

Day of month the payment for the previous billing cycle is due.

Allowable Values:

31

data[].config.e_disclosure_active

boolean
Conditionally returned

A value of true indicates that the account holder consents to receiving disclosures and statements electronically.

Allowable Values:

true, false

Default value:
false

data[].config.card_level

string
Conditionally returned

The level of the credit card.

Allowable Values:

PREMIUM, TRADITIONAL, NA

data[].config.fees

array of objects
Conditionally returned

Contains one or more fees associated with the credit account.

Allowable Values:

One or more fees objects

data[].config.fees[].type

string
Conditionally returned

Type of fee.

Allowable Values:

LATE_PAYMENT_FEE, RETURNED_PAYMENT_FEE, MONTHLY_FEE, ANNUAL_FEE

data[].config.fees[].active

boolean
Conditionally returned

Whether the fee is active.

Allowable Values:

data[].config.fees[].created_date

datetime
Conditionally returned

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
Conditionally returned

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
Conditionally returned

Contains one or more fee schedules.

Allowable Values:

One or more schedule objects

data[].config.fees[].schedule[].method

string
Returned

Method used to calculate the fee value.

Allowable Values:

FLAT

data[].config.fees[].schedule[].value

decimal
Returned

Amount of the fee.

Allowable Values:

0–9999.9999

data[].config.fees[].schedule[].effective_date

datetime
Conditionally returned

Date the fee becomes effective.

Allowable Values:

data[].config.rewards

array of objects
Conditionally returned

Contains one or more rewards associated with the credit account.

Allowable Values:

One or more rewards objects

data[].config.rewards[].type

string
Returned

Type of reward.

Allowable Values:

AUTO_CASH_BACK, CASH_BACK

data[].config.rewards[].method

string
Returned

Method, either a flat amount or a percentage.

NOTE: Only FLAT is currently supported.

Allowable Values:

PERCENTAGE, FLAT

data[].config.rewards[].value

decimal
Conditionally returned

Value of the reward, either a flat reward amount or percentage value.

Allowable Values:

0–100

data[].config.payment_holds

object
Conditionally returned

Contains configurations for a payment hold.

Allowable Values:

data[].config.payment_holds.ach_hold_days

integer
Conditionally returned

Number of days to hold an ACH payment.

Allowable Values:

0–7

data[].config.payment_holds.check_hold_days

integer
Conditionally returned

Number of days to hold a check payment.

Allowable Values:

0–7

data[].config.min_payment

object
Conditionally returned

Contains configurations for a minimum payment override on a credit account, which overrides the minimum payment configurations on the associated credit product.

Allowable Values:

data[].config.min_payment.override_start_time

datetime
Conditionally returned

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
Conditionally returned

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
Conditionally returned

Flat amount of the minimum payment override.

Allowable Values:

0 min

data[].config.min_payment.min_payment_percentage

decimal
Conditionally returned

Percentage of the total statement balance used to calculate the minimum payment override amount.

Allowable Values:

0 min

data[].config.min_payment.active

boolean
Conditionally returned

Whether the minimum payment override is currently active.

Allowable Values:

data[].usages

array of objects
Returned

Contains one or more usages objects that contain information on how a credit account is used and what types of balances are permitted on the account.

Allowable Values:

One or more usages objects

data[].usages[].type

string
Returned

Type of balance.

  • PURCHASE - The balance on purchases.

Allowable Values:

PURCHASE

data[].usages[].aprs

array of objects
Returned

Contains one or more APRs associated with the type of balance on the credit account

Allowable Values:

One or more aprs objects

data[].usages[].aprs[].type

string
Returned

Type of APR.

  • GO_TO - Default APR rate that is applicable when any promotional periods expire.

  • PROMOTIONAL - A temporary rate that is applicable for a specified period of time.

Allowable Values:

GO_TO, PROMOTIONAL

data[].usages[].aprs[].active

boolean
Conditionally returned

Whether the APR is active.

Allowable Values:

data[].usages[].aprs[].created_date

datetime
Conditionally returned

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
Conditionally returned

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
Returned

Contains one or more schedule objects, which contain information about the annual percentage rates (APRs) associated with the type of balance on the credit account and when they are effective.

Allowable Values:

One or more schedule objects

data[].usages[].aprs[].schedule[].type

string
Conditionally returned

Indicates whether the APR value is fixed or variable.

Allowable Values:

FIXED, VARIABLE

data[].usages[].aprs[].schedule[].value

decimal
Returned

Percentage value of the APR.

If the APR type is FIXED, this is the value of the fixed rate. If the APR type is VARIABLE, the value is calculated by adding the margin to the prime rate that was stored on Marqeta’s credit platform when your credit program was created.

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
Conditionally returned

The number of percentage points added to the prime rate, used to calculate a variable value.

Used for variable values only.

Allowable Values:

data[].usages[].aprs[].schedule[].effective_date

datetime
Conditionally returned

Date and time when the APR becomes effective.

Allowable Values:

Format: yyyy-MM-ddThh:mm:ssZ

data[].usages[].aprs[].schedule[].apply_next_cycle

boolean
Conditionally returned

Whether the APR is ignored for the current billing cycle and applied on the next.

Allowable Values:

true, false

Default value:
false

data[].usages[].fees

array of objects
Conditionally returned

Contains one or more fees associated with the credit account.

Allowable Values:

One or more fees objects

data[].usages[].fees[].type

string
Returned

Type of fee.

NOTE: Only RETURNED_PAYMENT_FEE, LATE_PAYMENT_FEE, ANNUAL_FEE, and MONTHLY_FEE are currently supported. Do not pass other fees types.

Allowable Values:

FOREIGN_TRANSACTION_FEE, OVER_LIMIT_FEE, LATE_PAYMENT_FEE, RETURNED_PAYMENT_FEE, CARD_REPLACEMENT_FEE, MINIMUM_INTEREST_FEE, MINIMUM_INTEREST_FEE_REVERSAL, ANNUAL_FEE, MONTHLY_FEE

data[].usages[].fees[].method

string
Returned

Method, either a flat amount or a percentage.

NOTE: Only FLAT is currently supported.

Allowable Values:

PERCENTAGE, FLAT

data[].usages[].fees[].value

decimal
Conditionally returned

Value of the fee, either a flat fee amount or percentage value.

Allowable Values:

0–9999.9999

Sample response body

JSON
Copied

Is this helpful?

Yes
No

Retrieve account

Action: GET
Endpoint: /credit/accounts/{account_token}

Retrieve a credit account.

URL path parameters

Fields Description

account_token

string
Required

The unique identifier of the credit account to retrieve.

Send a GET request to /credit/accounts to retrieve existing credit account tokens.

Allowable Values:

Existing account token

Response body

Fields Description

token

string
Returned

Unique identifier of the credit account.

Allowable Values:

36 char max

name

string
Conditionally returned

Name of the credit account.

Allowable Values:

description

string
Conditionally returned

Description for the credit account.

Allowable Values:

Any string

currency_code

string
Returned

A valid three-digit ISO 4217 currency code

Allowable Values:

USD

status

string
Returned

Status of the credit account.

Allowable Values:

UNACTIVATED, ACTIVE, SUSPENDED, TERMINATED, CHARGE_OFF

activation_time

datetime
Conditionally returned

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
Returned

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
Returned

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
Conditionally returned

Type of credit account.

Allowable Values:

CONSUMER, BUSINESS

bundle_token

string
Conditionally returned

Unique identifier of the associated bundle product.

Allowable Values:

Existing token

credit_product_token

string
Returned

Unique identifier of the associated credit product.

Allowable Values:

Existing credit product token

user_token

string
Returned

Unique identifier of the primary account holder.

Allowable Values:

Existing user token

external_offer_id

string
Conditionally returned

Unique identifier you provide of the associated external credit offer.

Allowable Values:

Your external offer ID.

credit_limit

decimal
Returned

Maximum balance the credit account can carry.

Allowable Values:

0–1000000

current_balance

decimal
Returned

Current purchase balance on the credit account.

Allowable Values:

available_credit

decimal
Returned

Amount of credit available for use on the credit account.

Allowable Values:

remaining_statement_balance

decimal
Returned

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:

remaining_min_payment_due

decimal
Returned

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:

latest_statement_cycle_type

string
Returned

Type of cycle.

  • BEGINNING_REVOLVING - Account is beginning to revolve and just started carrying a balance from the previous month.

  • REVOLVING - Account is revolving and has been carrying a balance from month to month for more than one month.

  • END_REVOLVING - Account is no longer revolving and the previous month’s balance is paid off.

  • TRANSACTING - Account is not revolving and the balance is paid off each month.

Allowable Values:

BEGINNING_REVOLVING, REVOLVING, END_REVOLVING, TRANSACTING

When creating an account, only TRANSACTING is allowed.

config

object
Returned

Contains information returned when configuring an account’s billing cycle day, payment due day, fees, and more.

Allowable Values:

config.billing_cycle_day

integer
Conditionally returned

Day of month the billing cycle starts.

Allowable Values:

1

config.payment_due_day

integer
Conditionally returned

Day of month the payment for the previous billing cycle is due.

Allowable Values:

31

config.e_disclosure_active

boolean
Conditionally returned

A value of true indicates that the account holder consents to receiving disclosures and statements electronically.

Allowable Values:

true, false

Default value:
false

config.card_level

string
Conditionally returned

The level of the credit card.

Allowable Values:

PREMIUM, TRADITIONAL, NA

config.fees

array of objects
Conditionally returned

Contains one or more fees associated with the credit account.

Allowable Values:

One or more fees objects

config.fees[].type

string
Conditionally returned

Type of fee.

Allowable Values:

LATE_PAYMENT_FEE, RETURNED_PAYMENT_FEE, MONTHLY_FEE, ANNUAL_FEE

config.fees[].active

boolean
Conditionally returned

Whether the fee is active.

Allowable Values:

config.fees[].created_date

datetime
Conditionally returned

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
Conditionally returned

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
Conditionally returned

Contains one or more fee schedules.

Allowable Values:

One or more schedule objects

config.fees[].schedule[].method

string
Returned

Method used to calculate the fee value.

Allowable Values:

FLAT

config.fees[].schedule[].value

decimal
Returned

Amount of the fee.

Allowable Values:

0–9999.9999

config.fees[].schedule[].effective_date

datetime
Conditionally returned

Date the fee becomes effective.

Allowable Values:

config.rewards

array of objects
Conditionally returned

Contains one or more rewards associated with the credit account.

Allowable Values:

One or more rewards objects

config.rewards[].type

string
Returned

Type of reward.

Allowable Values:

AUTO_CASH_BACK, CASH_BACK

config.rewards[].method

string
Returned

Method, either a flat amount or a percentage.

NOTE: Only FLAT is currently supported.

Allowable Values:

PERCENTAGE, FLAT

config.rewards[].value

decimal
Conditionally returned

Value of the reward, either a flat reward amount or percentage value.

Allowable Values:

0–100

config.payment_holds

object
Conditionally returned

Contains configurations for a payment hold.

Allowable Values:

config.payment_holds.ach_hold_days

integer
Conditionally returned

Number of days to hold an ACH payment.

Allowable Values:

0–7

config.payment_holds.check_hold_days

integer
Conditionally returned

Number of days to hold a check payment.

Allowable Values:

0–7

config.min_payment

object
Conditionally returned

Contains configurations for a minimum payment override on a credit account, which overrides the minimum payment configurations on the associated credit product.

Allowable Values:

config.min_payment.override_start_time

datetime
Conditionally returned

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
Conditionally returned

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
Conditionally returned

Flat amount of the minimum payment override.

Allowable Values:

0 min

config.min_payment.min_payment_percentage

decimal
Conditionally returned

Percentage of the total statement balance used to calculate the minimum payment override amount.

Allowable Values:

0 min

config.min_payment.active

boolean
Conditionally returned

Whether the minimum payment override is currently active.

Allowable Values:

usages

array of objects
Returned

Contains one or more usages objects that contain information on how a credit account is used and what types of balances are permitted on the account.

Allowable Values:

One or more usages objects

usages[].type

string
Returned

Type of balance.

  • PURCHASE - The balance on purchases.

Allowable Values:

PURCHASE

usages[].aprs

array of objects
Returned

Contains one or more APRs associated with the type of balance on the credit account

Allowable Values:

One or more aprs objects

usages[].aprs[].type

string
Returned

Type of APR.

  • GO_TO - Default APR rate that is applicable when any promotional periods expire.

  • PROMOTIONAL - A temporary rate that is applicable for a specified period of time.

Allowable Values:

GO_TO, PROMOTIONAL

usages[].aprs[].active

boolean
Conditionally returned

Whether the APR is active.

Allowable Values:

usages[].aprs[].created_date

datetime
Conditionally returned

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
Conditionally returned

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
Returned

Contains one or more schedule objects, which contain information about the annual percentage rates (APRs) associated with the type of balance on the credit account and when they are effective.

Allowable Values:

One or more schedule objects

usages[].aprs[].schedule[].type

string
Conditionally returned

Indicates whether the APR value is fixed or variable.

Allowable Values:

FIXED, VARIABLE

usages[].aprs[].schedule[].value

decimal
Returned

Percentage value of the APR.

If the APR type is FIXED, this is the value of the fixed rate. If the APR type is VARIABLE, the value is calculated by adding the margin to the prime rate that was stored on Marqeta’s credit platform when your credit program was created.

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
Conditionally returned

The number of percentage points added to the prime rate, used to calculate a variable value.

Used for variable values only.

Allowable Values:

usages[].aprs[].schedule[].effective_date

datetime
Conditionally returned

Date and time when the APR becomes effective.

Allowable Values:

Format: yyyy-MM-ddThh:mm:ssZ

usages[].aprs[].schedule[].apply_next_cycle

boolean
Conditionally returned

Whether the APR is ignored for the current billing cycle and applied on the next.

Allowable Values:

true, false

Default value:
false

usages[].fees

array of objects
Conditionally returned

Contains one or more fees associated with the credit account.

Allowable Values:

One or more fees objects

usages[].fees[].type

string
Returned

Type of fee.

NOTE: Only RETURNED_PAYMENT_FEE, LATE_PAYMENT_FEE, ANNUAL_FEE, and MONTHLY_FEE are currently supported. Do not pass other fees types.

Allowable Values:

FOREIGN_TRANSACTION_FEE, OVER_LIMIT_FEE, LATE_PAYMENT_FEE, RETURNED_PAYMENT_FEE, CARD_REPLACEMENT_FEE, MINIMUM_INTEREST_FEE, MINIMUM_INTEREST_FEE_REVERSAL, ANNUAL_FEE, MONTHLY_FEE

usages[].fees[].method

string
Returned

Method, either a flat amount or a percentage.

NOTE: Only FLAT is currently supported.

Allowable Values:

PERCENTAGE, FLAT

usages[].fees[].value

decimal
Conditionally returned

Value of the fee, either a flat fee amount or percentage value.

Allowable Values:

0–9999.9999

Sample response body

JSON
Copied

Is this helpful?

Yes
No

Update account

Action: PUT
Endpoint: /credit/accounts/{account_token}

Update a credit account.

URL path parameters

Fields Description

account_token

string
Required

The unique identifier of the credit account to update.

Send a GET request to /credit/accounts to retrieve existing credit account tokens.

Allowable Values:

Existing account token

Request body

Fields Description

config

object
Optional

Contains information relevant for updating configurations for electronic disclosures, fees, payment holds, and minimum payment.

Allowable Values:

config.e_disclosure_active

boolean
Optional

A value of true indicates that the account holder consents to receiving disclosures and statements electronically.

Allowable Values:

true, false

Default value:
false

config.fees

array of objects
Optional

Contains one or more fees associated with the credit account.

Allowable Values:

One or more fees objects

config.fees[].type

string
Required

Type of fee.

Allowable Values:

LATE_PAYMENT_FEE, RETURNED_PAYMENT_FEE, MONTHLY_FEE, ANNUAL_FEE

config.fees[].schedule

array of objects
Required

Contains one or more fee schedules.

Allowable Values:

One or more schedule objects

config.fees[].schedule[].method

string
Required

Method used to calculate the fee value.

Allowable Values:

FLAT

config.fees[].schedule[].value

decimal
Required

Amount of the fee.

Allowable Values:

0–9999.9999

config.fees[].schedule[].effective_date

datetime
Optional

Date the fee becomes effective.

Allowable Values:

config.payment_holds

object
Optional

Contains configurations for a payment hold.

Allowable Values:

config.payment_holds.ach_hold_days

integer
Optional

Number of days to hold an ACH payment.

Allowable Values:

0–7

config.payment_holds.check_hold_days

integer
Optional

Number of days to hold a check payment.

Allowable Values:

0–7

config.min_payment

object
Optional

Contains configurations for a minimum payment override on a credit account, which overrides the minimum payment configurations on the associated credit product.

Allowable Values:

config.min_payment.override_start_time

datetime
Optional

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
Optional

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
Optional

Flat amount of the minimum payment override.

Allowable Values:

0 min

config.min_payment.min_payment_percentage

decimal
Optional

Percentage of the total statement balance used to calculate the minimum payment override amount.

Allowable Values:

0 min

config.min_payment.active

boolean
Optional

Whether the minimum payment override is currently active.

Allowable Values:

usages

array of objects
Optional

Contains one or more usages objects that contain information on how a credit account is used and what types of balances are permitted on the account.

You can pass only one usages object per usages.type.

Allowable Values:

One or more usages objects

usages[].type

string
Required

Type of balance.

  • PURCHASE - The balance on purchases.

Allowable Values:

PURCHASE

usages[].aprs

array of objects
Optional

Contains one or more annual percentage rates (APRs) associated with the credit account.

Allowable Values:

One or more aprs objects

usages[].aprs[].type

string
Required

Type of APR.

  • GO_TO - Default APR rate that is applicable when any promotional periods expire.

  • PROMOTIONAL - A temporary rate that is applicable for a specified period of time.

Allowable Values:

GO_TO, PROMOTIONAL

usages[].aprs[].schedule

array of objects
Required

Contains one or more schedule objects, which contain information about the annual percentage rates (APRs) associated with the type of balance on the credit account and when they are effective.

Allowable Values:

One or more schedule objects

usages[].aprs[].schedule[].type

string
Optional

Indicates whether the APR value is fixed or variable.

Allowable Values:

FIXED, VARIABLE

usages[].aprs[].schedule[].margin

decimal
Optional

The number of percentage points added to the prime rate, used to calculate a variable value.

Used for variable values only.

Allowable Values:

usages[].aprs[].schedule[].value

decimal
Required

Percentage value of the APR.

If the APR type is FIXED, this is the value of the fixed rate. If the APR type is VARIABLE, the value is calculated by adding the margin to the prime rate that was stored on Marqeta’s credit platform when your credit program was created.

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
Optional

Date and time when the APR becomes effective.

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 schedule objects, this field is required in all objects but the first. If you do not include effective_date in the first schedule, the system uses the date and time when the API request was received.

Allowable Values:

Format: yyyy-MM-ddThh:mm:ssZ

usages[].aprs[].schedule[].apply_next_cycle

boolean
Optional

Whether the APR can be ignored for the current billing cycle and applied on the next.

Allowable Values:

true, false

Default value:
false

credit_limit

object
Optional

Contains information on the credit limit.

Allowable Values:

credit_limit.value

decimal
Required

Maximum balance the credit account can carry.

Allowable Values:

0–999999999999.99

latest_statement_cycle_type

string
Optional

Type of cycle.

  • BEGINNING_REVOLVING - Account is beginning to revolve and just started carrying a balance from the previous month.

  • REVOLVING - Account is revolving and has been carrying a balance from month to month for more than one month.

  • END_REVOLVING - Account is no longer revolving and the previous month’s balance is paid off.

  • TRANSACTING - Account is not revolving and the balance is paid off each month.

Allowable Values:

BEGINNING_REVOLVING, REVOLVING, END_REVOLVING, TRANSACTING

When creating an account, only TRANSACTING is allowed.

Sample request body

JSON
Copied

Is this helpful?

Yes
No

Response body

Fields Description

token

string
Returned

Unique identifier of the credit account.

Allowable Values:

36 char max

name

string
Conditionally returned

Name of the credit account.

Allowable Values:

description

string
Conditionally returned

Description for the credit account.

Allowable Values:

Any string

currency_code

string
Returned

A valid three-digit ISO 4217 currency code

Allowable Values:

USD

status

string
Returned

Status of the credit account.

Allowable Values:

UNACTIVATED, ACTIVE, SUSPENDED, TERMINATED, CHARGE_OFF

activation_time

datetime
Conditionally returned

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
Returned

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
Returned

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
Conditionally returned

Type of credit account.

Allowable Values:

CONSUMER, BUSINESS

bundle_token

string
Conditionally returned

Unique identifier of the associated bundle product.

Allowable Values:

Existing token

credit_product_token

string
Returned

Unique identifier of the associated credit product.

Allowable Values:

Existing credit product token

user_token

string
Returned

Unique identifier of the primary account holder.

Allowable Values:

Existing user token

external_offer_id

string
Conditionally returned

Unique identifier you provide of the associated external credit offer.

Allowable Values:

Your external offer ID.

credit_limit

decimal
Returned

Maximum balance the credit account can carry.

Allowable Values:

0–1000000

current_balance

decimal
Returned

Current purchase balance on the credit account.

Allowable Values:

available_credit

decimal
Returned

Amount of credit available for use on the credit account.

Allowable Values:

remaining_statement_balance

decimal
Returned

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:

remaining_min_payment_due

decimal
Returned

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:

latest_statement_cycle_type

string
Returned

Type of cycle.

  • BEGINNING_REVOLVING - Account is beginning to revolve and just started carrying a balance from the previous month.

  • REVOLVING - Account is revolving and has been carrying a balance from month to month for more than one month.

  • END_REVOLVING - Account is no longer revolving and the previous month’s balance is paid off.

  • TRANSACTING - Account is not revolving and the balance is paid off each month.

Allowable Values:

BEGINNING_REVOLVING, REVOLVING, END_REVOLVING, TRANSACTING

When creating an account, only TRANSACTING is allowed.

config

object
Returned

Contains information returned when configuring an account’s billing cycle day, payment due day, fees, and more.

Allowable Values:

config.billing_cycle_day

integer
Conditionally returned

Day of month the billing cycle starts.

Allowable Values:

1

config.payment_due_day

integer
Conditionally returned

Day of month the payment for the previous billing cycle is due.

Allowable Values:

31

config.e_disclosure_active

boolean
Conditionally returned

A value of true indicates that the account holder consents to receiving disclosures and statements electronically.

Allowable Values:

true, false

Default value:
false

config.card_level

string
Conditionally returned

The level of the credit card.

Allowable Values:

PREMIUM, TRADITIONAL, NA

config.fees

array of objects
Conditionally returned

Contains one or more fees associated with the credit account.

Allowable Values:

One or more fees objects

config.fees[].type

string
Conditionally returned

Type of fee.

Allowable Values:

LATE_PAYMENT_FEE, RETURNED_PAYMENT_FEE, MONTHLY_FEE, ANNUAL_FEE

config.fees[].active

boolean
Conditionally returned

Whether the fee is active.

Allowable Values:

config.fees[].created_date

datetime
Conditionally returned

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
Conditionally returned

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
Conditionally returned

Contains one or more fee schedules.

Allowable Values:

One or more schedule objects

config.fees[].schedule[].method

string
Returned

Method used to calculate the fee value.

Allowable Values:

FLAT

config.fees[].schedule[].value

decimal
Returned

Amount of the fee.

Allowable Values:

0–9999.9999

config.fees[].schedule[].effective_date

datetime
Conditionally returned

Date the fee becomes effective.

Allowable Values:

config.rewards

array of objects
Conditionally returned

Contains one or more rewards associated with the credit account.

Allowable Values:

One or more rewards objects

config.rewards[].type

string
Returned

Type of reward.

Allowable Values:

AUTO_CASH_BACK, CASH_BACK

config.rewards[].method

string
Returned

Method, either a flat amount or a percentage.

NOTE: Only FLAT is currently supported.

Allowable Values:

PERCENTAGE, FLAT

config.rewards[].value

decimal
Conditionally returned

Value of the reward, either a flat reward amount or percentage value.

Allowable Values:

0–100

config.payment_holds

object
Conditionally returned

Contains configurations for a payment hold.

Allowable Values:

config.payment_holds.ach_hold_days

integer
Conditionally returned

Number of days to hold an ACH payment.

Allowable Values:

0–7

config.payment_holds.check_hold_days

integer
Conditionally returned

Number of days to hold a check payment.

Allowable Values:

0–7

config.min_payment

object
Conditionally returned

Contains configurations for a minimum payment override on a credit account, which overrides the minimum payment configurations on the associated credit product.

Allowable Values:

config.min_payment.override_start_time

datetime
Conditionally returned

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
Conditionally returned

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
Conditionally returned

Flat amount of the minimum payment override.

Allowable Values:

0 min

config.min_payment.min_payment_percentage

decimal
Conditionally returned

Percentage of the total statement balance used to calculate the minimum payment override amount.

Allowable Values:

0 min

config.min_payment.active

boolean
Conditionally returned

Whether the minimum payment override is currently active.

Allowable Values:

usages

array of objects
Returned

Contains one or more usages objects that contain information on how a credit account is used and what types of balances are permitted on the account.

Allowable Values:

One or more usages objects

usages[].type

string
Returned

Type of balance.

  • PURCHASE - The balance on purchases.

Allowable Values:

PURCHASE

usages[].aprs

array of objects
Returned

Contains one or more APRs associated with the type of balance on the credit account

Allowable Values:

One or more aprs objects

usages[].aprs[].type

string
Returned

Type of APR.

  • GO_TO - Default APR rate that is applicable when any promotional periods expire.

  • PROMOTIONAL - A temporary rate that is applicable for a specified period of time.

Allowable Values:

GO_TO, PROMOTIONAL

usages[].aprs[].active

boolean
Conditionally returned

Whether the APR is active.

Allowable Values:

usages[].aprs[].created_date

datetime
Conditionally returned

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
Conditionally returned

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
Returned

Contains one or more schedule objects, which contain information about the annual percentage rates (APRs) associated with the type of balance on the credit account and when they are effective.

Allowable Values:

One or more schedule objects

usages[].aprs[].schedule[].type

string
Conditionally returned

Indicates whether the APR value is fixed or variable.

Allowable Values:

FIXED, VARIABLE

usages[].aprs[].schedule[].value

decimal
Returned

Percentage value of the APR.

If the APR type is FIXED, this is the value of the fixed rate. If the APR type is VARIABLE, the value is calculated by adding the margin to the prime rate that was stored on Marqeta’s credit platform when your credit program was created.

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
Conditionally returned

The number of percentage points added to the prime rate, used to calculate a variable value.

Used for variable values only.

Allowable Values:

usages[].aprs[].schedule[].effective_date

datetime
Conditionally returned

Date and time when the APR becomes effective.

Allowable Values:

Format: yyyy-MM-ddThh:mm:ssZ

usages[].aprs[].schedule[].apply_next_cycle

boolean
Conditionally returned

Whether the APR is ignored for the current billing cycle and applied on the next.

Allowable Values:

true, false

Default value:
false

usages[].fees

array of objects
Conditionally returned

Contains one or more fees associated with the credit account.

Allowable Values:

One or more fees objects

usages[].fees[].type

string
Returned

Type of fee.

NOTE: Only RETURNED_PAYMENT_FEE, LATE_PAYMENT_FEE, ANNUAL_FEE, and MONTHLY_FEE are currently supported. Do not pass other fees types.

Allowable Values:

FOREIGN_TRANSACTION_FEE, OVER_LIMIT_FEE, LATE_PAYMENT_FEE, RETURNED_PAYMENT_FEE, CARD_REPLACEMENT_FEE, MINIMUM_INTEREST_FEE, MINIMUM_INTEREST_FEE_REVERSAL, ANNUAL_FEE, MONTHLY_FEE

usages[].fees[].method

string
Returned

Method, either a flat amount or a percentage.

NOTE: Only FLAT is currently supported.

Allowable Values:

PERCENTAGE, FLAT

usages[].fees[].value

decimal
Conditionally returned

Value of the fee, either a flat fee amount or percentage value.

Allowable Values:

0–9999.9999

Sample response body

JSON
Copied

Is this helpful?

Yes
No

Join our developer newsletter