Statements
Use the statements endpoints to retrieve statement information or statement files 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
Copy section link
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
Copy section link
| Fields | Description |
|---|---|
account_token
string
|
The unique identifier of the credit account for which you want to retrieve statement summaries. Send a Allowable Values: Existing account token |
URL query parameters
Copy section link
| Fields | Description |
|---|---|
start_date
datetime
|
Returns statements with a matching opening date. If both Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
end_date
datetime
|
Returns statements with a matching closing date. If both Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
count
integer
|
The number of resources to retrieve. Allowable Values: 1–100 |
start_index
integer
|
Sort order index of the first resource in the returned array. Allowable Values: 0 min |
sort_by
string
|
Field on which to sort.
Prefix the field name with a hyphen ( NOTE:
You must sort using system field names such as Allowable Values:
|
Response body
Copy section link
| Fields | Description |
|---|---|
count
integer
|
Number of resources returned. Allowable Values: 1-10 |
start_index
integer
|
Sort order index of the first resource in the returned array. Allowable Values: Any integer |
end_index
integer
|
Sort order index of the last resource in the returned array. Allowable Values: Any integer |
is_more
boolean
|
A value of Allowable Values:
|
data
array of objects
|
One or more statement summaries. Allowable Values: One or more statement summary objects |
data[].token
uuid
|
Unique identifier of the statement summary. Allowable Values: 36 char max |
data[].account_token
string
|
Unique identifier of the credit account on which the statement summary is generated. Allowable Values: 36 char max Existing account token |
data[].opening_balance
decimal
|
Balance of the credit account when the statement period began. Allowable Values: Format: 0.00 |
data[].closing_balance
decimal
|
Balance of the credit account when the statement period ended. Allowable Values: Format: 0.00 |
data[].credit_limit
decimal
|
Maximum balance the credit account can carry, as of the statement closing date. Allowable Values: Format: 0.00 |
data[].available_credit
decimal
|
Amount available to spend on the credit account, as of the statement closing date. Allowable Values: Format: 0.00 |
data[].past_due_amount
decimal
|
Total payment amount, required to make the account current. Allowable Values: Format: 0.00 |
data[].purchases
decimal
|
Total amount of purchases made during the statement period. Allowable Values: Format: 0.00 |
data[].interest
decimal
|
Total amount of interest charged during the statement period. Allowable Values: Format: 0.00 |
data[].fees
decimal
|
Total amount of fees charged during the statement period. Does not include periodic fees. Allowable Values: Format: 0.00 |
data[].credits
decimal
|
Total amount of credits received during the statement period. Allowable Values: Format: 0.00 |
data[].payments
decimal
|
Total amount of payments made during the statement period. Allowable Values: Format: 0.00 |
data[].days_in_billing_cycle
integer
|
Number of days in the billing cycle, also known as the statement period. Allowable Values: Any integer |
data[].cycle_type
string
|
Type of cycle.
Allowable Values:
|
data[].opening_date
datetime
|
Date and time when the statement period began. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
data[].closing_date
datetime
|
Date and time when the statement period ended. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
data[].created_time
datetime
|
Date and time when the statement summary was created on Marqeta’s credit platform, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
Retrieve account statement summary
Copy section link
Action: GET
Endpoint: /credit/accounts/{account_token}/statements/{statement_summary_token}
Retrieve a statement summary 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 statement summary. Send a Allowable Values: Existing account token |
statement_summary_token
string
|
The unique identifier of the statement summary to retrieve. Send a Allowable Values: Existing statement summary token |
Response body
Copy section link
| Fields | Description |
|---|---|
token
uuid
|
Unique identifier of the statement summary. Allowable Values: 36 char max |
account_token
string
|
Unique identifier of the credit account on which the statement summary is generated. Allowable Values: 36 char max Existing account token |
opening_balance
decimal
|
Balance of the credit account when the statement period began. Allowable Values: Format: 0.00 |
closing_balance
decimal
|
Balance of the credit account when the statement period ended. Allowable Values: Format: 0.00 |
credit_limit
decimal
|
Maximum balance the credit account can carry, as of the statement closing date. Allowable Values: Format: 0.00 |
available_credit
decimal
|
Amount available to spend on the credit account, as of the statement closing date. Allowable Values: Format: 0.00 |
past_due_amount
decimal
|
Total payment amount, required to make the account current. Allowable Values: Format: 0.00 |
purchases
decimal
|
Total amount of purchases made during the statement period. Allowable Values: Format: 0.00 |
interest
decimal
|
Total amount of interest charged during the statement period. Allowable Values: Format: 0.00 |
fees
decimal
|
Total amount of fees charged during the statement period. Does not include periodic fees. Allowable Values: Format: 0.00 |
credits
decimal
|
Total amount of credits received during the statement period. Allowable Values: Format: 0.00 |
payments
decimal
|
Total amount of payments made during the statement period. Allowable Values: Format: 0.00 |
days_in_billing_cycle
integer
|
Number of days in the billing cycle, also known as the statement period. Allowable Values: Any integer |
cycle_type
string
|
Type of cycle.
Allowable Values:
|
opening_date
datetime
|
Date and time when the statement period began. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
closing_date
datetime
|
Date and time when the statement period ended. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
created_time
datetime
|
Date and time when the statement summary was created on Marqeta’s credit platform, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
Retrieve account statement payment information
Copy section link
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
Copy section link
| Fields | Description |
|---|---|
account_token
string
|
The unique identifier of the credit account for which you want to retrieve the statement payment information. Send a Allowable Values: Existing account token |
statement_summary_token
string
|
The unique identifier of the statement summary from which to retrieve the payment information. Send a Allowable Values: Existing statement summary token |
Response body
Copy section link
| Fields | Description |
|---|---|
token
uuid
|
Unique identifier of the statement payment. Allowable Values: 36 char max |
statement_summary_token
uuid
|
Unique identifier of the statement summary. Allowable Values: Existing statement summary token |
new_statement_balance
decimal
|
Balance on the credit account when the statement period ended. Allowable Values: Format: 0.00 |
minimum_payment_due
decimal
|
Minimum payment amount for the current statement period, based on the associated credit product settings. Allowable Values: Format: 0.00 |
payment_due_date
datetime
|
Payment due date, based on the credit account settings. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
payment_cutoff_date
datetime
|
Last day a payment can be made before interest and fees are charged to the account. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
three_year_savings
decimal
|
Savings amount if the balance is paid off in three years versus only making minimum payments. Allowable Values: Format: 0.00 |
warnings
array of objects
|
One or more payoff warnings. Allowable Values: One or more |
warnings[].type
string
|
Type of statement warning.
Allowable Values:
|
warnings[].total_paid
decimal
|
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: Format: 0.00 |
warnings[].interest_paid
decimal
|
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: Format: 0.00 |
warnings[].monthly_payment
decimal
|
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: Format: 0.00 |
warnings[].pay_off_period
integer
|
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
|
Time unit of the pay off period. Allowable Values:
|
warnings[].disclosure
string
|
Statement disclosure in the case of negative or no amortization, or no lifetime repayment for the minimum payment warning type.
Allowable Values:
|
created_time
datetime
|
Date and time when the statement payment information was created on Marqeta’s credit platform, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
List account statement journal entries
Copy section link
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
Copy section link
| Fields | Description |
|---|---|
account_token
string
|
The unique identifier of the credit account for which to retrieve the statement journal entries. Send a Allowable Values: Existing account token |
statement_summary_token
string
|
The unique identifier of the statement summary from which to retrieve journal entries. Send a Allowable Values: Existing statement summary token |
URL query parameters
Copy section link
| Fields | Description |
|---|---|
count
integer
|
Specifies the number of journal entries to return. Allowable Values: 1–100 |
start_index
integer
|
Specifies the sort order index from which to begin returning journal entries. Allowable Values: 0 min |
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:
|
Response body
Copy section link
| Fields | Description |
|---|---|
count
integer
|
Number of resources returned. Allowable Values: 1-10 |
start_index
integer
|
Sort order index of the first resource in the returned array. Allowable Values: Any integer |
end_index
integer
|
Sort order index of the last resource in the returned array. Allowable Values: Any integer |
is_more
boolean
|
A value of Allowable Values:
|
data
array of objects
|
Contains one or more journal entries on a credit account. Allowable Values: One or more journal entry objects |
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 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
|
Status of the journal entry when it was initially recorded and had an impact on the balance, either To view the current status of purchases, refunds, OCTs, and payments, see the Journal entries that are final transactions, such as clearings, start and remain in a 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: Example: A valid journal entry event type |
data[].id
string
|
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
|
Amount of the journal entry. Allowable Values: Format: 0.00 |
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 groups, equivalent to Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
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-ddThh:mm:ssZ |
data[].created_time
datetime
|
Date and time when the journal entry was created on Marqeta’s credit platform, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
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 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
|
Unique identifier of the interest charge or fee. If in the Returned for interest or fees. 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 fees. Allowable Values: 36 char max Existing account token |
data[].detail_object.type
string
|
Type of fee. Returned for fees. Allowable Values:
|
data[].detail_object.method
string
|
Method used to calculate the fee value. Returned for fees. Allowable Values:
|
data[].detail_object.value
decimal
|
Value of the fee configured on the account. Equivalent to Returned for fees. Allowable Values: Format: 0.00 |
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 fees. Allowable Values: Format: 0.00 |
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 fees. NOTE: This field is currently not supported and returns Allowable Values: Format: 0.00 |
data[].detail_object.description
string
|
Description of the fee. Returned for fees. Allowable Values: 255 char max |
data[].detail_object.created
datetime
|
Date and time when the fee was created. Returned for fees. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
data[].detail_object.statement_token
string
|
Unique identifier of the statement summary from which you want to retrieve interest details. Returned for interest. 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. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
data[].detail_object.statement_closing_date
datetime
|
Closing date of the statement summary from which you want to retrieve interest details. Returned for interest. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
data[].detail_object.statement_balance
decimal
|
Balance on the statement summary from which you want to retrieve interest details. Returned for interest. Allowable Values: Format: 0.00 |
data[].detail_object.average_daily_balance
decimal
|
Average daily balance used to calculate interest. Returned for interest. Allowable Values: Format: 0.00 |
data[].detail_object.goto_apr
decimal
|
Annual percentage rate. Returned for interest. Allowable Values: 0–100 |
data[].detail_object.daily_periodic_rate
decimal
|
Daily rate used to calculate interest. Returned for interest. Allowable Values: 0–100 |
data[].detail_object.days_in_billing_cycle
integer
|
Number of days in the billing cycle. Returned for interest. Allowable Values: 1–31 |
data[].detail_object.interest_amount
decimal
|
Amount of interest calculated for the billing period. Returned for interest. Allowable Values: Format: 0.00 |
data[].detail_object.created_date
datetime
|
Date and time when the interest was created. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
data[].detail_object.updated_date
datetime
|
Date and time when the interest was last updated. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
List account statement ledger entries
Copy section link
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
Copy section link
| Fields | Description |
|---|---|
account_token
string
|
The unique identifier of the credit account for which to retrieve the statement ledger entries. Send a Allowable Values: Existing account token |
statement_summary_token
string
|
The unique identifier of the statement summary from which to retrieve ledger entries. Send a Allowable Values: Existing statement summary token |
URL query parameters
Copy section link
| Fields | Description |
|---|---|
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:
|
Response body
Copy section link
| Fields | Description |
|---|---|
token
string
|
Unique identifier of the ledger entry. Allowable Values: 36 char max |
related_token
string
|
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
|
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
|
Unique identifier of the credit account associated with the credit card used to make the ledger entry. Allowable Values: Existing account token |
card_token
string
|
Unique identifier of the credit card used to make the ledger entry. Allowable Values: 8–36 chars Existing credit card token |
status
string
|
Status of the ledger entry when it was initially recorded and had an impact on the balance, either To view the current status of purchases, refunds, OCTs, and payments, see the Ledger entries that are final transactions, such as clearings, start and remain in a NOTE:
Allowable Values:
|
group
string
|
Group to which the ledger entry belongs. Allowable Values:
|
type
string
|
The ledger entry event type. Allowable Values: Example: A valid ledger entry event type |
id
string
|
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
|
Amount of the ledger entry. Allowable Values: Format: 0.00 |
currency_code
string
|
A valid three-digit ISO 4217 currency code Allowable Values:
|
memo
string
|
Merchant name or description for the ledger 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 ledger entry. For other ledger entry groups, equivalent to Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
impact_time
datetime
|
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-ddThh:mm:ssZ |
created_time
datetime
|
Date and time when the ledger entry was created on Marqeta’s credit platform, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
dispute_token
string
|
Unique identifier of the dispute, if the ledger entry is disputed. Allowable Values: Existing dispute token |
detail_token
string
|
Unique identifier of the ledger entry’s full details. Allowable Values: 36 char max |
detail_object
object
|
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
|
Unique identifier of the interest charge or fee. If in the Returned for interest or fees. 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 fees. Allowable Values: 36 char max Existing account token |
detail_object.type
string
|
Type of fee. Returned for fees. Allowable Values:
|
detail_object.method
string
|
Method used to calculate the fee value. Returned for fees. Allowable Values:
|
detail_object.value
decimal
|
Value of the fee configured on the account. Equivalent to Returned for fees. Allowable Values: Format: 0.00 |
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 fees. Allowable Values: Format: 0.00 |
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 fees. NOTE: This field is currently not supported and returns Allowable Values: Format: 0.00 |
detail_object.description
string
|
Description of the fee. Returned for fees. Allowable Values: 255 char max |
detail_object.created
datetime
|
Date and time when the fee was created. Returned for fees. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
detail_object.statement_token
string
|
Unique identifier of the statement summary from which you want to retrieve interest details. Returned for interest. 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. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
detail_object.statement_closing_date
datetime
|
Closing date of the statement summary from which you want to retrieve interest details. Returned for interest. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
detail_object.statement_balance
decimal
|
Balance on the statement summary from which you want to retrieve interest details. Returned for interest. Allowable Values: Format: 0.00 |
detail_object.average_daily_balance
decimal
|
Average daily balance used to calculate interest. Returned for interest. Allowable Values: Format: 0.00 |
detail_object.goto_apr
decimal
|
Annual percentage rate. Returned for interest. Allowable Values: 0–100 |
detail_object.daily_periodic_rate
decimal
|
Daily rate used to calculate interest. Returned for interest. Allowable Values: 0–100 |
detail_object.days_in_billing_cycle
integer
|
Number of days in the billing cycle. Returned for interest. Allowable Values: 1–31 |
detail_object.interest_amount
decimal
|
Amount of interest calculated for the billing period. Returned for interest. Allowable Values: Format: 0.00 |
detail_object.created_date
datetime
|
Date and time when the interest was created. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
detail_object.updated_date
datetime
|
Date and time when the interest was last updated. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
Retrieve account statement interest charges
Copy section link
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
Copy section link
| Fields | Description |
|---|---|
account_token
string
|
The unique identifier of the credit account for which you want to retrieve the statement interest charges. Send a Allowable Values: Existing account token |
statement_summary_token
string
|
The unique identifier of the statement summary from which to retrieve the interest charges. Send a Allowable Values: Existing statement summary token |
Response body
Copy section link
| Fields | Description |
|---|---|
account_token
string
|
Unique identifier of the credit account on which the statement interest charge is generated. Allowable Values: 36 char max |
statement_summary_token
string
|
Unique identifier of the statement summary. Allowable Values: Existing statement summary token |
data
array of objects
|
Contains one or more interest charges on a statement. Allowable Values: One or more interest charge objects |
data[].balance_type
string
|
Type of balance.
Allowable Values:
|
data[].apr_value
decimal
|
Annual percentage rate. Allowable Values: 0–100 |
data[].apr_type
string
|
Type of APR. Allowable Values:
|
data[].balance_subject_to_interest_rate
decimal
|
Average daily balance used to calculate interest. Allowable Values: Format: 0.00 |
data[].amount
decimal
|
Amount of interest calculated for the billing period. Allowable Values: Format: 0.00 |
Retrieve account statement rewards
Copy section link
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
Copy section link
| Fields | Description |
|---|---|
account_token
string
|
The unique identifier of the credit account from which to retrieve statement rewards. Send a Allowable Values: Existing account token |
statement_summary_token
string
|
The unique identifier of the statement summary from which to retrieve rewards. Send a Allowable Values: Existing statement summary token |
Response body
Copy section link
| Fields | Description |
|---|---|
token
string
|
Unique identifier of the rewards for a specific statement. Allowable Values: 36 char max |
previous_billing_cycle_reward
decimal
|
Amount of rewards received in the previous billing cycle. Allowable Values: Format: 0.00 |
current_billing_cycle_reward
decimal
|
Amount of rewards received in the current billing cycle. Allowable Values: Format: 0.00 |
created_time
datetime
|
Date and time when the statement reward was created on Marqeta’s credit platform, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
Retrieve account statement year-to-date totals
Copy section link
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
Copy section link
| Fields | Description |
|---|---|
account_token
string
|
The unique identifier of the credit account from which to retrieve statement year-to-date totals. Send a Allowable Values: Existing account token |
statement_summary_token
string
|
The unique identifier of the statement summary from which to retrieve year-to-date totals. Send a Allowable Values: Existing statement summary token |
Response body
Copy section link
| Fields | Description |
|---|---|
token
uuid
|
Unique identifier of the year-to-date total. Allowable Values: 36 char max |
account_token
string
|
Unique identifier of the associated credit account. Allowable Values: 36 char max Existing account token |
statement_token
uuid
|
Unique identifier of the statement summary from which to retrieve year-to-date totals. Allowable Values: Existing statement summary token |
total_fees
decimal
|
Total fees charged year-to-date. Allowable Values: Format: 0.00 |
total_interest
decimal
|
Total interest charged year-to-date. Allowable Values: Format: 0.00 |
created_time
datetime
|
Date and time when the year-to-date total was created on Marqeta’s credit platform, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
List files for a statement summary
Copy section link
Action: GET
Endpoint: /credit/accounts/{account_token}/statements/{statement_summary_token}/files
Retrieve an array of statement files for a specific statement summary.
URL path parameters
Copy section link
| Fields | Description |
|---|---|
account_token
string
|
The unique identifier of the credit account for which to retrieve statement files for a statement summary. Send a Allowable Values: Existing account token |
statement_summary_token
string
|
The unique identifier of the statement summary whose statement files you want to retrieve. Send a Allowable Values: Existing statement summary token |
URL query parameters
Copy section link
| Fields | Description |
|---|---|
count
integer
|
The number of statement files to return. Allowable Values: 1–100 |
start_index
integer
|
Sort order index from which to begin returning files. Allowable Values: 0 min |
Response body
Copy section link
| Fields | Description |
|---|---|
count
integer
|
Number of resources returned. Allowable Values: 1-10 |
start_index
integer
|
Sort order index of the first resource in the returned array. Allowable Values: Any integer |
end_index
integer
|
Sort order index of the last resource in the returned array. Allowable Values: Any integer |
is_more
boolean
|
A value of Allowable Values:
|
data
array of objects
|
List of statement files. Allowable Values: One or more statement files |
data[].token
string
|
Unique identifier of the statement file. Allowable Values: 36 char max |
data[].account_token
string
|
Unique identifier of the credit account on which the statement PDF file is generated. Allowable Values: 36 char max Existing account token |
data[].statement_summary_token
uuid
|
Unique identifier of the statement summary. Allowable Values: Existing statement summary token |
data[].opening_date
datetime
|
Date and time when the statement period began. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
data[].closing_date
datetime
|
Date and time when the statement period ended. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
data[].signed_url
string
|
The signed URL to retrieve the statement PDF file. Allowable Values: A valid signed URL |
data[].type
string
|
Type of file. Allowable Values:
|
List files for an account
Copy section link
Action: GET
Endpoint: /credit/accounts/{account_token}/statements/files
Retrieve an array of statement files for a specific credit account.
URL path parameters
Copy section link
| Fields | Description |
|---|---|
account_token
string
|
The unique identifier of the credit account for which to retrieve statement files. Send a Allowable Values: Existing account token |
URL query parameters
Copy section link
| Fields | Description |
|---|---|
start_date
datetime
|
The start date of the statement files to return. Allowable Values: Example: 2020-01-01T00:00:00Z |
end_date
datetime
|
The end date of the statement files to return. Allowable Values: Example: 2020-03-01T03:59:59Z |
count
integer
|
The number of resources to retrieve. Allowable Values: 1–100 |
start_index
integer
|
Sort order index of the first resource in the returned array. Allowable Values: 0 min |
sort_by
string
|
Field on which to sort.
Prefix the field name with a hyphen ( NOTE:
You must sort using system field names such as Allowable Values:
|
Response body
Copy section link
| Fields | Description |
|---|---|
count
integer
|
Number of resources returned. Allowable Values: 1-10 |
start_index
integer
|
Sort order index of the first resource in the returned array. Allowable Values: Any integer |
end_index
integer
|
Sort order index of the last resource in the returned array. Allowable Values: Any integer |
is_more
boolean
|
A value of Allowable Values:
|
data
array of objects
|
List of statement files. Allowable Values: One or more statement files |
data[].token
string
|
Unique identifier of the statement file. Allowable Values: 36 char max |
data[].account_token
string
|
Unique identifier of the credit account on which the statement PDF file is generated. Allowable Values: 36 char max Existing account token |
data[].statement_summary_token
uuid
|
Unique identifier of the statement summary. Allowable Values: Existing statement summary token |
data[].opening_date
datetime
|
Date and time when the statement period began. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
data[].closing_date
datetime
|
Date and time when the statement period ended. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
data[].signed_url
string
|
The signed URL to retrieve the statement PDF file. Allowable Values: A valid signed URL |
data[].type
string
|
Type of file. Allowable Values:
|
Resend credit event notification
Copy section link
Action: POST
Endpoint: /credit/webhooks/{event_type}/{resource_token}
Resends a credit event notification to your webhook endpoint.
Although you send this request as a POST, all parameters are passed in the URL and the body is empty.
The event notification is resent to your webhook endpoint and also returned in the response to this request.
For details on how to configure your webhook endpoint, see the About Webhooks tutorial.
For the complete /webhooks endpoint reference, see Webhooks.
URL path parameters
Copy section link
| Fields | Description |
|---|---|
event_type
string
|
Specifies the type of event you want to resend. Allowable Values:
|
resource_token
string
|
The unique identifier of the resource for which you want to resend a notification. Send a Send a Send a Send a Send a Send a Allowable Values: Existing journal entry token, ledger entry token, account transition token, payment transition token, statement summary token, or delinquency transition token |
Response body
Copy section link
| Fields | Description |
|---|---|
unused
string
|
The event notification that was resent to your webhook endpoint. Allowable Values: Valid event notification |
Sample response body
Copy section link
The following code block shows a sample of a resent creditaccounttransitions event.
The following code block shows a sample of a resent creditaccountstatements event.
The following code block shows a sample of a resent creditjournalentries event.
The following code block shows a sample of a resent creditledgerentries event.
The following code block shows a sample of a resent creditpaymenttransitions event.
The following code block shows a sample of a resent creditdelinquencytransitions event.