/
145 minute read
March 24, 2022

Credit Accounts

The Marqeta platform’s credit accounts feature enables you to create and maintain a credit account that centers around a single credit line with one or more cards and cardholders. A credit account derives some of its characteristics from an associated credit product.

For more on credit 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 credit bundle.

You must pass either bundle_token or both credit_product_token and external_offer_id.

Allowable Values:

Existing credit 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

Configurations for the billing cycle day, payment due day, and fees.

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

config.card_level

string
Optional

The level of the credit card.

Allowable Values:

PREMIUM, TRADITIONAL, NA

config.fees

array of objects
Optional

List of fees associated with the credit account.

Allowable Values:

config.fees[].type

string
Required

Type of fee.

Allowable Values:

LATE_PAYMENT_FEE, RETURNED_PAYMENT_FEE

config.fees[].schedule

array of objects
Required

List of fees and when they are effective.

Allowable Values:

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

List of rewards associated with the credit account.

Allowable Values:

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: Currently only FLAT is 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

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

List of objects containing 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:

usages[].type

string
Required

Type of balance.

  • PURCHASE - The balance on purchases.

Allowable Values:

PURCHASE

usages[].aprs

array of objects
Required

List of annual percentage rates (APRs) associated with the type of balance on the credit account.

Allowable Values:

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

List of objects containing information about the annual percentage rates (APRs) associated with the type of balance on the credit account and when they are effective.

Allowable Values:

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 in the Marqeta platform’s system of record 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

List of fees associated with the credit account.

Allowable Values:

usages[].fees[].type

string
Required

Type of fee.

NOTE: Currently only RETURNED_PAYMENT_FEE and LATE_PAYMENT_FEE are supported. Do not pass other fees types.

Allowable Values:

PERIODIC_MEMBERSHIP_FEE, FOREIGN_TRANSACTION_FEE, OVER_LIMIT_FEE, LATE_PAYMENT_FEE, RETURNED_PAYMENT_FEE, CARD_REPLACEMENT_FEE, MINIMUM_INTEREST_FEE

usages[].fees[].method

string
Required

Method, either a flat amount or a percentage.

NOTE: Currently only FLAT is 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

activation_time

datetime
Conditionally returned

Date and time when the credit account was activated on the Marqeta platform.

Allowable Values:

Format: yyyy-MM-dd’T’HH:mm:ss.Z

created_time

datetime
Returned

Date and time when the credit account was created on the Marqeta platform.

Allowable Values:

Format: yyyy-MM-dd’T’HH:mm:ss.Z

updated_time

datetime
Returned

Date and time when the credit account was last updated on the Marqeta platform.

Allowable Values:

Format: yyyy-MM-dd’T’HH:mm:ss.Z

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 credit bundle 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:

config

object
Returned

Configurations for the billing cycle day, payment due day, and fees.

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

config.card_level

string
Conditionally returned

The level of the credit card.

Allowable Values:

PREMIUM, TRADITIONAL, NA

config.fees

array of objects
Conditionally returned

List of fees associated with the credit account.

Allowable Values:

config.fees[].type

string
Conditionally returned

Type of fee.

Allowable Values:

LATE_PAYMENT_FEE, RETURNED_PAYMENT_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 the Marqeta platform.

Allowable Values:

Format: yyyy-MM-dd’T’HH:mm:ss.Z

config.fees[].updated_date

datetime
Conditionally returned

Date and time when the fee was last updated on the Marqeta platform.

Allowable Values:

Format: yyyy-MM-dd’T’HH:mm:ss.Z

config.fees[].schedule

array of objects
Conditionally returned

List of fees and when they are effective.

Allowable Values:

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

List of rewards associated with the credit account.

Allowable Values:

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: Currently only FLAT is 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

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

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.

Allowable Values:

Format: yyyy-MM-dd’T’HH:mm:ss.Z

config.min_payment.override_end_time

datetime
Conditionally returned

Date and time when the minimum payment override ends.

Allowable Values:

Format: yyyy-MM-dd’T’HH:mm:ss.Z

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

List of objects containing information on how a credit account is used and what types of balances are permitted on the account.

Allowable Values:

usages[].type

string
Returned

Type of balance.

  • PURCHASE - The balance on purchases.

Allowable Values:

PURCHASE

usages[].aprs

array of objects
Returned

List of APRs associated with the type of balance on the credit account

Allowable Values:

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 the Marqeta platform.

Allowable Values:

Format: yyyy-MM-dd’T’HH:mm:ss.Z

usages[].aprs[].updated_date

datetime
Conditionally returned

Date and time when the APR was last updated on the Marqeta platform.

Allowable Values:

Format: yyyy-MM-dd’T’HH:mm:ss.Z

usages[].aprs[].schedule

array of objects
Returned

List of objects containing information about the annual percentage rates (APRs) associated with the type of balance on the credit account and when they are effective.

Allowable Values:

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 in the Marqeta platform’s system of record 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-dd’T’HH:mm:ss.Z

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:

usages[].fees

array of objects
Conditionally returned

List of fees associated with the credit account.

Allowable Values:

usages[].fees[].type

string
Returned

Type of fee.

NOTE: Currently only RETURNED_PAYMENT_FEE and LATE_PAYMENT_FEE are supported. Do not pass other fees types.

Allowable Values:

PERIODIC_MEMBERSHIP_FEE, FOREIGN_TRANSACTION_FEE, OVER_LIMIT_FEE, LATE_PAYMENT_FEE, RETURNED_PAYMENT_FEE, CARD_REPLACEMENT_FEE, MINIMUM_INTEREST_FEE

usages[].fees[].method

string
Returned

Method, either a flat amount or a percentage.

NOTE: Currently only FLAT is 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 the credit card associated with the account.

Allowable Values:

count

integer
Optional

The number of resources to retrieve.

Allowable Values:

1–100

start_index

integer
Optional

The 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

The number of resources returned.

Allowable Values:

start_index

integer
Returned

The sort order index of the first resource in the returned array.

Allowable Values:

Any integer

end_index

integer
Returned

The 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

List of credit accounts.

Allowable Values:

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

data[].activation_time

datetime
Conditionally returned

Date and time when the credit account was activated on the Marqeta platform.

Allowable Values:

Format: yyyy-MM-dd’T’HH:mm:ss.Z

data[].created_time

datetime
Returned

Date and time when the credit account was created on the Marqeta platform.

Allowable Values:

Format: yyyy-MM-dd’T’HH:mm:ss.Z

data[].updated_time

datetime
Returned

Date and time when the credit account was last updated on the Marqeta platform.

Allowable Values:

Format: yyyy-MM-dd’T’HH:mm:ss.Z

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 credit bundle 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[].config

object
Returned

Configurations for the billing cycle day, payment due day, and fees.

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

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

List of fees associated with the credit account.

Allowable Values:

data[].config.fees[].type

string
Conditionally returned

Type of fee.

Allowable Values:

LATE_PAYMENT_FEE, RETURNED_PAYMENT_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 the Marqeta platform.

Allowable Values:

Format: yyyy-MM-dd’T’HH:mm:ss.Z

data[].config.fees[].updated_date

datetime
Conditionally returned

Date and time when the fee was last updated on the Marqeta platform.

Allowable Values:

Format: yyyy-MM-dd’T’HH:mm:ss.Z

data[].config.fees[].schedule

array of objects
Conditionally returned

List of fees and when they are effective.

Allowable Values:

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

List of rewards associated with the credit account.

Allowable Values:

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: Currently only FLAT is 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

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

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.

Allowable Values:

Format: yyyy-MM-dd’T’HH:mm:ss.Z

data[].config.min_payment.override_end_time

datetime
Conditionally returned

Date and time when the minimum payment override ends.

Allowable Values:

Format: yyyy-MM-dd’T’HH:mm:ss.Z

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

List of objects containing information on how a credit account is used and what types of balances are permitted on the account.

Allowable Values:

data[].usages[].type

string
Returned

Type of balance.

  • PURCHASE - The balance on purchases.

Allowable Values:

PURCHASE

data[].usages[].aprs

array of objects
Returned

List of APRs associated with the type of balance on the credit account

Allowable Values:

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 the Marqeta platform.

Allowable Values:

Format: yyyy-MM-dd’T’HH:mm:ss.Z

data[].usages[].aprs[].updated_date

datetime
Conditionally returned

Date and time when the APR was last updated on the Marqeta platform.

Allowable Values:

Format: yyyy-MM-dd’T’HH:mm:ss.Z

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

array of objects
Returned

List of objects containing information about the annual percentage rates (APRs) associated with the type of balance on the credit account and when they are effective.

Allowable Values:

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 in the Marqeta platform’s system of record 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-dd’T’HH:mm:ss.Z

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:

data[].usages[].fees

array of objects
Conditionally returned

List of fees associated with the credit account.

Allowable Values:

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

string
Returned

Type of fee.

NOTE: Currently only RETURNED_PAYMENT_FEE and LATE_PAYMENT_FEE are supported. Do not pass other fees types.

Allowable Values:

PERIODIC_MEMBERSHIP_FEE, FOREIGN_TRANSACTION_FEE, OVER_LIMIT_FEE, LATE_PAYMENT_FEE, RETURNED_PAYMENT_FEE, CARD_REPLACEMENT_FEE, MINIMUM_INTEREST_FEE

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

string
Returned

Method, either a flat amount or a percentage.

NOTE: Currently only FLAT is 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:

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

activation_time

datetime
Conditionally returned

Date and time when the credit account was activated on the Marqeta platform.

Allowable Values:

Format: yyyy-MM-dd’T’HH:mm:ss.Z

created_time

datetime
Returned

Date and time when the credit account was created on the Marqeta platform.

Allowable Values:

Format: yyyy-MM-dd’T’HH:mm:ss.Z

updated_time

datetime
Returned

Date and time when the credit account was last updated on the Marqeta platform.

Allowable Values:

Format: yyyy-MM-dd’T’HH:mm:ss.Z

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 credit bundle 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:

config

object
Returned

Configurations for the billing cycle day, payment due day, and fees.

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

config.card_level

string
Conditionally returned

The level of the credit card.

Allowable Values:

PREMIUM, TRADITIONAL, NA

config.fees

array of objects
Conditionally returned

List of fees associated with the credit account.

Allowable Values:

config.fees[].type

string
Conditionally returned

Type of fee.

Allowable Values:

LATE_PAYMENT_FEE, RETURNED_PAYMENT_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 the Marqeta platform.

Allowable Values:

Format: yyyy-MM-dd’T’HH:mm:ss.Z

config.fees[].updated_date

datetime
Conditionally returned

Date and time when the fee was last updated on the Marqeta platform.

Allowable Values:

Format: yyyy-MM-dd’T’HH:mm:ss.Z

config.fees[].schedule

array of objects
Conditionally returned

List of fees and when they are effective.

Allowable Values:

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

List of rewards associated with the credit account.

Allowable Values:

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: Currently only FLAT is 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

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

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.

Allowable Values:

Format: yyyy-MM-dd’T’HH:mm:ss.Z

config.min_payment.override_end_time

datetime
Conditionally returned

Date and time when the minimum payment override ends.

Allowable Values:

Format: yyyy-MM-dd’T’HH:mm:ss.Z

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

List of objects containing information on how a credit account is used and what types of balances are permitted on the account.

Allowable Values:

usages[].type

string
Returned

Type of balance.

  • PURCHASE - The balance on purchases.

Allowable Values:

PURCHASE

usages[].aprs

array of objects
Returned

List of APRs associated with the type of balance on the credit account

Allowable Values:

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 the Marqeta platform.

Allowable Values:

Format: yyyy-MM-dd’T’HH:mm:ss.Z

usages[].aprs[].updated_date

datetime
Conditionally returned

Date and time when the APR was last updated on the Marqeta platform.

Allowable Values:

Format: yyyy-MM-dd’T’HH:mm:ss.Z

usages[].aprs[].schedule

array of objects
Returned

List of objects containing information about the annual percentage rates (APRs) associated with the type of balance on the credit account and when they are effective.

Allowable Values:

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 in the Marqeta platform’s system of record 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-dd’T’HH:mm:ss.Z

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:

usages[].fees

array of objects
Conditionally returned

List of fees associated with the credit account.

Allowable Values:

usages[].fees[].type

string
Returned

Type of fee.

NOTE: Currently only RETURNED_PAYMENT_FEE and LATE_PAYMENT_FEE are supported. Do not pass other fees types.

Allowable Values:

PERIODIC_MEMBERSHIP_FEE, FOREIGN_TRANSACTION_FEE, OVER_LIMIT_FEE, LATE_PAYMENT_FEE, RETURNED_PAYMENT_FEE, CARD_REPLACEMENT_FEE, MINIMUM_INTEREST_FEE

usages[].fees[].method

string
Returned

Method, either a flat amount or a percentage.

NOTE: Currently only FLAT is 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:

Request body
Fields Description

config

object
Optional

Information on configurations for billing cycle day, payment due day, and fees.

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

config.fees

array of objects
Optional

List of fees associated with the credit account.

Allowable Values:

config.fees[].type

string
Required

Type of fee.

Allowable Values:

LATE_PAYMENT_FEE, RETURNED_PAYMENT_FEE

config.fees[].schedule

array of objects
Required

List of fees and when they are effective.

Allowable Values:

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

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

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.

Allowable Values:

Format: yyyy-MM-dd’T’HH:mm:ss.Z

config.min_payment.override_end_time

datetime
Optional

Date and time when the minimum payment override ends.

Allowable Values:

Format: yyyy-MM-dd’T’HH:mm:ss.Z

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

List of objects containing 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:

usages[].type

string
Required

Type of balance.

  • PURCHASE - The balance on purchases.

Allowable Values:

PURCHASE

usages[].aprs

array of objects
Optional

List of annual percentage rates (APRs) associated with the credit account.

Allowable Values:

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

List of objects containing information about the annual percentage rates (APRs) on the credit account and when they are effective.

Allowable Values:

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 in the Marqeta platform’s system of record 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-dd’T’HH:mm:ss.Z

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:

credit_limit

object
Optional

Information on the credit limit.

Allowable Values:

credit_limit.value

decimal
Required

Maximum balance the credit account can carry.

Allowable Values:

0–999999999999.99

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

activation_time

datetime
Conditionally returned

Date and time when the credit account was activated on the Marqeta platform.

Allowable Values:

Format: yyyy-MM-dd’T’HH:mm:ss.Z

created_time

datetime
Returned

Date and time when the credit account was created on the Marqeta platform.

Allowable Values:

Format: yyyy-MM-dd’T’HH:mm:ss.Z

updated_time

datetime
Returned

Date and time when the credit account was last updated on the Marqeta platform.

Allowable Values:

Format: yyyy-MM-dd’T’HH:mm:ss.Z

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 credit bundle 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:

config

object
Returned

Configurations for the billing cycle day, payment due day, and fees.

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

config.card_level

string
Conditionally returned

The level of the credit card.

Allowable Values:

PREMIUM, TRADITIONAL, NA

config.fees

array of objects
Conditionally returned

List of fees associated with the credit account.

Allowable Values:

config.fees[].type

string
Conditionally returned

Type of fee.

Allowable Values:

LATE_PAYMENT_FEE, RETURNED_PAYMENT_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 the Marqeta platform.

Allowable Values:

Format: yyyy-MM-dd’T’HH:mm:ss.Z

config.fees[].updated_date

datetime
Conditionally returned

Date and time when the fee was last updated on the Marqeta platform.

Allowable Values:

Format: yyyy-MM-dd’T’HH:mm:ss.Z

config.fees[].schedule

array of objects
Conditionally returned

List of fees and when they are effective.

Allowable Values:

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

List of rewards associated with the credit account.

Allowable Values:

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: Currently only FLAT is 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

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

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.

Allowable Values:

Format: yyyy-MM-dd’T’HH:mm:ss.Z

config.min_payment.override_end_time

datetime
Conditionally returned

Date and time when the minimum payment override ends.

Allowable Values:

Format: yyyy-MM-dd’T’HH:mm:ss.Z

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

List of objects containing information on how a credit account is used and what types of balances are permitted on the account.

Allowable Values:

usages[].type

string
Returned

Type of balance.

  • PURCHASE - The balance on purchases.

Allowable Values:

PURCHASE

usages[].aprs

array of objects
Returned

List of APRs associated with the type of balance on the credit account

Allowable Values:

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 the Marqeta platform.

Allowable Values:

Format: yyyy-MM-dd’T’HH:mm:ss.Z

usages[].aprs[].updated_date

datetime
Conditionally returned

Date and time when the APR was last updated on the Marqeta platform.

Allowable Values:

Format: yyyy-MM-dd’T’HH:mm:ss.Z

usages[].aprs[].schedule

array of objects
Returned

List of objects containing information about the annual percentage rates (APRs) associated with the type of balance on the credit account and when they are effective.

Allowable Values:

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 in the Marqeta platform’s system of record 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-dd’T’HH:mm:ss.Z

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:

usages[].fees

array of objects
Conditionally returned

List of fees associated with the credit account.

Allowable Values:

usages[].fees[].type

string
Returned

Type of fee.

NOTE: Currently only RETURNED_PAYMENT_FEE and LATE_PAYMENT_FEE are supported. Do not pass other fees types.

Allowable Values:

PERIODIC_MEMBERSHIP_FEE, FOREIGN_TRANSACTION_FEE, OVER_LIMIT_FEE, LATE_PAYMENT_FEE, RETURNED_PAYMENT_FEE, CARD_REPLACEMENT_FEE, MINIMUM_INTEREST_FEE

usages[].fees[].method

string
Returned

Method, either a flat amount or a percentage.

NOTE: Currently only FLAT is 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

Transition account status

Action: POST
Endpoint: /credit/accounts/{account_token}/accounttransitions

Transition a credit account to a new status.

URL path parameters
Fields Description

account_token

string
Required

The unique identifier of the credit account for which to transition a status.

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

Allowable Values:

Request body
Fields Description

status

string
Required

Status of the credit account.

Allowable Values:

UNACTIVATED, ACTIVE, SUSPENDED, TERMINATED

token

string
Optional

Unique identifier of the credit account transition.

Allowable Values:

36 char max

Sample request body
JSON
Copied

Is this helpful?

Yes
No
Response body
Fields Description

token

string
Returned

Unique identifier of the credit account transition.

Allowable Values:

36 char max

account_token

string
Returned

Unique identifier of the credit account for which to transition a status.

Allowable Values:

36 char max

original_status

string
Returned

Status of the credit account prior to transition.

Allowable Values:

UNACTIVATED, ACTIVE, SUSPENDED, TERMINATED

status

string
Returned

Status to which the credit account transitioned.

Allowable Values:

UNACTIVATED, ACTIVE, SUSPENDED, TERMINATED

created_time

datetime
Returned

Date and time when the transition record was created on the Marqeta platform.

Allowable Values:

Format: yyyy-MM-dd’T’HH:mm:ss.Z

Sample response body
JSON
Copied

Is this helpful?

Yes
No

List account transitions

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

Retrieve an array of transitions on a credit account.

This endpoint supports sorting and pagination.

URL path parameters
Fields Description

account_token

string
Required

The unique identifier of the credit account for which you want to retrieve transitions.

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

Allowable Values:

URL query parameters
Fields Description

count

integer
Optional

The number of resources to retrieve.

Allowable Values:

1–100

start_index

integer
Optional

The 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 createdTime, and not by the field names appearing in response bodies such as created_time.

Allowable Values:

createdTime, -createdTime

Response body
Fields Description

count

integer
Returned

The number of resources returned.

Allowable Values:

start_index

integer
Returned

The sort order index of the first resource in the returned array.

Allowable Values:

Any integer

end_index

integer
Returned

The sort order index of the last resource in the returned array.

Allowable Values:

Any integer

is_more

boolean
Returned

A value of true indicates that more unreturned resources exist.

Allowable Values:

true, false

data

array of objects
Returned

List of account transitions.

Allowable Values:

data[].token

string
Returned

Unique identifier of the credit account transition.

Allowable Values:

36 char max

data[].account_token

string
Returned

Unique identifier of the credit account for which to transition a status.

Allowable Values:

36 char max

data[].original_status

string
Returned

Status of the credit account prior to transition.

Allowable Values:

UNACTIVATED, ACTIVE, SUSPENDED, TERMINATED

data[].status

string
Returned

Status to which the credit account transitioned.

Allowable Values:

UNACTIVATED, ACTIVE, SUSPENDED, TERMINATED

data[].created_time

datetime
Returned

Date and time when the transition record was created on the Marqeta platform.

Allowable Values:

Format: yyyy-MM-dd’T’HH:mm:ss.Z

Sample response body
JSON
Copied

Is this helpful?

Yes
No

Retrieve account transition

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

Retrieve a transition for a credit account.

URL path parameters
Fields Description

account_token

string
Required

The unique identifier of the credit account for which you want to retrieve a transition.

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

Allowable Values:

token

string
Required

The unique identifier of the account transition you want to retrieve.

Send a GET request to /credit/accounts/{account_token}/accounttransitions to retrieve existing account transition tokens.

Allowable Values:

Response body
Fields Description

token

string
Returned

Unique identifier of the credit account transition.

Allowable Values:

36 char max

account_token

string
Returned

Unique identifier of the credit account for which to transition a status.

Allowable Values:

36 char max

original_status

string
Returned

Status of the credit account prior to transition.

Allowable Values:

UNACTIVATED, ACTIVE, SUSPENDED, TERMINATED

status

string
Returned

Status to which the credit account transitioned.

Allowable Values:

UNACTIVATED, ACTIVE, SUSPENDED, TERMINATED

created_time

datetime
Returned

Date and time when the transition record was created on the Marqeta platform.

Allowable Values:

Format: yyyy-MM-dd’T’HH:mm:ss.Z

Sample response body
JSON
Copied

Is this helpful?

Yes
No

Create account card

Action: POST
Endpoint: /credit/accounts/{account_token}/cards

Create a credit card for an existing credit account.

Note
You can ship cards to an address different from the user address. After creating a card, send a PUT request to the /cards endpoint with the new address in the fulfillment.shipping object. For more, see Update card.
URL path parameters
Fields Description

account_token

string
Required

The unique identifier of the credit account for which to create a credit card.

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

Allowable Values:

Request body
Fields Description

token

string
Optional

Unique identifier of the credit card.

Allowable Values:

36 char max

card_product_token

string
Required

Unique identifier of the associated card product.

Allowable Values:

Existing card product token

user_token

string
Required

Unique identifier of the credit cardholder.

Allowable Values:

Existing user token

reissue_pan_from_card_token

string
Optional

Reissues the specified card (known as the "source" card).

This field reissues a card by copying the PAN and PIN from the specified source card to the newly created card. The reissued card has the same PAN and PIN as the source card but a new expiration date and CVV2 number.

NOTE: By default, the source card is automatically terminated when the reissued card is activated. However, if your program is configured for multiple active cards, you can prevent the source card from being automatically terminated by setting the activation_actions.terminate_reissued_source_card field to false.

Allowable Values:

Existing card token

expiration_offset

object
Optional

Specifies the length of time after the date of issue for which the cards are valid.

If this field is not specified, the card uses the config.card_life_cycle.expiration_offset of the bulk card order or card product as appropriate.

Allowable Values:

expiration_offset.unit

string
Optional

The units for the value field.

Allowable Values:

expiration_offset.value

integer
Optional

Specifies the number of time units (as defined by the unit field in this object) that this card is valid. In other words, cards expire value x unit after the date of issue.

This number is rounded as follows:

  • YEARS - Rounds up to the last second of the last day of the month of expiration. For example, if the issue date is 1 Jan 2021 and value = 1, the cards expire on the last day of Jan 2022.

  • MONTHS - Rounds up to the last second of the last day of the month of expiration. For example, if the issue date is 1 May 2022 and value = 1, the cards expire on the last day of June 2022.

  • DAYS - Rounds up to the last second of the day of expiration.

  • HOURS, MINUTES, SECONDS - No rounding.

Allowable Values:

translate_pin_from_card_token

string
Optional

Copies the PIN from the specified card to the newly created card.

Both cards must belong to the same user. This field is not allowed if reissue_pan_from_card_token is set.

Send a GET request to /cards/user/{token} to retrieve card tokens for a particular user.

Allowable Values:

Existing card token

activation_actions

object
Optional

Information on actions that can be performed when a card is activated.

Allowable Values:

activation_actions.terminate_reissued_source_card

boolean
Optional

If you are reissuing a card, the source card is terminated by default. To prevent the source card from being terminated, set this field to false.

Only relevant when reissue_pan_from_card_token is set.

Allowable Values:

true, false

Default value:
true

activation_actions.swap_digital_wallet_tokens_from_card_token

string
Optional

Token of the card from which to move digital wallet tokens. All digital wallet tokens are move from the card specified in this field to the new card.

Not relevant when reissue_pan_from_card_token is set.

Send a GET request to /cards/user/{token} to retrieve card tokens for a particular user.

Allowable Values:

Existing card token

Sample request body
JSON
Copied

Is this helpful?

Yes
No
Response body
Fields Description

token

string
Returned

Unique identifier of the credit card.

Allowable Values:

36 char max

account_token

string
Returned

Unique identifier of the associated credit account.

Allowable Values:

36 char max

Existing credit account token

user_token

string
Returned

Unique identifier of the credit cardholder.

Allowable Values:

Existing user token

created_time

datetime
Returned

Date and time when the card was created on the Marqeta platform.

Allowable Values:

Format: yyyy-MM-dd’T’HH:mm:ss.Z

updated_time

datetime
Returned

Date and time when the card was last modified on the Marqeta platform.

Allowable Values:

Format: yyyy-MM-dd’T’HH:mm:ss.Z

Sample response body
JSON
Copied

Is this helpful?

Yes
No

List account cards

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

Retrieve an array of cards for a credit account.

This endpoint supports sorting and pagination.

URL path parameters
Fields Description

account_token

string
Required

The unique identifier of the credit account for which to retrieve credit cards.

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

Allowable Values:

URL query parameters
Fields Description

status

string
Optional

The status of the credit cards to return.

Allowable Values:

count

integer
Optional

The number of resources to retrieve.

Allowable Values:

1–100

start_index

integer
Optional

The 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

The number of resources returned.

Allowable Values:

start_index

integer
Returned

The sort order index of the first resource in the returned array.

Allowable Values:

Any integer

end_index

integer
Returned

The sort order index of the last resource in the returned array.

Allowable Values:

Any integer

is_more

boolean
Returned

A value of true indicates that more unreturned resources exist.

Allowable Values:

true, false

data

array of objects
Returned

List of credit cards.

Allowable Values:

data[].token

string
Returned

Unique identifier of the credit card.

Allowable Values:

36 char max

data[].account_token

string
Returned

Unique identifier of the associated credit account.

Allowable Values:

36 char max

Existing credit account token

data[].user_token

string
Returned

Unique identifier of the credit cardholder.

Allowable Values:

Existing user token

data[].created_time

datetime
Returned

Date and time when the card was created on the Marqeta platform.

Allowable Values:

Format: yyyy-MM-dd’T’HH:mm:ss.Z

data[].updated_time

datetime
Returned

Date and time when the card was last modified on the Marqeta platform.

Allowable Values:

Format: yyyy-MM-dd’T’HH:mm:ss.Z

Sample response body
JSON
Copied

Is this helpful?

Yes
No

Retrieve account card

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

Retrieve a credit card for a credit account.

URL path parameters
Fields Description

account_token

string
Required

The unique identifier of the credit account for which to retrieve a credit card.

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

Allowable Values:

card_token

string
Required

The unique identifier of the credit card to retrieve.

Send a GET request to /credit/accounts/{account_token}/cards to retrieve existing credit card tokens.

Allowable Values:

Response body
Fields Description

token

string
Returned

Unique identifier of the credit card.

Allowable Values:

36 char max

account_token

string
Returned

Unique identifier of the associated credit account.

Allowable Values:

36 char max

Existing credit account token

user_token

string
Returned

Unique identifier of the credit cardholder.

Allowable Values:

Existing user token

created_time

datetime
Returned

Date and time when the card was created on the Marqeta platform.

Allowable Values:

Format: yyyy-MM-dd’T’HH:mm:ss.Z

updated_time

datetime
Returned

Date and time when the card was last modified on the Marqeta platform.

Allowable Values:

Format: yyyy-MM-dd’T’HH:mm:ss.Z

Sample response body
JSON
Copied

Is this helpful?

Yes
No

List account journal entries

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

Retrieve an array of journal entries on a credit account.

This endpoint supports sorting and pagination and object expansion.

URL path parameters
Fields Description

account_token

string
Required

The unique identifier of the credit account for which you want to retrieve journal entries.

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

Allowable Values:

Existing account token

URL query parameters
Fields Description

count

integer
Optional

The number of resources to retrieve.

Allowable Values:

1–100

start_index

integer
Optional

The sort order index of the first resource in the returned array.

Allowable Values:

0 min

Any integer

start_date

string
Optional

The starting date of the date range from which to return journal entries.

Allowable Values:

Format: yyyy-MM-dd or yyyy-MM-ddTHH:mm:ss.SS

end_date

string
Optional

The ending date of the date range from which to return journal entries.

Allowable Values:

Format: yyyy-MM-dd or yyyy-MM-ddTHH:mm:ss.SS

statuses

array of strings
Optional

List of journal entry statuses to return.

Allowable Values:

POSTED, PENDING

groups

array of strings
Optional

List of journal entry groups to return.

To return all journal entry groups, do not include this query parameter.

Allowable Values:

PURCHASE, ORIGINAL_CREDIT, FEE, BALANCE_REFUND, PAYMENT, INTEREST, DISPUTE, REFUND, ADJUSTMENT, REWARD

expand

string
Optional

Embeds the specified object into the response.

Allowable Values:

detailObject

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 createdTime, and not by the field names appearing in response bodies such as created_time.

Allowable Values:

createdTime, -createdTime, impactTime, -impactTime

card_tokens

array of strings
Optional

List of credit card tokens. Returns journal entries associated with the specified card tokens.

Send a GET request to /credit/accounts/{account_token}/cards/ to retrieve existing card tokens.

Allowable Values:

Existing card token

user_tokens

array of strings
Optional

List of user tokens. Returns journal entries associated with the specified user tokens.

Send a GET request to /users to retrieve existing user tokens.

Allowable Values:

Existing user token

types

array of strings
Optional

List of journal entry event types to return.

To return all event types, do not include this query parameter.

Allowable Values:

authorization, authorization.advice, authorization.incremental, authorization.reversal, authorization.reversal.issuerexpiration, authorization.clearing, refund, refund.authorization, refund.authorization.advice, refund.authorization.reversal, refund.authorization.clearing, refund.authorization.reversal.issuerexpiration, originalcredit.authorization, originalcredit.authorization.clearing, originalcredit.authorization.reversal, originalcredit.authpluscapture, originalcredit.authpluscapture.reversal, originalcredit.authorization.reversal.issuerexpiration, account.balancerefund, account.reward.cashback, account.reward.auto.cashback, account.reward.auto.cashback.reversal, account.payment, account.payment.completed, account.payment.returned, account.payment.canceled, account.payment.refunded, account.payment.completed.hold.released, account.payment.completed.hold, account.interest, account.fee.payment.late, account.fee.payment.returned, account.fee.interest.minimum, account.dispute, account.dispute.reversal, account.dispute.won, account.dispute.lost, account.dispute.lost.graceperiod, account.adjustment, account.adjustment.purchase, account.adjustment.fee, account.adjustment.interest, account.adjustment.reward

Response body
Fields Description

count

integer
Returned

The number of resources returned.

Allowable Values:

1–100

start_index

integer
Returned

The sort order index of the first resource in the returned array.

Allowable Values:

Any integer

end_index

integer
Returned

The sort order index of the last resource in the returned array.

Allowable Values:

Any integer

is_more

boolean
Returned

A value of true indicates that more unreturned resources exist.

Allowable Values:

true, false

data

array of objects
Returned

List of journal entries.

Allowable Values:

Existing data object

data[].token

string
Returned

Unique identifier of the journal entry.

Allowable Values:

36 char max

data[].related_token

string
Conditionally returned

Unique identifier of the original journal entry. If the current journal entry is the original, this field is returned empty.

Allowable Values:

Existing journal entry token

data[].root_token

string
Conditionally returned

Unique identifier of the root journal entry. If the current journal entry is the root, this field is returned empty.

Allowable Values:

Existing journal entry token

data[].account_token

string
Returned

Unique identifier of the credit account associated with the credit card used to make the journal entry.

Allowable Values:

Existing credit account token

data[].card_token

string
Returned

Unique identifier of the credit card used to make the journal entry.

Allowable Values:

8–36 chars

Existing credit card token

data[].user_token

string
Returned

Unique identifier of the credit user.

Allowable Values:

Existing user token

data[].status

string
Returned

Current status of the journal entry.

NOTE: CLEARED, DECLINED, and ERROR can appear in journal entry webhooks for purchases, OCTs, and refunds only.

Allowable Values:

PENDING, POSTED, DECLINED, ERROR, CLEARED

data[].group

string
Returned

Group to which the journal entry belongs.

Allowable Values:

PURCHASE, REFUND, DISPUTE, ORIGINAL_CREDIT, INTERNAL, FEE, REWARD, INTEREST, PAYMENT, ADJUSTMENT, BALANCE_TRANSFER, CASH_ADVANCE, BALANCE_REFUND

data[].type

string
Returned

The journal entry event type.

Allowable Values:

data[].id

string
Returned

Eight-digit numeric identifier of the journal entry, an alternate identifier to the UUID that’s useful for remembering and referencing.

Allowable Values:

8 chars

data[].amount

decimal
Returned

Amount of the journal entry.

Allowable Values:

Any decimal

data[].currency_code

string
Returned

A valid three-digit ISO 4217 currency code

Allowable Values:

USD

data[].memo

string
Returned

Merchant name or description for the journal entry.

Allowable Values:

Example: Whole Foods Market

data[].request_time

datetime
Returned

For purchases, the date and time of the authorization, which is when the user initiates the journal entry.

For other journal entry types, equivalent to impact_time.

Allowable Values:

Format: yyyy-MM-dd’T’HH:mm:ss.Z

data[].impact_time

datetime
Returned

Date and time when the journal entry impacts the account balance.

For purchases, this is the time of the authorization.

For purchase authorization clearings, this is the time when the transaction is settled.

Allowable Values:

Format: yyyy-MM-dd’T’HH:mm:ss.Z

data[].created_time

datetime
Returned

Date and time when the journal entry was created on the Marqeta platform.

For purchases, this is the time of the authorization.

For purchase authorization clearings, this is the time when the transaction is settled.

Allowable Values:

Format: yyyy-MM-dd’T’HH:mm:ss.Z

data[].dispute_token

string
Conditionally returned

Unique identifier of the dispute, if the journal entry is disputed.

Allowable Values:

Existing dispute token

data[].detail_token

string
Returned

Unique identifier of the journal entry’s full details.

Allowable Values:

36 char max

data[].detail_object

object
Conditionally returned

Contains the journal entry’s full details. The fields returned in this object vary based on the journal entry type.

The following lists each journal entry type and the specific fields returned for each type.

Allowable Values:

Existing detail object

data[].detail_object.token

string
Conditionally returned

Unique identifier of the interest charge or fee.

If in the detail_object, unique identifier of the detail object.

Returned for interest or fee journal entries only.

Allowable Values:

36 char max

data[].detail_object.account_token

string
Conditionally returned

Unique identifier of the credit account on which the interest or fee was charged.

Returned for interest or fee journal entries only.

Allowable Values:

36 char max

Existing credit account token

data[].detail_object.type

string
Conditionally returned

Type of fee.

Returned for fee journal entries only.

Allowable Values:

PERIODIC_MEMBERSHIP_FEE, FOREIGN_TRANSACTION_FEE, OVER_LIMIT_FEE, LATE_PAYMENT_FEE, RETURNED_PAYMENT_FEE, CARD_REPLACEMENT_FEE, MINIMUM_INTEREST_FEE

data[].detail_object.method

string
Conditionally returned

Method used to calculate the fee value.

Returned for fee journal entries only.

Allowable Values:

PERCENTAGE, FLAT

data[].detail_object.value

decimal
Conditionally returned

Value of the fee configured on the account.

Equivalent to config.fees.schedule.value on the credit account. Send a GET request to /credit/accounts/{account_token} to retrieve an existing credit account.

Returned for fee journal entries only.

Allowable Values:

data[].detail_object.currency_code

string
Conditionally returned

A valid three-digit ISO 4217 currency code

Allowable Values:

USD

data[].detail_object.amount

decimal
Conditionally returned

Amount of the fee.

Returned for fee journal entries only.

Allowable Values:

data[].detail_object.applied_to_amount

decimal
Conditionally returned

The total amount to which a percentage fee method is applied (for example, if a 3% fee is applied to 100, then 100 is the applied_to_amount value).

This field is not applicable for a flat fee method.

Returned for fee journal entries only.

NOTE: This field is currently not supported and returns null.

Allowable Values:

data[].detail_object.description

string
Conditionally returned

Description of the fee.

Returned for fee journal entries only.

Allowable Values:

data[].detail_object.created

datetime
Conditionally returned

Date and time when the fee was created.

Returned for fee journal entries only.

Allowable Values:

Format: yyyy-MM-dd’T’HH:mm:ss.Z

data[].detail_object.statement_token

string
Conditionally returned

Unique identifier of the statement summary from which you want to retrieve interest details.

Returned for interest journal entries only.

Allowable Values:

Existing statement summary token

data[].detail_object.statement_opening_date

datetime
Conditionally returned

Opening date of the statement summary from which you want to retrieve interest details.

Returned for interest journal entries only.

Allowable Values:

data[].detail_object.statement_closing_date

datetime
Conditionally returned

Closing date of the statement summary from which you want to retrieve interest details.

Returned for interest journal entries only.

Allowable Values:

data[].detail_object.statement_balance

decimal
Conditionally returned

Balance on the statement summary from which you want to retrieve interest details.

Returned for interest journal entries only.

Allowable Values:

data[].detail_object.average_daily_balance

decimal
Conditionally returned

Average daily balance used to calculate interest.

Returned for interest journal entries only.

Allowable Values:

data[].detail_object.goto_apr

decimal
Conditionally returned

Annual percentage rate.

Returned for interest journal entries only.

Allowable Values:

0–100

data[].detail_object.daily_periodic_rate

decimal
Conditionally returned

Daily rate used to calculate interest.

Returned for interest journal entries only.

Allowable Values:

0–100

data[].detail_object.days_in_billing_cycle

integer
Conditionally returned

Number of days in the billing cycle.

Returned for interest journal entries only.

Allowable Values:

1–31

data[].detail_object.interest_amount

decimal
Conditionally returned

Amount of interest calculated for the billing period.

Returned for interest journal entries only.

Allowable Values:

data[].detail_object.created_date

datetime
Conditionally returned

Date and time when the journal entry was created.

Allowable Values:

Format: yyyy-MM-dd’T’HH:mm:ss.Z

data[].detail_object.updated_date

datetime
Conditionally returned

Date and time when the journal entry was last updated.

Allowable Values:

Format: yyyy-MM-dd’T’HH:mm:ss.Z

Sample response body
JSON
Copied

Is this helpful?

Yes
No

Retrieve account journal entry

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

Retrieve a journal entry for a credit account.

URL path parameters
Fields Description

account_token

string
Required

The unique identifier of the credit account for which you want to retrieve journal entries.

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

Allowable Values:

Existing account token

journal_entry_token

string
Required

The unique identifier of the journal entry you want to retrieve.

Send a GET request to /credit/accounts/{account_token}/journalentries to retrieve existing journal entry tokens.

Allowable Values:

Existing journal entry token

Response body
Fields Description

token

string
Returned

Unique identifier of the journal entry.

Allowable Values:

36 char max

related_token

string
Conditionally returned

Unique identifier of the original journal entry. If the current journal entry is the original, this field is returned empty.

Allowable Values:

Existing journal entry token

root_token

string
Conditionally returned

Unique identifier of the root journal entry. If the current journal entry is the root, this field is returned empty.

Allowable Values:

Existing journal entry token

account_token

string
Returned

Unique identifier of the credit account associated with the credit card used to make the journal entry.

Allowable Values:

Existing credit account token

card_token

string
Returned

Unique identifier of the credit card used to make the journal entry.

Allowable Values:

8–36 chars

Existing credit card token

user_token

string
Returned

Unique identifier of the credit user.

Allowable Values:

Existing user token

status

string
Returned

Current status of the journal entry.

NOTE: CLEARED, DECLINED, and ERROR can appear in journal entry webhooks for purchases, OCTs, and refunds only.

Allowable Values:

PENDING, POSTED, DECLINED, ERROR, CLEARED

group

string
Returned

Group to which the journal entry belongs.

Allowable Values:

PURCHASE, REFUND, DISPUTE, ORIGINAL_CREDIT, INTERNAL, FEE, REWARD, INTEREST, PAYMENT, ADJUSTMENT, BALANCE_TRANSFER, CASH_ADVANCE, BALANCE_REFUND

type

string
Returned

The journal entry event type.

Allowable Values:

id

string
Returned

Eight-digit numeric identifier of the journal entry, an alternate identifier to the UUID that’s useful for remembering and referencing.

Allowable Values:

8 chars

amount

decimal
Returned

Amount of the journal entry.

Allowable Values:

Any decimal

currency_code

string
Returned

A valid three-digit ISO 4217 currency code

Allowable Values:

USD

memo

string
Returned

Merchant name or description for the journal entry.

Allowable Values:

Example: Whole Foods Market

request_time

datetime
Returned

For purchases, the date and time of the authorization, which is when the user initiates the journal entry.

For other journal entry types, equivalent to impact_time.

Allowable Values:

Format: yyyy-MM-dd’T’HH:mm:ss.Z

impact_time

datetime
Returned

Date and time when the journal entry impacts the account balance.

For purchases, this is the time of the authorization.

For purchase authorization clearings, this is the time when the transaction is settled.

Allowable Values:

Format: yyyy-MM-dd’T’HH:mm:ss.Z

created_time

datetime
Returned

Date and time when the journal entry was created on the Marqeta platform.

For purchases, this is the time of the authorization.

For purchase authorization clearings, this is the time when the transaction is settled.

Allowable Values:

Format: yyyy-MM-dd’T’HH:mm:ss.Z

dispute_token

string
Conditionally returned

Unique identifier of the dispute, if the journal entry is disputed.

Allowable Values:

Existing dispute token

detail_token

string
Returned

Unique identifier of the journal entry’s full details.

Allowable Values:

36 char max

detail_object

object
Conditionally returned

Contains the journal entry’s full details. The fields returned in this object vary based on the journal entry type.

The following lists each journal entry type and the specific fields returned for each type.

Allowable Values:

Existing detail object

detail_object.token

string
Conditionally returned

Unique identifier of the interest charge or fee.

If in the detail_object, unique identifier of the detail object.

Returned for interest or fee journal entries only.

Allowable Values:

36 char max

detail_object.account_token

string
Conditionally returned

Unique identifier of the credit account on which the interest or fee was charged.

Returned for interest or fee journal entries only.

Allowable Values:

36 char max

Existing credit account token

detail_object.type

string
Conditionally returned

Type of fee.

Returned for fee journal entries only.

Allowable Values:

PERIODIC_MEMBERSHIP_FEE, FOREIGN_TRANSACTION_FEE, OVER_LIMIT_FEE, LATE_PAYMENT_FEE, RETURNED_PAYMENT_FEE, CARD_REPLACEMENT_FEE, MINIMUM_INTEREST_FEE

detail_object.method

string
Conditionally returned

Method used to calculate the fee value.

Returned for fee journal entries only.

Allowable Values:

PERCENTAGE, FLAT

detail_object.value

decimal
Conditionally returned

Value of the fee configured on the account.

Equivalent to config.fees.schedule.value on the credit account. Send a GET request to /credit/accounts/{account_token} to retrieve an existing credit account.

Returned for fee journal entries only.

Allowable Values:

detail_object.currency_code

string
Conditionally returned

A valid three-digit ISO 4217 currency code

Allowable Values:

USD

detail_object.amount

decimal
Conditionally returned

Amount of the fee.

Returned for fee journal entries only.

Allowable Values:

detail_object.applied_to_amount

decimal
Conditionally returned

The total amount to which a percentage fee method is applied (for example, if a 3% fee is applied to 100, then 100 is the applied_to_amount value).

This field is not applicable for a flat fee method.

Returned for fee journal entries only.

NOTE: This field is currently not supported and returns null.

Allowable Values:

detail_object.description

string
Conditionally returned

Description of the fee.

Returned for fee journal entries only.

Allowable Values:

detail_object.created

datetime
Conditionally returned

Date and time when the fee was created.

Returned for fee journal entries only.

Allowable Values:

Format: yyyy-MM-dd’T’HH:mm:ss.Z

detail_object.statement_token

string
Conditionally returned

Unique identifier of the statement summary from which you want to retrieve interest details.

Returned for interest journal entries only.

Allowable Values:

Existing statement summary token

detail_object.statement_opening_date

datetime
Conditionally returned

Opening date of the statement summary from which you want to retrieve interest details.

Returned for interest journal entries only.

Allowable Values:

detail_object.statement_closing_date

datetime
Conditionally returned

Closing date of the statement summary from which you want to retrieve interest details.

Returned for interest journal entries only.

Allowable Values:

detail_object.statement_balance

decimal
Conditionally returned

Balance on the statement summary from which you want to retrieve interest details.

Returned for interest journal entries only.

Allowable Values:

detail_object.average_daily_balance

decimal
Conditionally returned

Average daily balance used to calculate interest.

Returned for interest journal entries only.

Allowable Values:

detail_object.goto_apr

decimal
Conditionally returned

Annual percentage rate.

Returned for interest journal entries only.

Allowable Values:

0–100

detail_object.daily_periodic_rate

decimal
Conditionally returned

Daily rate used to calculate interest.

Returned for interest journal entries only.

Allowable Values:

0–100

detail_object.days_in_billing_cycle

integer
Conditionally returned

Number of days in the billing cycle.

Returned for interest journal entries only.

Allowable Values:

1–31

detail_object.interest_amount

decimal
Conditionally returned

Amount of interest calculated for the billing period.

Returned for interest journal entries only.

Allowable Values:

detail_object.created_date

datetime
Conditionally returned

Date and time when the journal entry was created.

Allowable Values:

Format: yyyy-MM-dd’T’HH:mm:ss.Z

detail_object.updated_date

datetime
Conditionally returned

Date and time when the journal entry was last updated.

Allowable Values:

Format: yyyy-MM-dd’T’HH:mm:ss.Z

Sample response body

The following code block shows a sample purchase journal entry.

JSON
Copied

Is this helpful?

Yes
No

The following code block shows a sample interest journal entry.

JSON
Copied

Is this helpful?

Yes
No

The following code block shows a sample fee journal entry.

JSON
Copied

Is this helpful?

Yes
No

Create account adjustment

Action: POST
Endpoint: /credit/accounts/{account_token}/adjustments

Create an adjustment for an existing credit account.

URL path parameters
Fields Description

account_token

string
Required

The unique identifier of the credit account for which you want to create an adjustment.

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

Allowable Values:

Request body
Fields Description

token

string
Optional

Unique identifier of the adjustment.

Allowable Values:

36 char max

original_ledger_entry_token

uuid
Optional

Unique identifier of the original journal entry needing the adjustment.

Required when adjusting an existing journal entry.

Allowable Values:

Existing journal entry token

external_adjustment_id

uuid
Optional

Unique identifier you provide of an associated external adjustment that exists outside the Marqeta platform.

Allowable Values:

amount

decimal
Required

Amount of the adjustment.

Value must be negative if original_ledger_entry_token is not passed.

Allowable Values:

1000000 max

currency_code

string
Required

A valid three-digit ISO 4217 currency code

Allowable Values:

USD

description

string
Required

Description of the adjustment.

Allowable Values:

1 char min

note

string
Optional

Additional information on the adjustment.

Allowable Values:

reason

string
Optional

Reason for the adjustment.

  • DISPUTE - The adjustment occurred because a dispute was initiated.

  • DISPUTE_RESOLUTION - The adjustment occurred because of the result of a dispute resolution.

  • RETURNED_OR_CANCELED_PAYMENT - The adjustment occurred because a payment was returned or canceled.

  • OTHER - Any other reason the adjustment occurred. For example, a waived fee or account write-off.

Allowable Values:

DISPUTE, DISPUTE_RESOLUTION, RETURNED_OR_CANCELED_PAYMENT, OTHER

Sample request body
JSON
Copied

Is this helpful?

Yes
No
Response body
Fields Description

token

string
Returned

Unique identifier of the adjustment.

If in the detail_object, unique identifier of the detail object.

Allowable Values:

36 char max

account_token

string
Returned

Unique identifier of the credit account on which the adjustment was made.

Allowable Values:

36 char max

Existing credit account token

type

string
Returned

Type of adjustment.

The adjustment is made on its correlating amount (for example, purchase adjustments are made on purchase amounts). You can use general adjustments for standalone adjustments made on the credit account balance itself, which includes account write-offs, credits, and more.

Allowable Values:

PURCHASE, FEE, REWARD, INTEREST, GENERAL

original_ledger_entry_token

uuid
Conditionally returned

Unique identifier of the original journal entry needing the adjustment.

Allowable Values:

Existing journal entry token

external_adjustment_id

uuid
Conditionally returned

Unique identifier you provide of an associated external adjustment that exists outside the Marqeta platform.

Allowable Values:

detail_token

string
Conditionally returned

Unique identifier of the adjustment detail. For example, the token of the dispute, the interest charge, or the returned payment that prompted the adjustment.

Returned when the system automatically applies an adjustment.

Allowable Values:

36 char max

adjustment_detail_object

object
Conditionally returned

Contains the adjustment’s full details.

The fields returned in this object depend on the adjustment type.

Interest returns interest details. For the specific fields returned, see the detail_object fields marked "Returned for interest journal entries" in the account journal entry response fields.

Disputes return dispute details. For the specific fields returned, see the dispute response fields.

Allowable Values:

related_detail_token

string
Conditionally returned

Unique identifier of the dispute or returned payment that prompted the interest adjustment.

This field is returned for interest adjustments only.

Allowable Values:

36 char max

related_detail_object

object
Conditionally returned

Contains full details of the related dispute or returned payment.

The fields returned in this object depend on whether a dispute or returned payment led to the interest adjustment. A dispute returns dispute details; a returned payment returns payment details.

For more on the dispute details returned, see the dispute response fields.

For more on the returned payment details returned, see the payment response fields.

This field is returned for interest adjustments only.

Allowable Values:

amount

decimal
Returned

Amount of the adjustment.

Allowable Values:

currency_code

string
Returned

A valid three-digit ISO 4217 currency code

Allowable Values:

USD

description

string
Returned

Description of the adjustment.

Allowable Values:

1 char min

note

string
Conditionally returned

Additional information on the adjustment.

Allowable Values:

reason

string
Returned

Reason for the adjustment.

  • DISPUTE - The adjustment occurred because a dispute was initiated.

  • DISPUTE_RESOLUTION - The adjustment occurred because of the result of a dispute resolution.

  • RETURNED_OR_CANCELED_PAYMENT - The adjustment occurred because a payment was returned or canceled.

  • OTHER - Any other reason the adjustment occurred. For example, a waived fee.

Allowable Values:

DISPUTE, DISPUTE_RESOLUTION, RETURNED_OR_CANCELED_PAYMENT, OTHER

Sample response body
JSON
Copied

Is this helpful?

Yes
No

List account adjustments

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

Retrieve an array of adjustments for a credit account.

This endpoint supports pagination.

URL path parameters
Fields Description

account_token

string
Required

The unique identifier of the credit account for which you want to retrieve adjustments.

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

Allowable Values:

URL query parameters
Fields Description

count

integer
Optional

The number of resources to retrieve

Allowable Values:

1–100

start_index

integer
Optional

The sort order index of the first resource in the returned array.

Allowable Values:

0 min

Response body
Fields Description

count

integer
Returned

The number of resources returned.

Allowable Values:

start_index

integer
Returned

The sort order index of the first resource in the returned array.

Allowable Values:

Any integer

end_index

integer
Returned

The