/
40 minute read
September 1, 2022

Statements

Use the /credit/accounts/{account_token}/statements endpoint to retrieve the statements generated for a credit account.

An account statement contains a summary of account activity that occurred during a billing cycle. For more on statements, see About Credit Account Statements.

To receive a webhook notification when a statement is created, see Credit account statement event in Event Types.

List account statement summaries

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

Retrieve an array of statement summaries tied to a cardholder’s account.

The statement summary, which is a summary of account activity on a statement, provides account holders with a synopsis of activity that occurred on the account during a specified billing cycle.

This endpoint supports sorting and pagination. You can use optional query parameters to return a statement based on its exact opening or closing date, or a statement whose closing date falls within a range of dates.

URL path parameters
Fields Description

account_token

string
Required

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

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

Allowable Values:

Existing account token

URL query parameters
Fields Description

start_date

datetime
Optional

Returns statements with a matching opening date.

If both start_date and end_date are specified, statements whose closing date falls between the start and end dates are returned.

Allowable Values:

Example: 2020-01-01T00:00:00Z

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

end_date

datetime
Optional

Returns statements with a matching closing date.

If both start_date and end_date are specified, statements whose closing date falls between the start and end dates are returned.

Allowable Values:

Example: 2020-03-01T03:59:59Z

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

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

One or more statement summaries.

Allowable Values:

One or more statement summary objects

data[].token

uuid
Returned

Unique identifier of the statement summary.

Allowable Values:

36 char max

data[].account_token

string
Returned

Unique identifier of the credit account on which the statement summary is generated.

Allowable Values:

36 char max

Existing credit account token

data[].opening_balance

decimal
Returned

Balance of the credit account when the statement period began.

Allowable Values:

Format: 0.00

data[].closing_balance

decimal
Returned

Balance of the credit account when the statement period ended.

Allowable Values:

Format: 0.00

data[].credit_limit

decimal
Conditionally returned

Maximum balance the credit account can carry, as of the statement closing date.

Allowable Values:

Format: 0.00

data[].available_credit

decimal
Returned

Amount available to spend on the credit account, as of the statement closing date.

Allowable Values:

Format: 0.00

data[].past_due_amount

decimal
Returned

Total payment amount, required to make the account current.

Allowable Values:

Format: 0.00

data[].purchases

decimal
Returned

Total amount of purchases made during the statement period.

Allowable Values:

Format: 0.00

data[].interest

decimal
Returned

Total amount of interest charged during the statement period.

Allowable Values:

Format: 0.00

data[].fees

decimal
Returned

Total amount of fees charged during the statement period. Does not include periodic fees.

Allowable Values:

Format: 0.00

data[].credits

decimal
Returned

Total amount of credits received during the statement period.

Allowable Values:

Format: 0.00

data[].payments

decimal
Returned

Total amount of payments made during the statement period.

Allowable Values:

Format: 0.00

data[].days_in_billing_cycle

integer
Returned

Number of days in the billing cycle, also known as the statement period.

Allowable Values:

Any integer

data[].cycle_type

string
Returned

Type of cycle.

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

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

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

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

Allowable Values:

BEGINNING_REVOLVING, REVOLVING, END_REVOLVING, TRANSACTING

When creating an account, only TRANSACTING is allowed.

data[].opening_date

datetime
Returned

Date and time when the statement period began.

Allowable Values:

Example: 2020-01-01T00:00:00Z

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

data[].closing_date

datetime
Returned

Date and time when the statement period ended.

Allowable Values:

Example: 2020-01-01T00:00:00Z

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

data[].created_time

datetime
Returned

Date and time when the statement summary was created on Marqeta’s credit platform.

Allowable Values:

Example: 2020-01-01T00:00:00Z

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

Sample response body
JSON
Copied

Is this helpful?

Yes
No

Retrieve account statement summary

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

Retrieve a statement summary 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 statement summary.

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

Allowable Values:

Existing account token

statement_summary_token

string
Required

The unique identifier of the statement summary to retrieve.

Send a GET request to /credit/accounts/{token}/statements/ to retrieve existing statement summary tokens.

Allowable Values:

Existing statement summary token

Response body
Fields Description

token

uuid
Returned

Unique identifier of the statement summary.

Allowable Values:

36 char max

account_token

string
Returned

Unique identifier of the credit account on which the statement summary is generated.

Allowable Values:

36 char max

Existing credit account token

opening_balance

decimal
Returned

Balance of the credit account when the statement period began.

Allowable Values:

Format: 0.00

closing_balance

decimal
Returned

Balance of the credit account when the statement period ended.

Allowable Values:

Format: 0.00

credit_limit

decimal
Conditionally returned

Maximum balance the credit account can carry, as of the statement closing date.

Allowable Values:

Format: 0.00

available_credit

decimal
Returned

Amount available to spend on the credit account, as of the statement closing date.

Allowable Values:

Format: 0.00

past_due_amount

decimal
Returned

Total payment amount, required to make the account current.

Allowable Values:

Format: 0.00

purchases

decimal
Returned

Total amount of purchases made during the statement period.

Allowable Values:

Format: 0.00

interest

decimal
Returned

Total amount of interest charged during the statement period.

Allowable Values:

Format: 0.00

fees

decimal
Returned

Total amount of fees charged during the statement period. Does not include periodic fees.

Allowable Values:

Format: 0.00

credits

decimal
Returned

Total amount of credits received during the statement period.

Allowable Values:

Format: 0.00

payments

decimal
Returned

Total amount of payments made during the statement period.

Allowable Values:

Format: 0.00

days_in_billing_cycle

integer
Returned

Number of days in the billing cycle, also known as the statement period.

Allowable Values:

Any integer

cycle_type

string
Returned

Type of cycle.

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

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

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

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

Allowable Values:

BEGINNING_REVOLVING, REVOLVING, END_REVOLVING, TRANSACTING

When creating an account, only TRANSACTING is allowed.

opening_date

datetime
Returned

Date and time when the statement period began.

Allowable Values:

Example: 2020-01-01T00:00:00Z

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

closing_date

datetime
Returned

Date and time when the statement period ended.

Allowable Values:

Example: 2020-01-01T00:00:00Z

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

created_time

datetime
Returned

Date and time when the statement summary was created on Marqeta’s credit platform.

Allowable Values:

Example: 2020-01-01T00:00:00Z

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

Sample response body
JSON
Copied

Is this helpful?

Yes
No

Retrieve account statement payment information

Action: GET
Endpoint: /credit/accounts/{account_token}/statements/{statement_summary_token}/paymentinfo

Retrieve the payment information on a credit account’s statement summary.

URL path parameters
Fields Description

account_token

string
Required

The unique identifier of the credit account for which you want to retrieve the statement payment information.

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

Allowable Values:

Existing account token

statement_summary_token

string
Required

The unique identifier of the statement summary from which to retrieve the payment information.

Send a GET request to /credit/accounts/{token}/statements/ to retrieve existing statement summary tokens.

Allowable Values:

Existing statement summary token

Response body
Fields Description

token

uuid
Conditionally returned

Unique identifier of the statement payment.

Allowable Values:

36 char max

statement_summary_token

uuid
Conditionally returned

Unique identifier of the statement summary.

Allowable Values:

Existing statement summary token

new_statement_balance

decimal
Conditionally returned

Balance on the credit account when the statement period ended.

Allowable Values:

minimum_payment_due

decimal
Conditionally returned

Minimum payment amount for the current statement period, based on the associated credit product settings.

Allowable Values:

payment_due_date

datetime
Conditionally returned

Payment due date, based on the credit account settings.

Allowable Values:

payment_cutoff_date

datetime
Conditionally returned

Last day a payment can be made before interest and fees are charged to the account.

Allowable Values:

three_year_savings

decimal
Conditionally returned

Savings amount if the balance is paid off in three years versus only making minimum payments.

Allowable Values:

warnings

array of objects
Conditionally returned

One or more payoff warnings.

Allowable Values:

warnings[].type

string
Conditionally returned

Type of statement warning.

  • MIN_PAYMENT - Displays the total estimated payment amount and how long it would take to pay off the statement balance if only making minimum payments.

  • 3_YEAR - Displays the monthly payment amount and total estimated payment amount if paying off the statement balance in three years.

Allowable Values:

MIN_PAYMENT, 3_YEAR

warnings[].total_paid

decimal
Conditionally returned

For the minimum payment warning type, this value represents the total amount of principal and interest to pay off the statement balance if only making the minimum payment each month.

For the 3 Year warning type, this value represents the total amount of principal and interest if paying off the statement balance in three years.

Allowable Values:

warnings[].interest_paid

decimal
Conditionally returned

For the minimum payment warning type, this value represents the total amount of interest to pay off the statement balance if only making the minimum payment each month.

For the 3 Year warning type, this value represents the total amount of interest if paying off the statement balance in three years.

Allowable Values:

warnings[].monthly_payment

decimal
Conditionally returned

For the minimum payment warning type, this value is 0.

For the 3 Year warning type, this value represents the fixed monthly payment amount required to pay off the statement balance in three years.

Allowable Values:

warnings[].pay_off_period

integer
Conditionally returned

For the minimum payment warning type, this value represents the number of periods required to pay off the statement balance.

For the 3 Year warning type, this value is 36 (months).

Allowable Values:

1 min

warnings[].period_type

string
Conditionally returned

Time unit of the pay off period.

Allowable Values:

MONTH, YEAR

warnings[].disclosure

string
Conditionally returned

Statement disclosure in the case of negative or no amortization, or no lifetime repayment for the minimum payment warning type.

  • NEGATIVE_OR_NO_AMORTIZATION - Occurs when the interest amount is higher than the minimum payment; results in the outstanding balance remaining in perpetuity.

  • NO_LIFETIME_REPAYMENT - Occurs when the interest amount is just below the minimum payment; results in the outstanding balance taking longer than a lifetime to pay off.

Allowable Values:

NEGATIVE_OR_NO_AMORTIZATION, NO_LIFETIME_REPAYMENT

created_time

datetime
Conditionally returned

Date and time when the statement payment information was created on Marqeta’s credit platform.

Allowable Values:

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

Sample response body
JSON
Copied

Is this helpful?

Yes
No

List account statement journal entries

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

Retrieve an array of journal entries on a credit account’s statement summary.

This endpoint supports sorting.

URL path parameters
Fields Description

account_token

string
Required

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

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

Allowable Values:

Existing account token

statement_summary_token

string
Required

The unique identifier of the statement summary from which to retrieve journal entries.

Send a GET request to /credit/accounts/{token}/statements/ to retrieve existing statement summary tokens.

Allowable Values:

Existing statement summary token

URL query parameters
Fields Description

count

integer
Optional

Specifies the number of journal entries to return.

Allowable Values:

1–100

start_index

integer
Optional

Specifies the sort order index from which to begin returning journal entries.

Allowable Values:

0 min

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

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

Contains one or more journal entries on a credit account.

Allowable Values:

One or more journal entry objects

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

Status of the journal entry when it was initially recorded and had an impact on the balance, either PENDING or POSTED. This field is immutable and may not represent the current status.

To view the current status of purchases, refunds, OCTs, and payments, see the detail_object.state field. These journal entries start in PENDING and can transition to CLEARED, DECLINED, or ERROR. This transition of status is only sent through webhook event notifications.

Journal entries that are final transactions, such as clearings, start and remain in a POSTED state.

NOTE: CLEARED, DECLINED, and ERROR are special statuses that do not have an impact on the account balance, and are not recorded in the journal. For these special statuses, impact_time, request_time, created_time, token, and id are returned blank.

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:

Example: authorization.clearing

data[].id

string
Returned

Eight-digit numeric identifier of the journal entry, an alternate identifier to the UUID that is 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 groups, 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 Marqeta’s credit platform.

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 group.

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

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:

FOREIGN_TRANSACTION_FEE, OVER_LIMIT_FEE, LATE_PAYMENT_FEE, RETURNED_PAYMENT_FEE, CARD_REPLACEMENT_FEE, MINIMUM_INTEREST_FEE, ANNUAL_FEE, MONTHLY_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

List account statement ledger entries

Action: GET
Endpoint: /credit/accounts/{account_token}/statements/{statement_summary_token}/ledgerentries

Important
This feature is being deprecated and replaced by statement journal entries. To list statement journal entries, see List account statement journal entries.

Retrieve an array of ledger entries on a credit account’s statement summary.

This endpoint supports sorting.

URL path parameters
Fields Description

account_token

string
Required

The unique identifier of the credit account for which to retrieve the statement ledger entries.

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

Allowable Values:

Existing account token

statement_summary_token

string
Required

The unique identifier of the statement summary from which to retrieve ledger entries.

Send a GET request to /credit/accounts/{token}/statements/ to retrieve existing statement summary tokens.

Allowable Values:

Existing statement summary token

URL query parameters
Fields Description

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

Allowable Values:

lastModifiedTime, -lastModifiedTime

Response body
Fields Description

token

string
Returned

Unique identifier of the ledger entry.

Allowable Values:

36 char max

related_token

string
Conditionally returned

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

Allowable Values:

Existing ledger entry token

root_token

string
Conditionally returned

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

Allowable Values:

Existing ledger entry token

account_token

string
Returned

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

Allowable Values:

Existing credit account token

card_token

string
Returned

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

Allowable Values:

8–36 chars

Existing credit card token

status

string
Returned

Status of the ledger entry when it was initially recorded and had an impact on the balance, either PENDING or POSTED. This field is immutable and may not represent the current status.

To view the current status of purchases, refunds, OCTs, and payments, see the detail_object.state field. These journal entries start in PENDING and can transition to CLEARED, DECLINED, or ERROR. This transition of status is only sent through webhook event notifications.

Ledger entries that are final transactions, such as clearings, start and remain in a POSTED state.

NOTE: CLEARED, DECLINED, and ERROR are special statuses that do not have an impact on the account balance, and are not recorded in the ledger. For these special statuses, impact_time, request_time, created_time, token, and id are returned blank.

Allowable Values:

PENDING, POSTED, DECLINED, ERROR, CLEARED

group

string
Returned

Group to which the ledger entry belongs.

Allowable Values:

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

type

string
Returned

The ledger entry event type.

Allowable Values:

Example: authorization.clearing

id

string
Returned

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

Allowable Values:

8 chars

amount

decimal
Returned

Amount of the ledger 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 ledger 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 ledger entry.

For other ledger entry groups, equivalent to impact_time.

Allowable Values:

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

impact_time

datetime
Returned

Date and time when the ledger 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 ledger entry was created on Marqeta’s credit platform.

Allowable Values:

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

dispute_token

string
Conditionally returned

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

Allowable Values:

Existing dispute token

detail_token

string
Returned

Unique identifier of the ledger entry’s full details.

Allowable Values:

36 char max

detail_object

object
Conditionally returned

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

The following lists each ledger entry group and the specific fields returned for each group.

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:

FOREIGN_TRANSACTION_FEE, OVER_LIMIT_FEE, LATE_PAYMENT_FEE, RETURNED_PAYMENT_FEE, CARD_REPLACEMENT_FEE, MINIMUM_INTEREST_FEE, ANNUAL_FEE, MONTHLY_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
JSON
Copied

Is this helpful?

Yes
No

Retrieve account statement interest charges

Action: GET
Endpoint: /credit/accounts/{account_token}/statements/{statement_summary_token}/interestcharges

Retrieve the interest charges on a credit account’s statement summary.

URL path parameters
Fields Description

account_token

string
Required

The unique identifier of the credit account for which you want to retrieve the statement interest charges.

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

Allowable Values:

Existing account token

statement_summary_token

string
Required

The unique identifier of the statement summary from which to retrieve the interest charges.

Send a GET request to /credit/accounts/{token}/statements/ to retrieve existing statement summary tokens.

Allowable Values:

Existing statement summary token

Response body
Fields Description

account_token

string
Returned

Unique identifier of the credit account on which the statement interest charge is generated.

Allowable Values:

36 char max

statement_summary_token

string
Returned

Unique identifier of the statement summary.

Allowable Values:

Existing statement summary token

data

array of objects
Returned

Contains one or more interest charges on a statement.

Allowable Values:

One or more interest charge objects

data[].balance_type

string
Conditionally returned

Type of balance.

  • PURCHASE - The balance on purchases.

Allowable Values:

PURCHASE

data[].apr_value

decimal
Conditionally returned

Annual percentage rate.

Allowable Values:

0–100

data[].apr_type

string
Conditionally returned

Type of APR.

Allowable Values:

GO_TO

data[].balance_subject_to_interest_rate

decimal
Conditionally returned

Average daily balance used to calculate interest.

Allowable Values:

data[].amount

decimal
Conditionally returned

Amount of interest calculated for the billing period.

Allowable Values:

Sample response body
JSON
Copied

Is this helpful?

Yes
No

Retrieve account statement rewards

Action: GET
Endpoint: /credit/accounts/{account_token}/statements/{statement_summary_token}/rewards

Retrieve the rewards on a credit account’s statement summary.

URL path parameters
Fields Description

account_token

string
Required

The unique identifier of the credit account from which to retrieve statement rewards.

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

Allowable Values:

Existing account token

statement_summary_token

string
Required

The unique identifier of the statement summary from which to retrieve rewards.

Send a GET request to /credit/accounts/{token}/statements/ to retrieve existing statement summary tokens.

Allowable Values:

Existing statement summary token

Response body
Fields Description

token

string
Conditionally returned

Unique identifier of the rewards for a specific statement.

Allowable Values:

36 char max

previous_billing_cycle_reward

decimal
Conditionally returned

Amount of rewards received in the previous billing cycle.

Allowable Values:

current_billing_cycle_reward

decimal
Conditionally returned

Amount of rewards received in the current billing cycle.

Allowable Values:

created_time

datetime
Conditionally returned

Allowable Values:

Sample response body
JSON
Copied

Is this helpful?

Yes
No

Retrieve account statement year-to-date totals

Action: GET
Endpoint: /credit/accounts/{account_token}/statements/{statement_summary_token}/yeartodate

Retrieve the year-to-date fee and interest totals on a credit account’s statement summary.

URL path parameters
Fields Description

account_token

string
Required

The unique identifier of the credit account from which to retrieve statement year-to-date totals.

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

Allowable Values:

Existing account token

statement_summary_token

string
Required

The unique identifier of the statement summary from which to retrieve year-to-date totals.

Send a GET request to /credit/accounts/{token}/statements/ to retrieve existing statement summary tokens.

Allowable Values:

Existing statement summary token

Response body
Fields Description

token

uuid
Conditionally returned

Unique identifier of the year-to-date total.

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

statement_token

uuid
Returned

Unique identifier of the statement summary from which to retrieve year-to-date totals.

Allowable Values:

Existing statement summary token

total_fees

decimal
Returned

Total fees charged year-to-date.

Allowable Values:

total_interest

decimal
Returned

Total interest charged year-to-date.

Allowable Values:

created_time

datetime
Conditionally returned

Date and time when the year-to-date total was created on Marqeta’s credit platform.

Allowable Values:

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

Sample response body
JSON
Copied

Is this helpful?

Yes
No

List files for a statement summary

Action: GET
Endpoint: /credit/accounts/{account_token}/statements/{statement_summary_token}/files

Retrieve an array of files for a specific statement summary

URL path parameters
Fields Description

account_token

string
Required

The unique identifier of the credit account from which to retrieve statement files.

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

Allowable Values:

Existing account token

statement_summary_token

string
Required

The unique identifier of the statement summary from which to retrieve files.

Send a GET request to /credit/accounts/{token}/statements to retrieve existing statement summary tokens.

Allowable Values:

Existing statement summary token

URL query parameters
Fields Description

count

integer
Optional

The number of statement files to return.

Allowable Values:

1–100

start_index

integer
Optional

The sort order index from which to begin returning files.

Allowable Values:

0 min

Response body
Fields Description

count

integer
Returned

The number of resources returned.

Allowable Values:

1-10

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 statement files.

Allowable Values:

One or more statement files

data[].token

string
Conditionally returned

Unique identifier of the statement file.

Allowable Values:

36 char max

data[].account_token

string
Conditionally returned

Unique identifier of the credit account on which the statement PDF file is generated.

Allowable Values:

36 char max

Existing credit account token

data[].statement_summary_token

uuid
Conditionally returned

Unique identifier of the statement summary.

Allowable Values:

Existing statement summary token

data[].opening_date

datetime
Conditionally returned

Date and time when the statement period began.

Allowable Values:

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

data[].closing_date

datetime
Conditionally returned

Date and time when the statement period ended.

Allowable Values:

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

data[].signed_url

string
Conditionally returned

The signed URL to retrieve the statement PDF file.

Allowable Values:

A valid signed URL

data[].type

string
Conditionally returned

Type of file.

Allowable Values:

STATEMENT_PDF

Sample response body
JSON
Copied

Is this helpful?

Yes
No

List statement files for all statement summaries

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

Retrieve an array of files for all statements for a specific account.

URL path parameters
Fields Description

account_token

string
Required

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

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

Allowable Values:

Existing account token

URL query parameters
Fields Description

start_date

datetime
Optional

The start date of the statement files to return.

Allowable Values:

Example: 2020-01-01T00:00:00Z

end_date

datetime
Optional

The end date of the statement files to return.

Allowable Values:

Example: 2020-03-01T03:59:59Z

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:

1-10

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 statement files.

Allowable Values:

One or more statement files

data[].token

string
Conditionally returned

Unique identifier of the statement file.

Allowable Values:

36 char max

data[].account_token

string
Conditionally returned

Unique identifier of the credit account on which the statement PDF file is generated.

Allowable Values:

36 char max

Existing credit account token

data[].statement_summary_token

uuid
Conditionally returned

Unique identifier of the statement summary.

Allowable Values:

Existing statement summary token

data[].opening_date

datetime
Conditionally returned

Date and time when the statement period began.

Allowable Values:

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

data[].closing_date

datetime
Conditionally returned

Date and time when the statement period ended.

Allowable Values:

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

data[].signed_url

string
Conditionally returned

The signed URL to retrieve the statement PDF file.

Allowable Values:

A valid signed URL

data[].type

string
Conditionally returned

Type of file.

Allowable Values:

STATEMENT_PDF

Sample response body
JSON
Copied

Is this helpful?

Yes
No
Join our developer newsletter