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
Copy section link
Action: POST
Endpoint: /credit/accounts
Create a new credit account.
Request body
Copy section link
| Fields | Description |
|---|---|
token
string
|
Unique identifier of the credit account. Allowable Values: 36 char max |
name
string
|
Name of the credit account. Allowable Values: |
description
string
|
Description for the credit account. Allowable Values: Any string |
bundle_token
string
|
Unique identifier of the associated credit bundle. You must pass either Allowable Values: Existing credit bundle token |
credit_product_token
string
|
Unique identifier of the associated credit product. This field is required if passing You must pass either both Allowable Values: Existing credit product token |
user_token
string
|
Unique identifier of the primary account holder. Allowable Values: Existing user token |
application_token
string
|
Unique identifier of the associated credit account application. Allowable Values: 36 char max |
external_offer_id
string
|
Unique identifier you provide of the associated external credit offer. This field is required if passing You must pass either both Allowable Values: Your credit offer ID. |
credit_limit
decimal
|
Maximum balance the credit account can carry. Allowable Values: 0–1000000 |
config
object
|
Configurations for the billing cycle day, payment due day, and fees. Allowable Values: |
config.billing_cycle_day
integer
|
Day of month the billing cycle starts. Allowable Values: 1 |
config.payment_due_day
integer
|
Day of month the payment for the previous billing cycle is due. Allowable Values: 31 |
config.e_disclosure_active
boolean
|
A value of Allowable Values:
|
config.card_level
string
|
The level of the credit card. Allowable Values:
|
config.fees
array of objects
|
List of fees associated with the credit account. Allowable Values: |
config.fees[].type
string
|
Type of fee. Allowable Values:
|
config.fees[].schedule
array of objects
|
List of fees and when they are effective. Allowable Values: |
config.fees[].schedule[].method
string
|
Method used to calculate the fee value. Allowable Values:
|
config.fees[].schedule[].value
decimal
|
Amount of the fee. Allowable Values: 0–9999.9999 |
config.fees[].schedule[].effective_date
datetime
|
Date the fee becomes effective. Allowable Values: |
config.rewards
array of objects
|
List of rewards associated with the credit account. Allowable Values: |
config.rewards[].type
string
|
Type of reward. Allowable Values:
|
config.rewards[].method
string
|
Method, either a flat amount or a percentage. NOTE:
Currently only Allowable Values:
|
config.rewards[].value
decimal
|
Value of the reward, either a flat reward amount or percentage value. Allowable Values: 0–100 |
config.payment_holds
object
|
Configurations for a payment hold. Allowable Values: |
config.payment_holds.ach_hold_days
integer
|
Number of days to hold an ACH payment. Allowable Values: 0–7 |
config.payment_holds.check_hold_days
integer
|
Number of days to hold a check payment. Allowable Values: 0–7 |
usages
array of objects
|
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 Allowable Values: |
usages[].type
string
|
Type of balance.
Allowable Values:
|
usages[].aprs
array of objects
|
List of annual percentage rates (APRs) associated with the type of balance on the credit account. Allowable Values: |
usages[].aprs[].type
string
|
Type of APR.
Allowable Values:
|
usages[].aprs[].schedule
array of objects
|
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
|
Indicates whether the APR value is fixed or variable. Allowable Values:
|
usages[].aprs[].schedule[].value
decimal
|
Percentage value of the APR. If the APR type is When backdating an APR, this value cannot be greater than the value of the effective APR on the backdated date. Allowable Values: 0–100 |
usages[].aprs[].schedule[].margin
decimal
|
The number of percentage points added to the prime rate, used to calculate a variable value. Used for variable values only. Allowable Values: |
usages[].fees
array of objects
|
List of fees associated with the credit account. Allowable Values: |
usages[].fees[].type
string
|
Type of fee. NOTE:
Currently only Allowable Values:
|
usages[].fees[].method
string
|
Method, either a flat amount or a percentage. NOTE:
Currently only Allowable Values:
|
usages[].fees[].value
decimal
|
Value of the fee, either a flat fee amount or percentage value. Allowable Values: 0–9999.9999 |
Response body
Copy section link
| Fields | Description |
|---|---|
token
string
|
Unique identifier of the credit account. Allowable Values: 36 char max |
name
string
|
Name of the credit account. Allowable Values: |
description
string
|
Description for the credit account. Allowable Values: Any string |
currency_code
string
|
A valid three-digit ISO 4217 currency code Allowable Values:
|
status
string
|
Status of the credit account. Allowable Values:
|
activation_time
datetime
|
Date and time when the credit account was activated on the Marqeta platform. Allowable Values: Format: yyyy-MM-dd’T’HH:mm:ss.Z |
created_time
datetime
|
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
|
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
|
Type of credit account. Allowable Values:
|
bundle_token
string
|
Unique identifier of the associated bundle product. Allowable Values: Existing credit bundle token |
credit_product_token
string
|
Unique identifier of the associated credit product. Allowable Values: Existing credit product token |
user_token
string
|
Unique identifier of the primary account holder. Allowable Values: Existing user token |
external_offer_id
string
|
Unique identifier you provide of the associated external credit offer. Allowable Values: Your external offer ID. |
credit_limit
decimal
|
Maximum balance the credit account can carry. Allowable Values: 0–1000000 |
current_balance
decimal
|
Current purchase balance on the credit account. Allowable Values: |
available_credit
decimal
|
Amount of credit available for use on the credit account. Allowable Values: |
remaining_statement_balance
decimal
|
Amount remaining on the latest statement’s balance, after it’s adjusted for payments, returned payments, and applicable credits that occurred after the latest statement’s closing date. Allowable Values: |
remaining_min_payment_due
decimal
|
Amount remaining on the latest statement’s minimum payment, after it’s adjusted for payments, returned payments, and applicable credits that occurred after the latest statement’s closing date. Allowable Values: |
config
object
|
Configurations for the billing cycle day, payment due day, and fees. Allowable Values: |
config.billing_cycle_day
integer
|
Day of month the billing cycle starts. Allowable Values: 1 |
config.payment_due_day
integer
|
Day of month the payment for the previous billing cycle is due. Allowable Values: 31 |
config.e_disclosure_active
boolean
|
A value of Allowable Values:
|
config.card_level
string
|
The level of the credit card. Allowable Values:
|
config.fees
array of objects
|
List of fees associated with the credit account. Allowable Values: |
config.fees[].type
string
|
Type of fee. Allowable Values:
|
config.fees[].active
boolean
|
Whether the fee is active. Allowable Values: |
config.fees[].created_date
datetime
|
Date and time when the fee was created on the Marqeta platform. Allowable Values: Format: yyyy-MM-dd’T’HH:mm:ss.Z |
config.fees[].updated_date
datetime
|
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
|
List of fees and when they are effective. Allowable Values: |
config.fees[].schedule[].method
string
|
Method used to calculate the fee value. Allowable Values:
|
config.fees[].schedule[].value
decimal
|
Amount of the fee. Allowable Values: 0–9999.9999 |
config.fees[].schedule[].effective_date
datetime
|
Date the fee becomes effective. Allowable Values: |
config.rewards
array of objects
|
List of rewards associated with the credit account. Allowable Values: |
config.rewards[].type
string
|
Type of reward. Allowable Values:
|
config.rewards[].method
string
|
Method, either a flat amount or a percentage. NOTE:
Currently only Allowable Values:
|
config.rewards[].value
decimal
|
Value of the reward, either a flat reward amount or percentage value. Allowable Values: 0–100 |
config.payment_holds
object
|
Configurations for a payment hold. Allowable Values: |
config.payment_holds.ach_hold_days
integer
|
Number of days to hold an ACH payment. Allowable Values: 0–7 |
config.payment_holds.check_hold_days
integer
|
Number of days to hold a check payment. Allowable Values: 0–7 |
config.min_payment
object
|
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
|
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
|
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
|
Flat amount of the minimum payment override. Allowable Values: 0 min |
config.min_payment.min_payment_percentage
decimal
|
Percentage of the total statement balance used to calculate the minimum payment override amount. Allowable Values: 0 min |
config.min_payment.active
boolean
|
Whether the minimum payment override is currently active. Allowable Values: |
usages
array of objects
|
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
|
Type of balance.
Allowable Values:
|
usages[].aprs
array of objects
|
List of APRs associated with the type of balance on the credit account Allowable Values: |
usages[].aprs[].type
string
|
Type of APR.
Allowable Values:
|
usages[].aprs[].active
boolean
|
Whether the APR is active. Allowable Values: |
usages[].aprs[].created_date
datetime
|
Date and time when the APR was created on the Marqeta platform. Allowable Values: Format: yyyy-MM-dd’T’HH:mm:ss.Z |
usages[].aprs[].updated_date
datetime
|
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
|
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
|
Indicates whether the APR value is fixed or variable. Allowable Values:
|
usages[].aprs[].schedule[].value
decimal
|
Percentage value of the APR. If the APR type is When backdating an APR, this value cannot be greater than the value of the effective APR on the backdated date. Allowable Values: 0–100 |
usages[].aprs[].schedule[].margin
decimal
|
The number of percentage points added to the prime rate, used to calculate a variable value. Used for variable values only. Allowable Values: |
usages[].aprs[].schedule[].effective_date
datetime
|
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
|
Whether the APR is ignored for the current billing cycle and applied on the next. Allowable Values: |
usages[].fees
array of objects
|
List of fees associated with the credit account. Allowable Values: |
usages[].fees[].type
string
|
Type of fee. NOTE:
Currently only Allowable Values:
|
usages[].fees[].method
string
|
Method, either a flat amount or a percentage. NOTE:
Currently only Allowable Values:
|
usages[].fees[].value
decimal
|
Value of the fee, either a flat fee amount or percentage value. Allowable Values: 0–9999.9999 |
List accounts
Copy section link
Action: GET
Endpoint: /credit/accounts
Retrieve an array of credit accounts.
This endpoint supports sorting and pagination.
URL query parameters
Copy section link
| Fields | Description |
|---|---|
card_token
string
|
The unique identifier of the the credit card associated with the account. Allowable Values: |
count
integer
|
The number of resources to retrieve. Allowable Values: 1–100 |
start_index
integer
|
The sort order index of the first resource in the returned array. Allowable Values: 0 min |
sort_by
string
|
Field on which to sort.
Prefix the field name with a hyphen ( NOTE:
You must sort using system field names such as Allowable Values:
|
Response body
Copy section link
| Fields | Description |
|---|---|
count
integer
|
The number of resources returned. Allowable Values: |
start_index
integer
|
The sort order index of the first resource in the returned array. Allowable Values: Any integer |
end_index
integer
|
The sort order index of the first resource in the returned array. Allowable Values: Any integer |
is_more
boolean
|
A value of Allowable Values:
|
data
array of objects
|
List of credit accounts. Allowable Values: |
data[].token
string
|
Unique identifier of the credit account. Allowable Values: 36 char max |
data[].name
string
|
Name of the credit account. Allowable Values: |
data[].description
string
|
Description for the credit account. Allowable Values: Any string |
data[].currency_code
string
|
A valid three-digit ISO 4217 currency code Allowable Values:
|
data[].status
string
|
Status of the credit account. Allowable Values:
|
data[].activation_time
datetime
|
Date and time when the credit account was activated on the Marqeta platform. Allowable Values: Format: yyyy-MM-dd’T’HH:mm:ss.Z |
data[].created_time
datetime
|
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
|
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
|
Type of credit account. Allowable Values:
|
data[].bundle_token
string
|
Unique identifier of the associated bundle product. Allowable Values: Existing credit bundle token |
data[].credit_product_token
string
|
Unique identifier of the associated credit product. Allowable Values: Existing credit product token |
data[].user_token
string
|
Unique identifier of the primary account holder. Allowable Values: Existing user token |
data[].external_offer_id
string
|
Unique identifier you provide of the associated external credit offer. Allowable Values: Your external offer ID. |
data[].credit_limit
decimal
|
Maximum balance the credit account can carry. Allowable Values: 0–1000000 |
data[].current_balance
decimal
|
Current purchase balance on the credit account. Allowable Values: |
data[].available_credit
decimal
|
Amount of credit available for use on the credit account. Allowable Values: |
data[].remaining_statement_balance
decimal
|
Amount remaining on the latest statement’s balance, after it’s adjusted for payments, returned payments, and applicable credits that occurred after the latest statement’s closing date. Allowable Values: |
data[].remaining_min_payment_due
decimal
|
Amount remaining on the latest statement’s minimum payment, after it’s adjusted for payments, returned payments, and applicable credits that occurred after the latest statement’s closing date. Allowable Values: |
data[].config
object
|
Configurations for the billing cycle day, payment due day, and fees. Allowable Values: |
data[].config.billing_cycle_day
integer
|
Day of month the billing cycle starts. Allowable Values: 1 |
data[].config.payment_due_day
integer
|
Day of month the payment for the previous billing cycle is due. Allowable Values: 31 |
data[].config.e_disclosure_active
boolean
|
A value of Allowable Values:
|
data[].config.card_level
string
|
The level of the credit card. Allowable Values:
|
data[].config.fees
array of objects
|
List of fees associated with the credit account. Allowable Values: |
data[].config.fees[].type
string
|
Type of fee. Allowable Values:
|
data[].config.fees[].active
boolean
|
Whether the fee is active. Allowable Values: |
data[].config.fees[].created_date
datetime
|
Date and time when the fee was created on the Marqeta platform. Allowable Values: Format: yyyy-MM-dd’T’HH:mm:ss.Z |
data[].config.fees[].updated_date
datetime
|
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
|
List of fees and when they are effective. Allowable Values: |
data[].config.fees[].schedule[].method
string
|
Method used to calculate the fee value. Allowable Values:
|
data[].config.fees[].schedule[].value
decimal
|
Amount of the fee. Allowable Values: 0–9999.9999 |
data[].config.fees[].schedule[].effective_date
datetime
|
Date the fee becomes effective. Allowable Values: |
data[].config.rewards
array of objects
|
List of rewards associated with the credit account. Allowable Values: |
data[].config.rewards[].type
string
|
Type of reward. Allowable Values:
|
data[].config.rewards[].method
string
|
Method, either a flat amount or a percentage. NOTE:
Currently only Allowable Values:
|
data[].config.rewards[].value
decimal
|
Value of the reward, either a flat reward amount or percentage value. Allowable Values: 0–100 |
data[].config.payment_holds
object
|
Configurations for a payment hold. Allowable Values: |
data[].config.payment_holds.ach_hold_days
integer
|
Number of days to hold an ACH payment. Allowable Values: 0–7 |
data[].config.payment_holds.check_hold_days
integer
|
Number of days to hold a check payment. Allowable Values: 0–7 |
data[].config.min_payment
object
|
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
|
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
|
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
|
Flat amount of the minimum payment override. Allowable Values: 0 min |
data[].config.min_payment.min_payment_percentage
decimal
|
Percentage of the total statement balance used to calculate the minimum payment override amount. Allowable Values: 0 min |
data[].config.min_payment.active
boolean
|
Whether the minimum payment override is currently active. Allowable Values: |
data[].usages
array of objects
|
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
|
Type of balance.
Allowable Values:
|
data[].usages[].aprs
array of objects
|
List of APRs associated with the type of balance on the credit account Allowable Values: |
data[].usages[].aprs[].type
string
|
Type of APR.
Allowable Values:
|
data[].usages[].aprs[].active
boolean
|
Whether the APR is active. Allowable Values: |
data[].usages[].aprs[].created_date
datetime
|
Date and time when the APR was created on the Marqeta platform. Allowable Values: Format: yyyy-MM-dd’T’HH:mm:ss.Z |
data[].usages[].aprs[].updated_date
datetime
|
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
|
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
|
Indicates whether the APR value is fixed or variable. Allowable Values:
|
data[].usages[].aprs[].schedule[].value
decimal
|
Percentage value of the APR. If the APR type is When backdating an APR, this value cannot be greater than the value of the effective APR on the backdated date. Allowable Values: 0–100 |
data[].usages[].aprs[].schedule[].margin
decimal
|
The number of percentage points added to the prime rate, used to calculate a variable value. Used for variable values only. Allowable Values: |
data[].usages[].aprs[].schedule[].effective_date
datetime
|
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
|
Whether the APR is ignored for the current billing cycle and applied on the next. Allowable Values: |
data[].usages[].fees
array of objects
|
List of fees associated with the credit account. Allowable Values: |
data[].usages[].fees[].type
string
|
Type of fee. NOTE:
Currently only Allowable Values:
|
data[].usages[].fees[].method
string
|
Method, either a flat amount or a percentage. NOTE:
Currently only Allowable Values:
|
data[].usages[].fees[].value
decimal
|
Value of the fee, either a flat fee amount or percentage value. Allowable Values: 0–9999.9999 |
Retrieve account
Copy section link
Action: GET
Endpoint: /credit/accounts/{account_token}
Retrieve a credit account.
URL path parameters
Copy section link
| Fields | Description |
|---|---|
account_token
string
|
The unique identifier of the credit account to retrieve. Send a Allowable Values: |
Response body
Copy section link
| Fields | Description |
|---|---|
token
string
|
Unique identifier of the credit account. Allowable Values: 36 char max |
name
string
|
Name of the credit account. Allowable Values: |
description
string
|
Description for the credit account. Allowable Values: Any string |
currency_code
string
|
A valid three-digit ISO 4217 currency code Allowable Values:
|
status
string
|
Status of the credit account. Allowable Values:
|
activation_time
datetime
|
Date and time when the credit account was activated on the Marqeta platform. Allowable Values: Format: yyyy-MM-dd’T’HH:mm:ss.Z |
created_time
datetime
|
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
|
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
|
Type of credit account. Allowable Values:
|
bundle_token
string
|
Unique identifier of the associated bundle product. Allowable Values: Existing credit bundle token |
credit_product_token
string
|
Unique identifier of the associated credit product. Allowable Values: Existing credit product token |
user_token
string
|
Unique identifier of the primary account holder. Allowable Values: Existing user token |
external_offer_id
string
|
Unique identifier you provide of the associated external credit offer. Allowable Values: Your external offer ID. |
credit_limit
decimal
|
Maximum balance the credit account can carry. Allowable Values: 0–1000000 |
current_balance
decimal
|
Current purchase balance on the credit account. Allowable Values: |
available_credit
decimal
|
Amount of credit available for use on the credit account. Allowable Values: |
remaining_statement_balance
decimal
|
Amount remaining on the latest statement’s balance, after it’s adjusted for payments, returned payments, and applicable credits that occurred after the latest statement’s closing date. Allowable Values: |
remaining_min_payment_due
decimal
|
Amount remaining on the latest statement’s minimum payment, after it’s adjusted for payments, returned payments, and applicable credits that occurred after the latest statement’s closing date. Allowable Values: |
config
object
|
Configurations for the billing cycle day, payment due day, and fees. Allowable Values: |
config.billing_cycle_day
integer
|
Day of month the billing cycle starts. Allowable Values: 1 |
config.payment_due_day
integer
|
Day of month the payment for the previous billing cycle is due. Allowable Values: 31 |
config.e_disclosure_active
boolean
|
A value of Allowable Values:
|
config.card_level
string
|
The level of the credit card. Allowable Values:
|
config.fees
array of objects
|
List of fees associated with the credit account. Allowable Values: |
config.fees[].type
string
|
Type of fee. Allowable Values:
|
config.fees[].active
boolean
|
Whether the fee is active. Allowable Values: |
config.fees[].created_date
datetime
|
Date and time when the fee was created on the Marqeta platform. Allowable Values: Format: yyyy-MM-dd’T’HH:mm:ss.Z |
config.fees[].updated_date
datetime
|
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
|
List of fees and when they are effective. Allowable Values: |
config.fees[].schedule[].method
string
|
Method used to calculate the fee value. Allowable Values:
|
config.fees[].schedule[].value
decimal
|
Amount of the fee. Allowable Values: 0–9999.9999 |
config.fees[].schedule[].effective_date
datetime
|
Date the fee becomes effective. Allowable Values: |
config.rewards
array of objects
|
List of rewards associated with the credit account. Allowable Values: |
config.rewards[].type
string
|
Type of reward. Allowable Values:
|
config.rewards[].method
string
|
Method, either a flat amount or a percentage. NOTE:
Currently only Allowable Values:
|
config.rewards[].value
decimal
|
Value of the reward, either a flat reward amount or percentage value. Allowable Values: 0–100 |
config.payment_holds
object
|
Configurations for a payment hold. Allowable Values: |
config.payment_holds.ach_hold_days
integer
|
Number of days to hold an ACH payment. Allowable Values: 0–7 |
config.payment_holds.check_hold_days
integer
|
Number of days to hold a check payment. Allowable Values: 0–7 |
config.min_payment
object
|
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
|
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
|
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
|
Flat amount of the minimum payment override. Allowable Values: 0 min |
config.min_payment.min_payment_percentage
decimal
|
Percentage of the total statement balance used to calculate the minimum payment override amount. Allowable Values: 0 min |
config.min_payment.active
boolean
|
Whether the minimum payment override is currently active. Allowable Values: |
usages
array of objects
|
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
|
Type of balance.
Allowable Values:
|
usages[].aprs
array of objects
|
List of APRs associated with the type of balance on the credit account Allowable Values: |
usages[].aprs[].type
string
|
Type of APR.
Allowable Values:
|
usages[].aprs[].active
boolean
|
Whether the APR is active. Allowable Values: |
usages[].aprs[].created_date
datetime
|
Date and time when the APR was created on the Marqeta platform. Allowable Values: Format: yyyy-MM-dd’T’HH:mm:ss.Z |
usages[].aprs[].updated_date
datetime
|
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
|
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
|
Indicates whether the APR value is fixed or variable. Allowable Values:
|
usages[].aprs[].schedule[].value
decimal
|
Percentage value of the APR. If the APR type is When backdating an APR, this value cannot be greater than the value of the effective APR on the backdated date. Allowable Values: 0–100 |
usages[].aprs[].schedule[].margin
decimal
|
The number of percentage points added to the prime rate, used to calculate a variable value. Used for variable values only. Allowable Values: |
usages[].aprs[].schedule[].effective_date
datetime
|
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
|
Whether the APR is ignored for the current billing cycle and applied on the next. Allowable Values: |
usages[].fees
array of objects
|
List of fees associated with the credit account. Allowable Values: |
usages[].fees[].type
string
|
Type of fee. NOTE:
Currently only Allowable Values:
|
usages[].fees[].method
string
|
Method, either a flat amount or a percentage. NOTE:
Currently only Allowable Values:
|
usages[].fees[].value
decimal
|
Value of the fee, either a flat fee amount or percentage value. Allowable Values: 0–9999.9999 |
Update account
Copy section link
Action: PUT
Endpoint: /credit/accounts/{account_token}
Update a credit account.
URL path parameters
Copy section link
| Fields | Description |
|---|---|
account_token
string
|
The unique identifier of the credit account to update. Send a Allowable Values: |
Request body
Copy section link
| Fields | Description |
|---|---|
config
object
|
Information on configurations for billing cycle day, payment due day, and fees. Allowable Values: |
config.e_disclosure_active
boolean
|
A value of Allowable Values:
|
config.fees
array of objects
|
List of fees associated with the credit account. Allowable Values: |
config.fees[].type
string
|
Type of fee. Allowable Values:
|
config.fees[].schedule
array of objects
|
List of fees and when they are effective. Allowable Values: |
config.fees[].schedule[].method
string
|
Method used to calculate the fee value. Allowable Values:
|
config.fees[].schedule[].value
decimal
|
Amount of the fee. Allowable Values: 0–9999.9999 |
config.fees[].schedule[].effective_date
datetime
|
Date the fee becomes effective. Allowable Values: |
config.payment_holds
object
|
Configurations for a payment hold. Allowable Values: |
config.payment_holds.ach_hold_days
integer
|
Number of days to hold an ACH payment. Allowable Values: 0–7 |
config.payment_holds.check_hold_days
integer
|
Number of days to hold a check payment. Allowable Values: 0–7 |
config.min_payment
object
|
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
|
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
|
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
|
Flat amount of the minimum payment override. Allowable Values: 0 min |
config.min_payment.min_payment_percentage
decimal
|
Percentage of the total statement balance used to calculate the minimum payment override amount. Allowable Values: 0 min |
config.min_payment.active
boolean
|
Whether the minimum payment override is currently active. Allowable Values: |
usages
array of objects
|
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 Allowable Values: |
usages[].type
string
|
Type of balance.
Allowable Values:
|
usages[].aprs
array of objects
|
List of annual percentage rates (APRs) associated with the credit account. Allowable Values: |
usages[].aprs[].type
string
|
Type of APR.
Allowable Values:
|
usages[].aprs[].schedule
array of objects
|
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
|
Indicates whether the APR value is fixed or variable. Allowable Values:
|
usages[].aprs[].schedule[].margin
decimal
|
The number of percentage points added to the prime rate, used to calculate a variable value. Used for variable values only. Allowable Values: |
usages[].aprs[].schedule[].value
decimal
|
Percentage value of the APR. If the APR type is When backdating an APR, this value cannot be greater than the value of the effective APR on the backdated date. Allowable Values: 0–100 |
usages[].aprs[].schedule[].effective_date
datetime
|
Date and time when the APR 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 Allowable Values: Format: yyyy-MM-dd’T’HH:mm:ss.Z |
usages[].aprs[].schedule[].apply_next_cycle
boolean
|
Whether the APR can be ignored for the current billing cycle and applied on the next. Allowable Values: |
credit_limit
object
|
Information on the credit limit. Allowable Values: |
credit_limit.value
decimal
|
Maximum balance the credit account can carry. Allowable Values: 0–999999999999.99 |
Response body
Copy section link
| Fields | Description |
|---|---|
token
string
|
Unique identifier of the credit account. Allowable Values: 36 char max |
name
string
|
Name of the credit account. Allowable Values: |
description
string
|
Description for the credit account. Allowable Values: Any string |
currency_code
string
|
A valid three-digit ISO 4217 currency code Allowable Values:
|
status
string
|
Status of the credit account. Allowable Values:
|
activation_time
datetime
|
Date and time when the credit account was activated on the Marqeta platform. Allowable Values: Format: yyyy-MM-dd’T’HH:mm:ss.Z |
created_time
datetime
|
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
|
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
|
Type of credit account. Allowable Values:
|
bundle_token
string
|
Unique identifier of the associated bundle product. Allowable Values: Existing credit bundle token |
credit_product_token
string
|
Unique identifier of the associated credit product. Allowable Values: Existing credit product token |
user_token
string
|
Unique identifier of the primary account holder. Allowable Values: Existing user token |
external_offer_id
string
|
Unique identifier you provide of the associated external credit offer. Allowable Values: Your external offer ID. |
credit_limit
decimal
|
Maximum balance the credit account can carry. Allowable Values: 0–1000000 |
current_balance
decimal
|
Current purchase balance on the credit account. Allowable Values: |
available_credit
decimal
|
Amount of credit available for use on the credit account. Allowable Values: |
remaining_statement_balance
decimal
|
Amount remaining on the latest statement’s balance, after it’s adjusted for payments, returned payments, and applicable credits that occurred after the latest statement’s closing date. Allowable Values: |
remaining_min_payment_due
decimal
|
Amount remaining on the latest statement’s minimum payment, after it’s adjusted for payments, returned payments, and applicable credits that occurred after the latest statement’s closing date. Allowable Values: |
config
object
|
Configurations for the billing cycle day, payment due day, and fees. Allowable Values: |
config.billing_cycle_day
integer
|
Day of month the billing cycle starts. Allowable Values: 1 |
config.payment_due_day
integer
|
Day of month the payment for the previous billing cycle is due. Allowable Values: 31 |
config.e_disclosure_active
boolean
|
A value of Allowable Values:
|
config.card_level
string
|
The level of the credit card. Allowable Values:
|
config.fees
array of objects
|
List of fees associated with the credit account. Allowable Values: |
config.fees[].type
string
|
Type of fee. Allowable Values:
|
config.fees[].active
boolean
|
Whether the fee is active. Allowable Values: |
config.fees[].created_date
datetime
|
Date and time when the fee was created on the Marqeta platform. Allowable Values: Format: yyyy-MM-dd’T’HH:mm:ss.Z |
config.fees[].updated_date
datetime
|
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
|
List of fees and when they are effective. Allowable Values: |
config.fees[].schedule[].method
string
|
Method used to calculate the fee value. Allowable Values:
|
config.fees[].schedule[].value
decimal
|
Amount of the fee. Allowable Values: 0–9999.9999 |
config.fees[].schedule[].effective_date
datetime
|
Date the fee becomes effective. Allowable Values: |
config.rewards
array of objects
|
List of rewards associated with the credit account. Allowable Values: |
config.rewards[].type
string
|
Type of reward. Allowable Values:
|
config.rewards[].method
string
|
Method, either a flat amount or a percentage. NOTE:
Currently only Allowable Values:
|
config.rewards[].value
decimal
|
Value of the reward, either a flat reward amount or percentage value. Allowable Values: 0–100 |
config.payment_holds
object
|
Configurations for a payment hold. Allowable Values: |
config.payment_holds.ach_hold_days
integer
|
Number of days to hold an ACH payment. Allowable Values: 0–7 |
config.payment_holds.check_hold_days
integer
|
Number of days to hold a check payment. Allowable Values: 0–7 |
config.min_payment
object
|
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
|
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
|
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
|
Flat amount of the minimum payment override. Allowable Values: 0 min |
config.min_payment.min_payment_percentage
decimal
|
Percentage of the total statement balance used to calculate the minimum payment override amount. Allowable Values: 0 min |
config.min_payment.active
boolean
|
Whether the minimum payment override is currently active. Allowable Values: |
usages
array of objects
|
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
|
Type of balance.
Allowable Values:
|
usages[].aprs
array of objects
|
List of APRs associated with the type of balance on the credit account Allowable Values: |
usages[].aprs[].type
string
|
Type of APR.
Allowable Values:
|
usages[].aprs[].active
boolean
|
Whether the APR is active. Allowable Values: |
usages[].aprs[].created_date
datetime
|
Date and time when the APR was created on the Marqeta platform. Allowable Values: Format: yyyy-MM-dd’T’HH:mm:ss.Z |
usages[].aprs[].updated_date
datetime
|
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
|
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
|
Indicates whether the APR value is fixed or variable. Allowable Values:
|
usages[].aprs[].schedule[].value
decimal
|
Percentage value of the APR. If the APR type is When backdating an APR, this value cannot be greater than the value of the effective APR on the backdated date. Allowable Values: 0–100 |
usages[].aprs[].schedule[].margin
decimal
|
The number of percentage points added to the prime rate, used to calculate a variable value. Used for variable values only. Allowable Values: |
usages[].aprs[].schedule[].effective_date
datetime
|
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
|
Whether the APR is ignored for the current billing cycle and applied on the next. Allowable Values: |
usages[].fees
array of objects
|
List of fees associated with the credit account. Allowable Values: |
usages[].fees[].type
string
|
Type of fee. NOTE:
Currently only Allowable Values:
|
usages[].fees[].method
string
|
Method, either a flat amount or a percentage. NOTE:
Currently only Allowable Values:
|
usages[].fees[].value
decimal
|
Value of the fee, either a flat fee amount or percentage value. Allowable Values: 0–9999.9999 |
Transition account status
Copy section link
Action: POST
Endpoint: /credit/accounts/{account_token}/accounttransitions
Transition a credit account to a new status.
URL path parameters
Copy section link
| Fields | Description |
|---|---|
account_token
string
|
The unique identifier of the credit account for which to transition a status. Send a Allowable Values: |
Request body
Copy section link
| Fields | Description |
|---|---|
status
string
|
Status of the credit account. Allowable Values:
|
token
string
|
Unique identifier of the credit account transition. Allowable Values: 36 char max |
Response body
Copy section link
| Fields | Description |
|---|---|
token
string
|
Unique identifier of the credit account transition. Allowable Values: 36 char max |
account_token
string
|
Unique identifier of the credit account for which to transition a status. Allowable Values: 36 char max |
original_status
string
|
Status of the credit account prior to transition. Allowable Values:
|
status
string
|
Status to which the credit account transitioned. Allowable Values:
|
created_time
datetime
|
Date and time when the transition record was created on the Marqeta platform. Allowable Values: Format: yyyy-MM-dd’T’HH:mm:ss.Z |
List account transitions
Copy section link
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
Copy section link
| Fields | Description |
|---|---|
account_token
string
|
The unique identifier of the credit account for which you want to retrieve transitions. Send a Allowable Values: |
URL query parameters
Copy section link
| Fields | Description |
|---|---|
count
integer
|
The number of resources to retrieve. Allowable Values: 1–100 |
start_index
integer
|
The sort order index of the first resource in the returned array. Allowable Values: 0 min |
sort_by
string
|
Field on which to sort.
Prefix the field name with a hyphen ( NOTE:
You must sort using system field names such as Allowable Values:
|
Response body
Copy section link
| Fields | Description |
|---|---|
count
integer
|
The number of resources returned. Allowable Values: |
start_index
integer
|
The sort order index of the first resource in the returned array. Allowable Values: Any integer |
end_index
integer
|
The sort order index of the last resource in the returned array. Allowable Values: Any integer |
is_more
boolean
|
A value of Allowable Values:
|
data
array of objects
|
List of account transitions. Allowable Values: |
data[].token
string
|
Unique identifier of the credit account transition. Allowable Values: 36 char max |
data[].account_token
string
|
Unique identifier of the credit account for which to transition a status. Allowable Values: 36 char max |
data[].original_status
string
|
Status of the credit account prior to transition. Allowable Values:
|
data[].status
string
|
Status to which the credit account transitioned. Allowable Values:
|
data[].created_time
datetime
|
Date and time when the transition record was created on the Marqeta platform. Allowable Values: Format: yyyy-MM-dd’T’HH:mm:ss.Z |
Retrieve account transition
Copy section link
Action: GET
Endpoint: /credit/accounts/{account_token}/accounttransitions/{token}
Retrieve a transition for a credit account.
URL path parameters
Copy section link
| Fields | Description |
|---|---|
account_token
string
|
The unique identifier of the credit account for which you want to retrieve a transition. Send a Allowable Values: |
token
string
|
The unique identifier of the account transition you want to retrieve. Send a Allowable Values: |
Response body
Copy section link
| Fields | Description |
|---|---|
token
string
|
Unique identifier of the credit account transition. Allowable Values: 36 char max |
account_token
string
|
Unique identifier of the credit account for which to transition a status. Allowable Values: 36 char max |
original_status
string
|
Status of the credit account prior to transition. Allowable Values:
|
status
string
|
Status to which the credit account transitioned. Allowable Values:
|
created_time
datetime
|
Date and time when the transition record was created on the Marqeta platform. Allowable Values: Format: yyyy-MM-dd’T’HH:mm:ss.Z |
Create account card
Copy section link
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 aPUT request to the /cards endpoint with the new address in the fulfillment.shipping object.
For more, see Update card.
URL path parameters
Copy section link
| Fields | Description |
|---|---|
account_token
string
|
The unique identifier of the credit account for which to create a credit card. Send a Allowable Values: |
Request body
Copy section link
| Fields | Description |
|---|---|
token
string
|
Unique identifier of the credit card. Allowable Values: 36 char max |
card_product_token
string
|
Unique identifier of the associated card product. Allowable Values: Existing card product token |
user_token
string
|
Unique identifier of the credit cardholder. Allowable Values: Existing user token |
reissue_pan_from_card_token
string
|
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 Allowable Values: Existing card token |
expiration_offset
object
|
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 Allowable Values: |
expiration_offset.unit
string
|
The units for the Allowable Values: |
expiration_offset.value
integer
|
Specifies the number of time units (as defined by the This number is rounded as follows:
Allowable Values: |
translate_pin_from_card_token
string
|
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 Send a Allowable Values: Existing card token |
activation_actions
object
|
Information on actions that can be performed when a card is activated. Allowable Values: |
activation_actions.terminate_reissued_source_card
boolean
|
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 Only relevant when Allowable Values:
Default value: |
activation_actions.swap_digital_wallet_tokens_from_card_token
string
|
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 Send a Allowable Values: Existing card token |
Response body
Copy section link
| Fields | Description |
|---|---|
token
string
|
Unique identifier of the credit card. Allowable Values: 36 char max |
account_token
string
|
Unique identifier of the associated credit account. Allowable Values: 36 char max Existing credit account token |
user_token
string
|
Unique identifier of the credit cardholder. Allowable Values: Existing user token |
created_time
datetime
|
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
|
Date and time when the card was last modified on the Marqeta platform. Allowable Values: Format: yyyy-MM-dd’T’HH:mm:ss.Z |
List account cards
Copy section link
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
Copy section link
| Fields | Description |
|---|---|
account_token
string
|
The unique identifier of the credit account for which to retrieve credit cards. Send a Allowable Values: |
URL query parameters
Copy section link
| Fields | Description |
|---|---|
status
string
|
The status of the credit cards to return. Allowable Values: |
count
integer
|
The number of resources to retrieve. Allowable Values: 1–100 |
start_index
integer
|
The sort order index of the first resource in the returned array. Allowable Values: 0 min |
sort_by
string
|
Field on which to sort.
Prefix the field name with a hyphen ( NOTE:
You must sort using system field names such as Allowable Values:
|
Response body
Copy section link
| Fields | Description |
|---|---|
count
integer
|
The number of resources returned. Allowable Values: |
start_index
integer
|
The sort order index of the first resource in the returned array. Allowable Values: Any integer |
end_index
integer
|
The sort order index of the last resource in the returned array. Allowable Values: Any integer |
is_more
boolean
|
A value of Allowable Values:
|
data
array of objects
|
List of credit cards. Allowable Values: |
data[].token
string
|
Unique identifier of the credit card. Allowable Values: 36 char max |
data[].account_token
string
|
Unique identifier of the associated credit account. Allowable Values: 36 char max Existing credit account token |
data[].user_token
string
|
Unique identifier of the credit cardholder. Allowable Values: Existing user token |
data[].created_time
datetime
|
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
|
Date and time when the card was last modified on the Marqeta platform. Allowable Values: Format: yyyy-MM-dd’T’HH:mm:ss.Z |
Retrieve account card
Copy section link
Action: GET
Endpoint: /credit/accounts/{account_token}/cards/{card_token}
Retrieve a credit card for a credit account.
URL path parameters
Copy section link
| Fields | Description |
|---|---|
account_token
string
|
The unique identifier of the credit account for which to retrieve a credit card. Send a Allowable Values: |
card_token
string
|
The unique identifier of the credit card to retrieve. Send a Allowable Values: |
Response body
Copy section link
| Fields | Description |
|---|---|
token
string
|
Unique identifier of the credit card. Allowable Values: 36 char max |
account_token
string
|
Unique identifier of the associated credit account. Allowable Values: 36 char max Existing credit account token |
user_token
string
|
Unique identifier of the credit cardholder. Allowable Values: Existing user token |
created_time
datetime
|
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
|
Date and time when the card was last modified on the Marqeta platform. Allowable Values: Format: yyyy-MM-dd’T’HH:mm:ss.Z |
List account journal entries
Copy section link
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
Copy section link
| Fields | Description |
|---|---|
account_token
string
|
The unique identifier of the credit account for which you want to retrieve journal entries. Send a Allowable Values: Existing account token |
URL query parameters
Copy section link
| Fields | Description |
|---|---|
count
integer
|
The number of resources to retrieve. Allowable Values: 1–100 |
start_index
integer
|
The sort order index of the first resource in the returned array. Allowable Values: 0 min Any integer |
start_date
string
|
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
|
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
|
List of journal entry statuses to return. Allowable Values:
|
groups
array of strings
|
List of journal entry groups to return. To return all journal entry groups, do not include this query parameter. Allowable Values:
|
expand
string
|
Embeds the specified object into the response. Allowable Values:
|
sort_by
string
|
Field on which to sort.
Prefix the field name with a hyphen ( NOTE:
You must sort using system field names such as Allowable Values:
|
card_tokens
array of strings
|
List of credit card tokens. Returns journal entries associated with the specified card tokens. Send a Allowable Values: Existing card token |
user_tokens
array of strings
|
List of user tokens. Returns journal entries associated with the specified user tokens. Send a Allowable Values: Existing user token |
types
array of strings
|
List of journal entry event types to return. To return all event types, do not include this query parameter. Allowable Values:
|
Response body
Copy section link
| Fields | Description |
|---|---|
count
integer
|
The number of resources returned. Allowable Values: 1–100 |
start_index
integer
|
The sort order index of the first resource in the returned array. Allowable Values: Any integer |
end_index
integer
|
The sort order index of the last resource in the returned array. Allowable Values: Any integer |
is_more
boolean
|
A value of Allowable Values:
|
data
array of objects
|
List of journal entries. Allowable Values: Existing data object |
data[].token
string
|
Unique identifier of the journal entry. Allowable Values: 36 char max |
data[].related_token
string
|
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
|
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
|
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
|
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
|
Unique identifier of the credit user. Allowable Values: Existing user token |
data[].status
string
|
Current status of the journal entry. NOTE: Allowable Values:
|
data[].group
string
|
Group to which the journal entry belongs. Allowable Values:
|
data[].type
string
|
The journal entry event type. Allowable Values: A valid journal entry event type |
data[].id
string
|
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
|
Amount of the journal entry. Allowable Values: Any decimal |
data[].currency_code
string
|
A valid three-digit ISO 4217 currency code Allowable Values:
|
data[].memo
string
|
Merchant name or description for the journal entry. Allowable Values: Example: Whole Foods Market |
data[].request_time
datetime
|
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 Allowable Values: Format: yyyy-MM-dd’T’HH:mm:ss.Z |
data[].impact_time
datetime
|
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
|
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
|
Unique identifier of the dispute, if the journal entry is disputed. Allowable Values: Existing dispute token |
data[].detail_token
string
|
Unique identifier of the journal entry’s full details. Allowable Values: 36 char max |
data[].detail_object
object
|
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
|
Unique identifier of the interest charge or fee. If in the Returned for interest or fee journal entries only. Allowable Values: 36 char max |
data[].detail_object.account_token
string
|
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
|
Type of fee. Returned for fee journal entries only. Allowable Values:
|
data[].detail_object.method
string
|
Method used to calculate the fee value. Returned for fee journal entries only. Allowable Values:
|
data[].detail_object.value
decimal
|
Value of the fee configured on the account. Equivalent to Returned for fee journal entries only. Allowable Values: |
data[].detail_object.currency_code
string
|
A valid three-digit ISO 4217 currency code Allowable Values:
|
data[].detail_object.amount
decimal
|
Amount of the fee. Returned for fee journal entries only. Allowable Values: |
data[].detail_object.applied_to_amount
decimal
|
The total amount to which a percentage fee method is applied (for example, if a 3% fee is applied to 100, then 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 Allowable Values: |
data[].detail_object.description
string
|
Description of the fee. Returned for fee journal entries only. Allowable Values: |
data[].detail_object.created
datetime
|
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
|
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
|
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
|
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
|
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
|
Average daily balance used to calculate interest. Returned for interest journal entries only. Allowable Values: |
data[].detail_object.goto_apr
decimal
|
Annual percentage rate. Returned for interest journal entries only. Allowable Values: 0–100 |
data[].detail_object.daily_periodic_rate
decimal
|
Daily rate used to calculate interest. Returned for interest journal entries only. Allowable Values: 0–100 |
data[].detail_object.days_in_billing_cycle
integer
|
Number of days in the billing cycle. Returned for interest journal entries only. Allowable Values: 1–31 |
data[].detail_object.interest_amount
decimal
|
Amount of interest calculated for the billing period. Returned for interest journal entries only. Allowable Values: |
data[].detail_object.created_date
datetime
|
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
|
Date and time when the journal entry was last updated. Allowable Values: Format: yyyy-MM-dd’T’HH:mm:ss.Z |
Retrieve account journal entry
Copy section link
Action: GET
Endpoint: /credit/accounts/{account_token}/journalentries/{journal_entry_token}
Retrieve a journal entry for a credit account.
URL path parameters
Copy section link
| Fields | Description |
|---|---|
account_token
string
|
The unique identifier of the credit account for which you want to retrieve journal entries. Send a Allowable Values: Existing account token |
journal_entry_token
string
|
The unique identifier of the journal entry you want to retrieve. Send a Allowable Values: Existing journal entry token |
Response body
Copy section link
| Fields | Description |
|---|---|
token
string
|
Unique identifier of the journal entry. Allowable Values: 36 char max |
related_token
string
|
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
|
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
|
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
|
Unique identifier of the credit card used to make the journal entry. Allowable Values: 8–36 chars Existing credit card token |
user_token
string
|
Unique identifier of the credit user. Allowable Values: Existing user token |
status
string
|
Current status of the journal entry. NOTE: Allowable Values:
|
group
string
|
Group to which the journal entry belongs. Allowable Values:
|
type
string
|
The journal entry event type. Allowable Values: A valid journal entry event type |
id
string
|
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
|
Amount of the journal entry. Allowable Values: Any decimal |
currency_code
string
|
A valid three-digit ISO 4217 currency code Allowable Values:
|
memo
string
|
Merchant name or description for the journal entry. Allowable Values: Example: Whole Foods Market |
request_time
datetime
|
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 Allowable Values: Format: yyyy-MM-dd’T’HH:mm:ss.Z |
impact_time
datetime
|
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
|
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
|
Unique identifier of the dispute, if the journal entry is disputed. Allowable Values: Existing dispute token |
detail_token
string
|
Unique identifier of the journal entry’s full details. Allowable Values: 36 char max |
detail_object
object
|
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
|
Unique identifier of the interest charge or fee. If in the Returned for interest or fee journal entries only. Allowable Values: 36 char max |
detail_object.account_token
string
|
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
|
Type of fee. Returned for fee journal entries only. Allowable Values:
|
detail_object.method
string
|
Method used to calculate the fee value. Returned for fee journal entries only. Allowable Values:
|
detail_object.value
decimal
|
Value of the fee configured on the account. Equivalent to Returned for fee journal entries only. Allowable Values: |
detail_object.currency_code
string
|
A valid three-digit ISO 4217 currency code Allowable Values:
|
detail_object.amount
decimal
|
Amount of the fee. Returned for fee journal entries only. Allowable Values: |
detail_object.applied_to_amount
decimal
|
The total amount to which a percentage fee method is applied (for example, if a 3% fee is applied to 100, then 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 Allowable Values: |
detail_object.description
string
|
Description of the fee. Returned for fee journal entries only. Allowable Values: |
detail_object.created
datetime
|
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
|
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
|
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
|
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
|
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
|
Average daily balance used to calculate interest. Returned for interest journal entries only. Allowable Values: |
detail_object.goto_apr
decimal
|
Annual percentage rate. Returned for interest journal entries only. Allowable Values: 0–100 |
detail_object.daily_periodic_rate
decimal
|
Daily rate used to calculate interest. Returned for interest journal entries only. Allowable Values: 0–100 |
detail_object.days_in_billing_cycle
integer
|
Number of days in the billing cycle. Returned for interest journal entries only. Allowable Values: 1–31 |
detail_object.interest_amount
decimal
|
Amount of interest calculated for the billing period. Returned for interest journal entries only. Allowable Values: |
detail_object.created_date
datetime
|
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
|
Date and time when the journal entry was last updated. Allowable Values: Format: yyyy-MM-dd’T’HH:mm:ss.Z |
Sample response body
Copy section link
The following code block shows a sample purchase journal entry.
The following code block shows a sample interest journal entry.
The following code block shows a sample fee journal entry.
Create account adjustment
Copy section link
Action: POST
Endpoint: /credit/accounts/{account_token}/adjustments
Create an adjustment for an existing credit account.
URL path parameters
Copy section link
| Fields | Description |
|---|---|
account_token
string
|
The unique identifier of the credit account for which you want to create an adjustment. Send a Allowable Values: |
Request body
Copy section link
| Fields | Description |
|---|---|
token
string
|
Unique identifier of the adjustment. Allowable Values: 36 char max |
original_ledger_entry_token
uuid
|
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
|
Unique identifier you provide of an associated external adjustment that exists outside the Marqeta platform. Allowable Values: |
amount
decimal
|
Amount of the adjustment. Value must be negative if Allowable Values: 1000000 max |
currency_code
string
|
A valid three-digit ISO 4217 currency code Allowable Values:
|
description
string
|
Description of the adjustment. Allowable Values: 1 char min |
note
string
|
Additional information on the adjustment. Allowable Values: |
reason
string
|
Reason for the adjustment.
Allowable Values:
|
Response body
Copy section link
| Fields | Description |
|---|---|
token
string
|
Unique identifier of the adjustment. If in the Allowable Values: 36 char max |
account_token
string
|
Unique identifier of the credit account on which the adjustment was made. Allowable Values: 36 char max Existing credit account token |
type
string
|
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:
|
original_ledger_entry_token
uuid
|
Unique identifier of the original journal entry needing the adjustment. Allowable Values: Existing journal entry token |
external_adjustment_id
uuid
|
Unique identifier you provide of an associated external adjustment that exists outside the Marqeta platform. Allowable Values: |
detail_token
string
|
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
|
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 Disputes return dispute details. For the specific fields returned, see the dispute response fields. Allowable Values: |
related_detail_token
string
|
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
|
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
|
Amount of the adjustment. Allowable Values: |
currency_code
string
|
A valid three-digit ISO 4217 currency code Allowable Values:
|
description
string
|
Description of the adjustment. Allowable Values: 1 char min |
note
string
|
Additional information on the adjustment. Allowable Values: |
reason
string
|
Reason for the adjustment.
Allowable Values:
|
List account adjustments
Copy section link
Action: GET
Endpoint: /credit/accounts/{account_token}/adjustments
Retrieve an array of adjustments for a credit account.
This endpoint supports pagination.
URL path parameters
Copy section link
| Fields | Description |
|---|---|
account_token
string
|
The unique identifier of the credit account for which you want to retrieve adjustments. Send a Allowable Values: |
URL query parameters
Copy section link
| Fields | Description |
|---|---|
count
integer
|
The number of resources to retrieve Allowable Values: 1–100 |
start_index
integer
|
The sort order index of the first resource in the returned array. Allowable Values: 0 min |
Response body
Copy section link
| Fields | Description |
|---|---|
count
integer
|
The number of resources returned. Allowable Values: |
start_index
integer
|
The sort order index of the first resource in the returned array. Allowable Values: Any integer |
end_index
integer
|
The |