Ledger Entries
Important
This feature is being deprecated and replaced by journal entries.
For documentation on journal entries, see:
-
About Credit Account Journal Entries - Developer guide
-
Journal Entries - API reference
-
Credit journal entry event types - Webhook notifications.
Use the /credit/accounts/{account_token}/ledgerentries endpoint to retrieve ledger entries made on an account on Marqeta’s credit platform.
A ledger entry is a record of an entry made on an account ledger, such as a purchase transaction, fee, adjustment, and more. For more on the different types of ledger entries, see About Credit Account Ledger Entries.
Ledger entries originate when a ledger entry event occurs, such as a cardholder making a purchase or an account holder making a payment. To receive webhook notifications when ledger entry events occur, see Credit ledger entry events in Event Types.
List account ledger entries
Copy section link
Action: GET
Endpoint: /credit/accounts/{account_token}/ledgerentries
Retrieve an array of ledger 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 ledger 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
|
Sort order index of the first resource in the returned array. Allowable Values: 0 min |
start_date
date
|
The starting date of the date range from which to return ledger entries. Allowable Values: Example: 2019-01-01 Format: yyyy-MM-dd or yyyy-MM-ddThh:mm:ssZ |
end_date
date
|
The ending date of the date range from which to return ledger entries. Allowable Values: Example: 2019-01-01 Format: yyyy-MM-dd or yyyy-MM-ddThh:mm:ssZ |
statuses
array of strings
|
An array of statuses by which to filter ledger entries. Allowable Values: A valid ledger entry status |
description
string
|
The description of the ledger entries to return. Allowable Values: 255 char max |
groups
array of strings
|
An array of groups by which to filter ledger entries. To return all ledger entry groups, do not include this query parameter. Allowable Values: A valid ledger entry group |
amount
decimal
|
The number of ledger entries to return. Allowable Values: Any integer |
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 ledger entries on a credit account. Allowable Values: One or more ledger entry objects |
data[].token
string
|
Unique identifier of the ledger entry. Allowable Values: 36 char max |
data[].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 |
data[].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 |
data[].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 |
data[].card_token
string
|
Unique identifier of the credit card used to make the ledger entry. Allowable Values: 8–36 chars Existing credit card token |
data[].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:
|
data[].group
string
|
Group to which the ledger entry belongs. Allowable Values:
|
data[].type
string
|
The ledger entry event type. Allowable Values: Example: A valid ledger entry event type |
data[].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 |
data[].amount
decimal
|
Amount of the ledger 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 ledger 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 ledger entry. For other ledger entry groups, equivalent to Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
data[].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 |
data[].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 |
data[].dispute_token
string
|
Unique identifier of the dispute, if the ledger entry is disputed. Allowable Values: Existing dispute token |
data[].detail_token
string
|
Unique identifier of the ledger entry’s full details. Allowable Values: 36 char max |
data[].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 |
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 |
Retrieve account ledger entry
Copy section link
Action: GET
Endpoint: /credit/accounts/{account_token}/ledgerentries/{ledger_entry_token}
Retrieve a ledger 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 ledger entries. Send a Allowable Values: Existing account token |
ledger_entry_token
string
|
The unique identifier of the ledger entry you want to retrieve. Send a Allowable Values: Existing ledger entry token |
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 |
Sample response body
Copy section link
The following code block shows a sample PURCHASE ledger entry.
The following code block shows a sample interest ledger entry.
The following code block shows a sample fee ledger entry.
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.