About Credit Account 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
A credit account ledger entry is a record of an entry made on a credit account ledger, such as a purchase transaction, fee, adjustment, and more. Ledger entries originate when a ledger entry event occurs, such as a cardholder making a purchase, which creates purchase ledger entry, or an account holder making a payment past due, which creates a late payment fee ledger entry.
On Marqeta’s credit platform, you can retrieve ledger entries on a credit account by using the /credit/accounts/{account_token}/ledgerentries endpoint.
For the complete endpoint reference, see Credit Account Ledger Entries.
At the end of this guide, you should understand:
-
What ledger entries are and how they originate.
-
What the ledger entry groups.
-
Each ledger entry group’s details and event types.
Ledger entry statuses
Copy section link
Ledger entries can have one of two statuses.
-
PENDING- The ledger entry is pending; the account’s available credit is temporarily decreased in the ledger entry amount. -
POSTED- The ledger entry is posted to the account; the account balance is increased in the ledger entry amount.
Ledger entry groups
Copy section link
Every ledger entry belongs to a group, which is represented by the group field and useful for categorizing ledger entries.
Ledger entries can belong to one of the following groups:
-
PURCHASE -
FEE -
REWARD -
INTEREST -
PAYMENT -
ADJUSTMENT -
BALANCE_REFUND -
ORIGINAL_CREDIT
For more on each group, see their respective sections in this guide.
Ledger entry details
Copy section link
Each ledger entry contains a detail object, which is represented by detail_object and contains fields specific to the ledger entry’s group.
These fields vary based on the group.
For example, a ledger entry belonging to the purchase group returns purchase details, which are fields that come from the card network and are relevant to purchase transactions. A ledger entry belonging to the reward group won’t return purchase details but rather, reward details, which are fields relevant to rewards.
Each ledger entry also contains the detail_token field, which identifies a ledger entry’s details and populates fields in detail_object with values specific to that ledger entry.
Purchases
Copy section link
When a cardholder makes a purchase, a ledger entry belonging to the PURCHASE group is created on the credit account.
Purchase details
Copy section link
When retrieving a purchase ledger entry, purchase details are the fields returned in the detail_object.
These fields come from the card network and are conditionally returned based on the ledger entry’s type.
For more on these fields, see Transactions.
The following code sample shows a ledger entry’s detail_object containing purchase details for an authorization clearing:
Purchase events
Copy section link
Marqeta’s credit platform sends webhook notifications when purchase authorizations and purchase authorization clearings occur. You can configure a webhook to capture the following purchase events:
-
authorization -
authorization.incremental -
refund.authorization -
authorization.clearing -
authorization.reversal -
authorization.advice -
authorization.reversal.issuerexpiration -
refund.authorization.reversal -
refund.authorization.clearing -
refund -
pindebit -
pindebit.authorization.clearing -
pindebit.refund
For more on events, including event descriptions, see Credit ledger entry events. For more on subscribing to webhook notifications, see the About Webhooks tutorial.
Interest
Copy section link
When the conditions that cause an interest charge to be applied on a credit account are met, such as a cardholder carrying a balance from the previous month at the end of a billing period, a ledger entry belonging to the INTEREST group is created on the account.
You can configure interest calculation during credit product creation. For more, see Creating a credit product in Managing Credit Products in the Marqeta Dashboard.
Interest details
Copy section link
When retrieving an interest ledger entry, interest details are the fields that are returned in the detail_object, including interest charge calculation data.
For field descriptions, see the Retrieve account ledger entry response fields.
The following code sample shows a ledger entry’s detail_object containing interest details:
Interest event
Copy section link
Marqeta’s credit platform sends webhook notifications when interest charges are applied on a credit account. You can configure a webhook to capture this interest event:
-
account.interest
For more on events, including event descriptions, see Credit ledger entry events. For more on subscribing to webhook notifications, see the About Webhooks tutorial.
Fees
Copy section link
When the conditions that cause a fee to be applied on a credit account are met, a ledger entry belonging to the FEES group is created on the account.
-
A late payment fee is applied when a payment is made past the payment due date.
-
A returned payment fee is applied when a completed payment is returned.
-
A minimum interest fee is applied when an account is charged interest that is lower than the minimum interest amount.
-
An annual fee is applied when a periodic fee with an annual frequency is configured on a credit program.
-
A monthly fee is applied when a periodic fee with an monthly frequency is configured on a credit program.
When creating a credit product, you can select the fees that you want to include on the product. Then, when creating a credit account based on that product, you can define the selected fees' schedule, method, value, and effective date. You cannot define fees that you did not select during product creation, and only defined fees can be entries on the credit account ledger, provided the conditions to apply the fee are met. For more on including fees during credit product and account creation, see Creating a credit product in Managing Credit Products in the Marqeta Dashboard and Create account in the Credit Accounts API reference.
Fee details
Copy section link
When retrieving a fee ledger entry, fee details are the fields that are returned in the detail_object.
For field descriptions, see the Retrieve account ledger entry response fields.
The following code sample shows a ledger entry’s detail_object containing fee details:
Fee events
Copy section link
Marqeta’s credit platform sends webhook notifications when late payment, returned payment, and minimum interest fees are applied on a credit account. You can configure a webhook to capture the following fee events:
-
account.fee.annual -
account.fee.latepayment -
account.fee.minimum.interest -
account.fee.monthly -
account.fee.returnpayment
For more on events, including event descriptions, see Credit ledger entry events. For more on subscribing to webhook notifications, see the About Webhooks tutorial.
Rewards
Copy section link
When the conditions that cause a reward to be applied on a credit account are met, a ledger entry belonging to the REWARD group is created on the account.
-
A cash back reward is applied as cash back statement credits when a card holder makes a qualifying purchase that results in cash back.
You can create a reward using the /credit/accounts/{account_token}/rewards endpoint.
For the endpoint reference, see Account Rewards.
Reward details
Copy section link
When retrieving a reward ledger entry, reward details are the fields that are returned in the detail_object.
For field descriptions, see the Create account reward response fields.
The following code sample shows a ledger entry’s detail_object containing reward details:
Reward events
Copy section link
Marqeta’s credit platform sends webhook notifications when rewards are applied on a credit account. You can configure a webhook to capture the following reward events:
-
account.reward.cashback
For more on events, including event descriptions, see Credit ledger entry events. For more on subscribing to webhook notifications, see the About Webhooks tutorial.
Payments
Copy section link
When an account holder makes a payment toward their credit account balance, a ledger entry belonging to the PAYMENT group is created on the account.
You can create a payment using the /credit/accounts/{account_token}/payments endpoint.
For the endpoint reference, see Payments.
For the guide, see the About Credit Account Payments.
Payment details
Copy section link
When retrieving a payment ledger entry, payment details are the fields that are returned in the detail_object.
For field descriptions, see the Retrieve account payment response fields.
The following code sample shows a ledger entry’s detail_object containing payment details:
Payment events
Copy section link
Marqeta’s credit platform sends webhook notifications when payment activity occurs on a credit account. You can configure a webhook to capture the following payment events:
-
account.payment.pending -
account.payment.completed -
account.payment.returned -
account.payment.canceled -
account.payment.refunded
For more on events, including event descriptions, see Credit ledger entry events. For more on subscribing to webhook notifications, see the About Webhooks tutorial. For more on payments, see About Credit Account Payments.
Adjustments
Copy section link
When the amount of an existing ledger entry or the account balance is adjusted, a ledger entry belonging to the ADJUSTMENT group is created on the credit account.
There are many reasons to adjust a ledger entry or account balance, including provisional credits for disputes, returned or canceled payments, waived fees, account write-offs, and more. For more on provisional credits and adjustments for disputes, see About Credit Account Disputes.
You can adjust the amount of a ledger entry or account balance using the /credit/accounts/{account_token}/adjustments endpoint.
To adjust a ledger entry amount, pass the ledger entry’s token in the original_ledger_entry_token field.
To adjust an account balance, do not pass original_ledger_entry_token and pass a negative value in amount, which is the adjustment amount.
For the endpoint reference, see Adjustments.
Adjustment details
Copy section link
When retrieving an adjustment ledger entry, adjustment details are the fields that are returned in the detail_object.
For field descriptions, see the Retrieve account adjustment response fields.
The following code sample shows a ledger entry’s detail_object containing adjustment details:
Adjustment events
Copy section link
Marqeta’s credit platform sends webhook notifications when adjustments are applied on a credit account. You can configure a webhook to capture the following adjustment events:
-
account.adjustment -
account.adjustment.purchase -
account.adjustment.purchase.graceperiod -
account.adjustment.fee -
account.adjustment.interest -
account.adjustment.reward
For more on events, including event descriptions, see Credit ledger entry events. For more on subscribing to webhook notifications, see the About Webhooks tutorial.
Balance refunds
Copy section link
When an account holder’s credit account balance is negative and a balance refund is issued to bring the balance to, or closer to, 0, a ledger entry belonging to the BALANCE_REFUND group is created on the credit account.
You can create a balance refund using the /credit/accounts/{account_token}/creditbalancerefunds endpoint.
For the endpoint reference, see Balance Refunds.
Balance refund details
Copy section link
When retrieving a balance refund ledger entry, balance refund details are the fields that are returned in the detail_object.
For field descriptions, see the Create balance refund response fields.
The following code sample shows a ledger entry’s detail_object containing balance refund details:
Balance refund event
Copy section link
Marqeta’s credit platform sends webhook notifications when balance refunds are issued on a credit account. You can configure a webhook to capture the following balance refund event:
-
account.balance.refund
For more on events, including event descriptions, see Credit ledger entry events. For more on subscribing to webhook notifications, see the About Webhooks tutorial.
Original credit transactions (OCT)
Copy section link
When the card network pushes an OCT payment that disburses funds to a credit card, a ledger entry belonging to the ORIGINAL_CREDIT group is created on the credit account.
OCT details
Copy section link
When retrieving an OCT ledger entry, OCT details are the fields returned in the detail_object.
These fields come from the card network and are conditionally returned based on the ledger entry’s type.
For more, see the original_credit object in Transactions.
The following code sample shows a ledger entry’s detail_object containing OCT details:
OCT events
Copy section link
Marqeta’s credit platform sends webhook notifications when OCT events occur. You can configure a webhook to capture the following OCT events:
-
original.credit.authorization -
original.credit.authorization.reversal -
original.credit.authorization.clearing -
original.credit.authpluscapture -
original.credit.authpluscapture.reversal
For more on events, including event descriptions, see Credit ledger entry events. For more on subscribing to webhook notifications, see the About Webhooks tutorial.