Warning
This page is currently deprecated and the functionality it describes will soon be unavailable. To learn more, contact your Marqeta representative.
This page is currently deprecated and the functionality it describes will soon be unavailable. To learn more, contact your Marqeta representative.
- About Credit Account Journal Entries — Developer guide
- Journal Entries — API reference
- Credit journal entry event types — Webhook notifications
/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
Action:GETEndpoint:
/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
| Fields | Description |
|---|---|
| account_token string Required | The unique identifier of the credit account for which you want to retrieve ledger entries. Send a GET request to /credit/accounts to retrieve existing credit account tokens.Allowable Values: Existing account token |
URL query parameters
| Fields | Description |
|---|---|
| count integer Optional | The number of resources to retrieve. Allowable Values: 1–100 |
| start_index integer Optional | Sort order index of the first resource in the returned array. Allowable Values: 0 min |
| start_date date Optional | 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 Optional | 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 Optional | An array of statuses by which to filter ledger entries. Allowable Values: A valid ledger entry status |
| description string Optional | The description of the ledger entries to return. Allowable Values: 255 char max |
| groups array of strings Optional | 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 Optional | The number of ledger entries to return. Allowable Values: Any integer |
| 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 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 | Number of resources returned. Allowable Values: 1-10 |
| start_index integer Returned | Sort order index of the first resource in the returned array. Allowable Values: Any integer |
| end_index integer Returned | 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 ledger entries on a credit account. Allowable Values: One or more ledger entry objects |
| data[].token string Returned | Unique identifier of the ledger entry. Allowable Values: 36 char max |
| data[].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 |
| data[].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 |
| data[].account_token string Returned | 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 Returned | Unique identifier of the credit card used to make the ledger entry. Allowable Values: 8–36 chars Existing credit card token |
| data[].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 ledger 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 |
| data[].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 |
| data[].type string Returned | The ledger entry event type. Allowable Values: Example: authorization.clearingA valid ledger entry event type |
| data[].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 |
| data[].amount decimal Returned | Amount of the ledger entry. Allowable Values: Format: 0.00 |
| 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 ledger 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 ledger entry. For other ledger entry groups, equivalent to impact_time.Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
| data[].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-ddThh:mm:ssZ |
| data[].created_time datetime Returned | 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 Conditionally returned | Unique identifier of the dispute, if the ledger entry is disputed. Allowable Values: Existing dispute token |
| data[].detail_token string Returned | Unique identifier of the ledger entry’s full details. Allowable Values: 36 char max |
| data[].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. - Purchases and refunds: see the transactions response fields. - Disputes: see the account disputes response fields. - Original credit transaction (OCT): see the transfer type fields. - Rewards: see the account reward response fields. - Payments: see the account payment response fields. - Balance refunds: see the balance refund response fields. - Adjustments: see the account adjustment response fields. - Interest and fees: see fields below. 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 fees. 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 fees. Allowable Values: 36 char max Existing account token |
| data[].detail_object.type string Conditionally returned | Type of fee. Returned for fees. Allowable Values: FOREIGN_TRANSACTION_FEE, OVER_LIMIT_FEE, LATE_PAYMENT_FEE, RETURNED_PAYMENT_FEE, CARD_REPLACEMENT_FEE, MINIMUM_INTEREST_FEE, MINIMUM_INTEREST_FEE_REVERSAL, ANNUAL_FEE, MONTHLY_FEE |
| data[].detail_object.method string Conditionally returned | Method used to calculate the fee value. Returned for fees. 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 fees. Allowable Values: Format: 0.00 |
| 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 fees. Allowable Values: Format: 0.00 |
| 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 fees. NOTE: This field is currently not supported and returns null.Allowable Values: Format: 0.00 |
| data[].detail_object.description string Conditionally returned | Description of the fee. Returned for fees. Allowable Values: 255 char max |
| data[].detail_object.created datetime Conditionally returned | 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 Conditionally returned | 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 Conditionally returned | 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 Conditionally returned | 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 Conditionally returned | 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 Conditionally returned | Average daily balance used to calculate interest. Returned for interest. Allowable Values: Format: 0.00 |
| data[].detail_object.goto_apr decimal Conditionally returned | Annual percentage rate. Returned for interest. Allowable Values: 0–100 |
| data[].detail_object.daily_periodic_rate decimal Conditionally returned | Daily rate used to calculate interest. Returned for interest. Allowable Values: 0–100 |
| data[].detail_object.days_in_billing_cycle integer Conditionally returned | Number of days in the billing cycle. Returned for interest. Allowable Values: 1–31 |
| data[].detail_object.interest_amount decimal Conditionally returned | Amount of interest calculated for the billing period. Returned for interest. Allowable Values: Format: 0.00 |
| data[].detail_object.created_date datetime Conditionally returned | Date and time when the interest was created. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
| data[].detail_object.updated_date datetime Conditionally returned | Date and time when the interest was last updated. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
Sample response body
JSON
{
"count": 3,
"start_index": 0,
"end_index": 4,
"is_more": true,
"data": [
{
"token": "interest_ledger_entry_token1111",
"account_token": "my_account_token_12",
"card_token": "my_credit_card_token7794",
"status": "POSTED",
"group": "INTEREST",
"type": "account.interest",
"id": "11112222",
"amount": 2.31,
"currency_code": "USD",
"memo": "Interest charge on purchases",
"request_time": "2021-08-01T03:59:59Z",
"impact_time": "2021-08-01T03:59:59Z",
"created_time": "2021-08-01T07:00:19Z",
"detail_token": "detail_token_96749",
"detail_object": {
"token": "detail_token_96749",
"account_token": "my_account_token_12",
"statement_token": "statement_token_75b",
"statement_opening_date": "2021-07-01T04:00:00Z",
"statement_closing_date": "2021-08-01T03:59:59Z",
"statement_balance": 208.93,
"average_daily_balance": 181.67,
"goto_apr": 14.99,
"daily_periodic_rate": 0.00041068,
"days_in_billing_cycle": 31,
"interest_amount": 2.31,
"currency_code": "USD",
"created_date": "2021-08-01T07:00:19Z",
"updated_date": "2021-08-01T07:00:19Z"
}
},
{
"token": "fee_ledger_entry_token2121",
"account_token": "my_account_token_12",
"card_token": "my_credit_card_token7794",
"status": "POSTED",
"group": "FEE",
"type": "account.fee.latepayment",
"id": "44445678",
"amount": 15,
"currency_code": "USD",
"memo": "Late payment fee",
"request_time": "2021-07-01T03:59:59Z",
"impact_time": "2021-07-01T03:59:59Z",
"created_time": "2021-07-01T07:00:24Z",
"detail_token": "detail_token_11221",
"detail_object": {
"token": "detail_token_11221",
"account_token": "my_account_token_12",
"type": "LATE_PAYMENT_FEE",
"method": "FLAT",
"value": 25,
"currency_code": "USD",
"amount": 15,
"description": "Late Payment Fee",
"created": "2021-07-01T07:00:24Z"
}
},
{
"token": "purchase_ledger_entry_token6789",
"related_token": "ledger_entry_token2460",
"root_token": "ledger_entry_token2460",
"account_token": "my_account_token_12",
"card_token": "my_credit_card_token7794",
"status": "POSTED",
"group": "PURCHASE",
"type": "authorization.clearing",
"id": "12345678",
"amount": 9.11,
"currency_code": "USD",
"memo": "SWEET TREATS 0484",
"request_time": "2021-09-25T20:59:43Z",
"impact_time": "2021-09-26T11:53:48Z",
"created_time": "2021-09-26T11:53:48Z",
"detail_token": "detail_token_645736",
"detail_object": {
"type": "authorization.clearing",
"state": "COMPLETION",
"identifier": 6457,
"token": "detail_token_645736",
"user_token": "user_token4632",
"acting_user_token": "user_token4632",
"card_token": "my_credit_card_token7794",
"preceding_related_transaction_token": "ledger_entry_token2460",
"gpa": {
"currency_code": "USD",
"ledger_balance": 61.7,
"available_balance": 0,
"credit_balance": 0,
"pending_credits": 0,
"impacted_amount": -9.11,
"balances": {
"USD": {
"currency_code": "USD",
"ledger_balance": 61.7,
"available_balance": 0,
"credit_balance": 0,
"pending_credits": 0,
"impacted_amount": -9.11
}
}
},
"gpa_order": {
"token": "gpa_order_token2c2c5",
"amount": 9.11,
"created_time": "2021-09-25T20:59:43Z",
"last_modified_time": "2021-09-26T11:53:47Z",
"transaction_token": "transaction_token42352a",
"state": "COMPLETION",
"response": {
"code": 0,
"memo": "Approved or completed successfully"
},
"funding": {
"amount": 9.11,
"source": {
"type": "programgateway",
"token": "funding_source_token6789",
"active": true,
"name": "My Funding Source",
"is_default_account": false,
"created_time": "2021-06-22T18:41:14Z",
"last_modified_time": "2021-06-22T18:41:14Z"
}
},
"funding_source_token": "funding_source_token6789",
"jit_funding": {
"token": "jit_funding_token43a3",
"method": "pgfs.authorization.capture",
"user_token": "user_token4632",
"acting_user_token": "user_token4632",
"amount": 9.11,
"original_jit_funding_token": "jit_funding_token4be7"
},
"user_token": "user_token4632",
"currency_code": "USD"
},
"duration": 378,
"created_time": "2021-09-26T11:53:46Z",
"user_transaction_time": "2021-09-25T20:59:43Z",
"settlement_date": "2021-09-26T00:00:00Z",
"request_amount": 9.11,
"amount": 9.11,
"currency_conversion": {
"network": {
"original_amount": 9.11,
"conversion_rate": 1,
"original_currency_code": 840
}
},
"issuer_interchange_amount": 0.19131,
"currency_code": "USD",
"approval_code": 946791,
"response": {
"code": 0,
"memo": "Approved or completed successfully"
},
"network": "VISA",
"subnetwork": "VISANET",
"acquirer_fee_amount": 0,
"acquirer": {
"system_trace_audit_number": 0
},
"fees": {
"type": "INTERCHANGE_FEE",
"amount": 0.19131,
"credit_debit": "C"
},
"user": {
"metadata": {
"notification_email": "hello@myemail.com"
}
},
"card": {
"last_four": 4489,
"metadata": {}
},
"issuer_received_time": "2021-09-26T11:53:46Z",
"issuer_payment_node": "042f97a3458b59e3cce0269f66e864d8",
"network_reference_id": "000218552461989029",
"clearing_record_sequence_number": 0,
"batch_number": 2021048291031352,
"acquirer_reference_data": 4.355106395860054e+22,
"card_acceptor": {
"mid": "000555600244811",
"mcc": 5814,
"name": "SWEET TREATS 0484",
"city": "OAKLAND",
"state": "CA",
"postal_code": 94612,
"country_code": "US"
},
"pos": {
"terminal_id": 65,
"pin_present": false,
"partial_approval_capable": false,
"purchase_amount_only": false,
"is_recurring": false,
"is_installment": false
},
"transaction_metadata": {
"payment_channel": "OTHER"
},
"network_metadata": {
"product_id": "VISA_TRADITIONAL",
"program_id": ""
}
}
}
]
}
Retrieve account ledger entry
Action:GETEndpoint:
/credit/accounts/{account_token}/ledgerentries/{ledger_entry_token}
Retrieve a ledger entry 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 ledger entries. Send a GET request to /credit/accounts to retrieve existing credit account tokens.Allowable Values: Existing account token |
| ledger_entry_token string Required | The unique identifier of the ledger entry you want to retrieve. Send a GET request to /credit/accounts/{account_token}/ledgerentries to retrieve existing ledger entry tokens.Allowable Values: Existing ledger entry token |
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 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 ledger 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.clearingA valid ledger entry event type |
| 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: Format: 0.00 |
| 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-ddThh:mm:ssZ |
| 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-ddThh:mm:ssZ |
| created_time datetime Returned | 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 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. - Purchases and refunds: see the transactions response fields. - Disputes: see the account disputes response fields. - Original credit transaction (OCT): see the transfer type fields. - Rewards: see the account reward response fields. - Payments: see the account payment response fields. - Balance refunds: see the balance refund response fields. - Adjustments: see the account adjustment response fields. - Interest and fees: see fields below. 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 fees. 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 fees. Allowable Values: 36 char max Existing account token |
| detail_object.type string Conditionally returned | Type of fee. Returned for fees. Allowable Values: FOREIGN_TRANSACTION_FEE, OVER_LIMIT_FEE, LATE_PAYMENT_FEE, RETURNED_PAYMENT_FEE, CARD_REPLACEMENT_FEE, MINIMUM_INTEREST_FEE, MINIMUM_INTEREST_FEE_REVERSAL, ANNUAL_FEE, MONTHLY_FEE |
| detail_object.method string Conditionally returned | Method used to calculate the fee value. Returned for fees. 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 fees. Allowable Values: Format: 0.00 |
| 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 fees. Allowable Values: Format: 0.00 |
| 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 fees. NOTE: This field is currently not supported and returns null.Allowable Values: Format: 0.00 |
| detail_object.description string Conditionally returned | Description of the fee. Returned for fees. Allowable Values: 255 char max |
| detail_object.created datetime Conditionally returned | Date and time when the fee was created. Returned for fees. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
| detail_object.statement_token string Conditionally returned | 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 Conditionally returned | 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 Conditionally returned | 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 Conditionally returned | 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 Conditionally returned | Average daily balance used to calculate interest. Returned for interest. Allowable Values: Format: 0.00 |
| detail_object.goto_apr decimal Conditionally returned | Annual percentage rate. Returned for interest. Allowable Values: 0–100 |
| detail_object.daily_periodic_rate decimal Conditionally returned | Daily rate used to calculate interest. Returned for interest. Allowable Values: 0–100 |
| detail_object.days_in_billing_cycle integer Conditionally returned | Number of days in the billing cycle. Returned for interest. Allowable Values: 1–31 |
| detail_object.interest_amount decimal Conditionally returned | Amount of interest calculated for the billing period. Returned for interest. Allowable Values: Format: 0.00 |
| detail_object.created_date datetime Conditionally returned | Date and time when the interest was created. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
| detail_object.updated_date datetime Conditionally returned | Date and time when the interest was last updated. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
Sample response body
The following code block shows a samplePURCHASE ledger entry.
JSON
{
"token": "ledger_entry_token6789",
"user_token": "user_token4632",
"related_token": "ledger_entry_token2460",
"root_token": "ledger_entry_token2460",
"account_token": "my_account_token_12",
"card_token": "my_credit_card_token7794",
"status": "POSTED",
"group": "PURCHASE",
"type": "authorization.clearing",
"id": "12345678",
"amount": 9.11,
"currency_code": "USD",
"memo": "SWEET TREATS 0484",
"request_time": "2021-09-25T20:59:43Z",
"impact_time": "2021-09-26T11:53:48Z",
"created_time": "2021-09-26T11:53:48Z",
"detail_token": "detail_token_645736",
"detail_object": {
"type": "authorization.clearing",
"state": "COMPLETION",
"identifier": 6457,
"token": "detail_token_645736",
"user_token": "user_token4632",
"acting_user_token": "user_token4632",
"card_token": "my_credit_card_token7794",
"preceding_related_transaction_token": "ledger_entry_token2460",
"gpa": {
"currency_code": "USD",
"ledger_balance": 61.7,
"available_balance": 0,
"credit_balance": 0,
"pending_credits": 0,
"impacted_amount": -9.11,
"balances": {
"USD": {
"currency_code": "USD",
"ledger_balance": 61.7,
"available_balance": 0,
"credit_balance": 0,
"pending_credits": 0,
"impacted_amount": -9.11
}
}
},
"gpa_order": {
"token": "gpa_order_token2c2c5",
"amount": 9.11,
"created_time": "2021-09-25T20:59:43Z",
"last_modified_time": "2021-09-26T11:53:47Z",
"transaction_token": "transaction_token42352a",
"state": "COMPLETION",
"response": {
"code": 0,
"memo": "Approved or completed successfully"
},
"funding": {
"amount": 9.11,
"source": {
"type": "programgateway",
"token": "funding_source_token6789",
"active": true,
"name": "My Funding Source",
"is_default_account": false,
"created_time": "2021-06-22T18:41:14Z",
"last_modified_time": "2021-06-22T18:41:14Z"
}
},
"funding_source_token": "funding_source_token6789",
"jit_funding": {
"token": "jit_funding_token43a3",
"method": "pgfs.authorization.capture",
"user_token": "user_token4632",
"acting_user_token": "user_token4632",
"amount": 9.11,
"original_jit_funding_token": "jit_funding_token4be7"
},
"user_token": "user_token4632",
"currency_code": "USD"
},
"duration": 378,
"created_time": "2021-09-26T11:53:46Z",
"user_transaction_time": "2021-09-25T20:59:43Z",
"settlement_date": "2021-09-26T00:00:00Z",
"request_amount": 9.11,
"amount": 9.11,
"currency_conversion": {
"network": {
"original_amount": 9.11,
"conversion_rate": 1,
"original_currency_code": 840
}
},
"issuer_interchange_amount": 0.19131,
"currency_code": "USD",
"approval_code": 946791,
"response": {
"code": 0,
"memo": "Approved or completed successfully"
},
"network": "VISA",
"subnetwork": "VISANET",
"acquirer_fee_amount": 0,
"acquirer": {
"system_trace_audit_number": 0
},
"fees": {
"type": "INTERCHANGE_FEE",
"amount": 0.19131,
"credit_debit": "C"
},
"user": {
"metadata": {
"notification_email": "hello@myemail.com"
}
},
"card": {
"last_four": 4489,
"metadata": {}
},
"issuer_received_time": "2021-09-26T11:53:46Z",
"issuer_payment_node": "042f97a3458b59e3cce0269f66e864d8",
"network_reference_id": "000218552461989029",
"clearing_record_sequence_number": 0,
"batch_number": 2021048291031352,
"acquirer_reference_data": 4.355106395860054e+22,
"card_acceptor": {
"mid": "000555600244811",
"mcc": 5814,
"name": "SWEET TREATS 0484",
"city": "OAKLAND",
"state": "CA",
"postal_code": 94612,
"country_code": "US"
},
"pos": {
"terminal_id": 65,
"pin_present": false,
"partial_approval_capable": false,
"purchase_amount_only": false,
"is_recurring": false,
"is_installment": false
},
"transaction_metadata": {
"payment_channel": "OTHER"
},
"network_metadata": {
"product_id": "VISA_TRADITIONAL",
"program_id": ""
}
}
}
JSON
{
"token": "interest_ledger_entry_token1111",
"account_token": "my_account_token_12",
"card_token": "my_credit_card_token7794",
"status": "POSTED",
"group": "INTEREST",
"type": "account.interest",
"id": "11112222",
"amount": 2.31,
"currency_code": "USD",
"memo": "Interest charge on purchases",
"request_time": "2021-08-01T03:59:59Z",
"impact_time": "2021-08-01T03:59:59Z",
"created_time": "2021-08-01T07:00:19Z",
"detail_token": "detail_token_96749",
"detail_object": {
"token": "detail_token_96749",
"account_token": "my_account_token_12",
"statement_token": "statement_token_75b",
"statement_opening_date": "2021-07-01T04:00:00Z",
"statement_closing_date": "2021-08-01T03:59:59Z",
"statement_balance": 208.93,
"average_daily_balance": 181.67,
"goto_apr": 14.99,
"daily_periodic_rate": 0.00041068,
"days_in_billing_cycle": 31,
"interest_amount": 2.31,
"currency_code": "USD",
"created_date": "2021-08-01T07:00:19Z",
"updated_date": "2021-08-01T07:00:19Z"
}
}
JSON
{
"token": "fee_ledger_entry_token2121",
"account_token": "my_account_token_12",
"card_token": "my_credit_card_token7794",
"status": "POSTED",
"group": "FEE",
"type": "account.fee.latepayment",
"id": "44445678",
"amount": 15,
"currency_code": "USD",
"memo": "Late payment fee",
"request_time": "2021-07-01T03:59:59Z",
"impact_time": "2021-07-01T03:59:59Z",
"created_time": "2021-07-01T07:00:24Z",
"detail_token": "detail_token_11221",
"detail_object": {
"token": "detail_token_11221",
"account_token": "my_account_token_12",
"type": "LATE_PAYMENT_FEE",
"method": "FLAT",
"value": 25,
"currency_code": "USD",
"amount": 15,
"description": "Late Payment Fee",
"created": "2021-07-01T07:00:24Z"
}
}
Resend credit event notification
Action:POSTEndpoint:
/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
| Fields | Description |
|---|---|
| event_type string Required | Specifies the type of event you want to resend. Allowable Values: ledgerentry, journalentry, accounttransition, accountstatement, paymenttransition, delinquencytransition |
| resource_token string Required | The unique identifier of the resource for which you want to resend a notification. Send a GET request to /credit/accounts/{account_token}/journalentries to retrieve existing journal entry tokens.Send a GET request to /credit/accounts/{account_token}/ledgerentries to retrieve existing ledger entry tokens.Send a GET request to /accounts/{account_token}/accounttransitions to retrieve existing account transition tokens.Send a GET request to /credit/accounts/{account_token}/payments/{payment_token} to retrieve existing payment transition tokens.Send a GET request to /accounts/{account_token}/statements to retrieve existing statement summary tokens.Send a GET request to /accounts/{account_token}/delinquencystate/transitions to retrieve existing delinquency transition tokens.Allowable Values: Existing journal entry token, ledger entry token, account transition token, payment transition token, statement summary token, or delinquency transition token |
Response body
| Fields | Description |
|---|---|
| unused string Conditionally returned | The event notification that was resent to your webhook endpoint. Allowable Values: Valid event notification |
Sample response body
The following code block shows a sample of a resentcreditaccounttransitions event.
JSON
{
"token": "my_credit_account_transition_token1234",
"account_token": "my_credit_account_token1234",
"original_status": "UNACTIVATED",
"status": "ACTIVE",
"created_time": "2021-08-18T20:25:10.408Z"
}
creditaccountstatements event.
JSON
{
"token": "my_credit_account_statement_token",
"account_token": "my_credit_account_token",
"opening_balance": 496.45,
"closing_balance": 506.41,
"credit_limit": 500,
"available_credit": 0,
"past_due_amount": 10,
"purchases": 0,
"interest": 4.96,
"fees": 15,
"credits": 0,
"payments": 10,
"days_in_billing_cycle": 31,
"cycle_type": "REVOLVING",
"opening_date": "2023-03-01T05:00:00.000Z",
"closing_date": "2023-04-01T03:59:59.999Z",
"created_time": "2021-08-18T22:04:31.261Z"
}
creditjournalentries event.
JSON
{
"token": "my_journal_entry_token1234",
"related_token": null,
"root_token": null,
"account_token": "my_credit_account_token1234",
"card_token": "my_credit_card_token1234",
"status": "PENDING",
"group": "PURCHASE",
"type": "authorization",
"id": "12345678",
"amount": 10,
"currency_code": "USD",
"memo": "Jane's Bakery",
"request_time": "2021-08-18T22:06:52.000Z",
"impact_time": "2021-08-18T22:07:21.422Z",
"created_time": "2021-08-18T22:07:21.422Z",
"dispute_token": null,
"detail_token": "my_detail_token1234",
"detail_object": {
"type": "authorization",
"state": "PENDING",
"identifier": "234",
"token": "my_detail_token1234",
"user_token": "my_user_token",
"acting_user_token": "my_user_token",
"card_token": "my_credit_card_token1234",
"gpa": {
"currency_code": "USD",
"ledger_balance": 510.87,
"available_balance": 0,
"credit_balance": 0,
"pending_credits": 0,
"impacted_amount": -10,
"balances": {
"USD": {
"currency_code": "USD",
"ledger_balance": 510.87,
"available_balance": 0,
"credit_balance": 0,
"pending_credits": 0,
"impacted_amount": -10
}
}
},
"gpa_order": {
"token": "my_gpa_order_token1234",
"amount": 10,
"created_time": "2021-08-18T22:06:53Z",
"last_modified_time": "2021-08-18T22:06:53Z",
"transaction_token": "my_transaction_token1234",
"state": "PENDING",
"response": {
"code": "0000",
"memo": "Approved or completed successfully"
},
"funding": {
"amount": 10,
"source": {
"type": "programgateway",
"token": "**********1ab2",
"active": true,
"name": "credit_backed_funding_source",
"is_default_account": false,
"created_time": "2021-10-14T17:26:35Z",
"last_modified_time": "2021-10-14T17:26:35Z"
},
"gateway_log": {
"order_number": "my_gateway_token12345",
"transaction_id": "my_transaction_id1234",
"message": "Approved or completed successfully",
"duration": 485,
"timed_out": false,
"response": {
"code": "200",
"data": {
"jit_funding": {
"token": "my_jit_funding_token1234",
"method": "pgfs.authorization",
"user_token": "my_user_token",
"acting_user_token": "my_user_token",
"amount": 10
}
}
}
}
},
"funding_source_token": "**********1ab2",
"jit_funding": {
"token": "my_transaction_id1234",
"method": "pgfs.authorization",
"user_token": "my_user_token",
"acting_user_token": "my_user_token",
"amount": 10
},
"user_token": "my_user_token",
"currency_code": "USD"
},
"duration": 837,
"created_time": "2021-08-18T22:06:52Z",
"user_transaction_time": "2021-08-18T22:06:52Z",
"settlement_date": "2021-08-18T00:00:00Z",
"request_amount": 10,
"amount": 10,
"currency_code": "USD",
"approval_code": "974406",
"response": {
"code": "0000",
"memo": "Approved or completed successfully"
},
"network": "DISCOVER",
"acquirer_fee_amount": 0,
"acquirer": {
"system_trace_audit_number": "376582"
},
"user": {
"metadata": {
"key1": "value1",
"key2": "value2",
"notification_email": "user@domain.com",
"notification_language": "spa"
}
},
"card": {
"last_four": "9949",
"metadata": {}
},
"issuer_received_time": "2021-08-18T22:06:52.771Z",
"issuer_payment_node": "f8205a67b12b90d695b15704a64c074b",
"network_reference_id": "484311571095",
"card_acceptor": {
"mid": "1234",
"mcc": "6411",
"name": "Jane's Bakery",
"street_address": "1989 Fillmore St",
"city": "San Francisco",
"state": "CA",
"postal_code": "94115",
"country_code": "USA"
},
"pos": {
"pin_present": false,
"partial_approval_capable": true,
"purchase_amount_only": false,
"is_recurring": false,
"is_installment": false
}
}
}
creditledgerentries event.
JSON
{
"token": "my_ledger_entry_token1234",
"related_token": null,
"root_token": null,
"account_token": "my_credit_account_token1234",
"card_token": "my_credit_card_token1234",
"status": "PENDING",
"group": "PURCHASE",
"type": "authorization",
"id": "12345678",
"amount": 10,
"currency_code": "USD",
"memo": "Jane's Bakery",
"request_time": "2021-08-18T22:06:52.000Z",
"impact_time": "2021-08-18T22:07:21.422Z",
"created_time": "2021-08-18T22:07:21.422Z",
"dispute_token": null,
"detail_token": "my_detail_token1234",
"detail_object": {
"type": "authorization",
"state": "PENDING",
"identifier": "234",
"token": "my_detail_token1234",
"user_token": "my_user_token",
"acting_user_token": "my_user_token",
"card_token": "my_credit_card_token1234",
"gpa": {
"currency_code": "USD",
"ledger_balance": 510.87,
"available_balance": 0,
"credit_balance": 0,
"pending_credits": 0,
"impacted_amount": -10,
"balances": {
"USD": {
"currency_code": "USD",
"ledger_balance": 510.87,
"available_balance": 0,
"credit_balance": 0,
"pending_credits": 0,
"impacted_amount": -10
}
}
},
"gpa_order": {
"token": "my_gpa_order_token1234",
"amount": 10,
"created_time": "2021-08-18T22:06:53Z",
"last_modified_time": "2021-08-18T22:06:53Z",
"transaction_token": "my_transaction_token1234",
"state": "PENDING",
"response": {
"code": "0000",
"memo": "Approved or completed successfully"
},
"funding": {
"amount": 10,
"source": {
"type": "programgateway",
"token": "**********1ab2",
"active": true,
"name": "credit_backed_funding_source",
"is_default_account": false,
"created_time": "2021-10-14T17:26:35Z",
"last_modified_time": "2021-10-14T17:26:35Z"
},
"gateway_log": {
"order_number": "my_gateway_token12345",
"transaction_id": "my_transaction_id1234",
"message": "Approved or completed successfully",
"duration": 485,
"timed_out": false,
"response": {
"code": "200",
"data": {
"jit_funding": {
"token": "my_jit_funding_token1234",
"method": "pgfs.authorization",
"user_token": "my_user_token",
"acting_user_token": "my_user_token",
"amount": 10
}
}
}
}
},
"funding_source_token": "**********1ab2",
"jit_funding": {
"token": "my_transaction_id1234",
"method": "pgfs.authorization",
"user_token": "my_user_token",
"acting_user_token": "my_user_token",
"amount": 10
},
"user_token": "my_user_token",
"currency_code": "USD"
},
"duration": 837,
"created_time": "2021-08-18T22:06:52Z",
"user_transaction_time": "2021-08-18T22:06:52Z",
"settlement_date": "2021-08-18T00:00:00Z",
"request_amount": 10,
"amount": 10,
"currency_code": "USD",
"approval_code": "974406",
"response": {
"code": "0000",
"memo": "Approved or completed successfully"
},
"network": "DISCOVER",
"acquirer_fee_amount": 0,
"acquirer": {
"system_trace_audit_number": "376582"
},
"user": {
"metadata": {
"key1": "value1",
"key2": "value2",
"notification_email": "user@domain.com",
"notification_language": "spa"
}
},
"card": {
"last_four": "9949",
"metadata": {}
},
"issuer_received_time": "2021-08-18T22:06:52.771Z",
"issuer_payment_node": "f8205a67b12b90d695b15704a64c074b",
"network_reference_id": "484311571095",
"card_acceptor": {
"mid": "1234",
"mcc": "6411",
"name": "Jane's Bakery",
"street_address": "1989 Fillmore St",
"city": "San Francisco",
"state": "CA",
"postal_code": "94115",
"country_code": "USA"
},
"pos": {
"pin_present": false,
"partial_approval_capable": true,
"purchase_amount_only": false,
"is_recurring": false,
"is_installment": false
}
}
}
creditpaymenttransitions event.
JSON
{
"token": "my_payment_transition_token1234",
"account_token": "my_credit_account_token1234",
"payment_token": "my_credit_account_payment_token1234",
"status": "COMPLETED",
"refund_details": null,
"created_time": "2021-08-17T18:26:47.591Z"
}
creditdelinquencytransitions event.
JSON
{
"token": "my_delinquency_transition_token1234",
"account_token": "my_credit_account_token1234",
"transition_trigger_reason": "STATEMENT_GENERATION",
"transition_trigger_time": "2023-03-01 04:59:59.999",
"original_status": "CURRENT",
"status": "DELINQUENT",
"impact_time": "2023-03-01 04:59:59.999",
"total_past_due": 100,
"current_due": 40,
"total_due": 140,
"oldest_payment_due_date": "2023-02-01 04:59:59.999",
"bucket_count": 2,
"is_invalidated": false,
"created_time": "2023-03-01 04:59:59.999",
"updated_time": "2023-03-01 04:59:59.999"
}