Credit statement file
The Credit Statement file contains relevant financial and transaction data, at an account level, to populate the account credit statement for your credit account holders.
The report file is in JSON format due to the vast volume of data it may contain.
Format: JSON
Frequency: After the cycle end-date
Stored in: A client-hosted SFTP folder
Product applicability: Local Store of Value: Credit
Data fields
Use the table below to help you interpret the data in JSON format.
Field name | Description | Example | Format |
|---|---|---|---|
acc_id | Unique identifier for the account in the Banking.Live platform. | 123456789 | Numeric |
cycle_id | Cycle of the account during which the transaction was posted, i.e. 1 if the transaction is posted during the first billing cycle of the account. | 4 | Numeric |
Date: | indicates the start date of the billing cycle | 2022-12-26 | Date: |
end_date | indicates the end date of the billing cycle | 2023-01-25 | date: |
days_no | duration of cycle in days | 31 | Numeric |
prev_cycle_balances | detailed breakdown of each of the opening credit balances for each credit limit associated to the account | { | Alphanumeric |
prev_cycle_balances_total | total opening balance of the account at start of the billing cycle | 566.4587733 | Numeric |
payments | payments received for the account during the billing cycle | 0 | Numeric |
debits | debit transactions on the account during the billing cycle | { | Alphanumeric |
credits | credit transactions on the account during the billing cycle | { | A;phanumeric |
reversals | Total reversal amount as during the billing cycle | { | Alphanumeric |
total_reversals_refund_amt | Total reversal refunds amount during the billing cycle | 0 | Numeric |
total_reward_points_reversed | Total rewards point reversed during the billing cycle | 0 | Numeric |
interest_total | total interest in billing currency | 25.8549 | Numeric |
interest_unpaid | unpaid interest in billing currency | 67.81368544 | Numeric |
interest_categorized | breakdown of interest amount posted during the cycle for each interest rate linked to the relevant account | The Credit Statement file contains relevant financial and transaction data, at an account level, to populate the account credit statement for your credit account holders. The report file is in JSON format du | Alphanumeric |
interest_rates | indicates all the interest rate(s) applicable to the account, with the interest_rate_id for each interest rate and the conditions for the relevant interest rate | { | Alphanumeric |
interest_wp | interest accrued where interest may still be waived | 0 | Numeric |
interest_wc | interest waiving cancelled | 0 | Numeric |
fees_total | total fees in billing currency | 0 | Numeric |
tax_total | total tax on fees in billing currency | 0 | Numeric |
unpaid_fees_from
| unpaid fees from previous period in billing currency | 0 | Numeric |
installments_total | total amount of installments | 0 | Numeric |
installments_current
| total amount of unpaid installments unpaid in the current cycle | 0 | Numeric |
credit_limits | indicates all credit limits and overdrafts applicable to the account, including the default credit limit and any merchant-level credit limits set at account-level | { | Alphanumeric |
include_interest
| indicator of whether interest is blocked from the credit available | true | Alphabetic |
credit_available | indicates the amount available for each credit limit allocated to the account. | The Credit Statement file contains relevant financial and transaction data, at an account level, to populate the account credit statement for your credit account holders. The report file is in JSON format due to the vast volume of data it may contain.
| Alphanumeric |
new_balances | detailed breakdown of each of the closing credit balances for each credit limit associated to the account | The Credit Statement file contains relevant financial and transaction data, at an account level, to populate the account credit statement for your credit account holders. The report fil | Alphanumeric |
new_balances_total | total closing balance of the account at end of the billing cycle | 592.31368544 | Numeric |
min_payment | minimum amount due, calculated based on the minimum due logic set at product level | 592.31 | Numeric |
payment_due_date | minimum due date, date by when the minimum due needs to be paid by the cardholder/client. duration between cycle date and due date is set at product level | 2023-02-09 | Date: |
statement_status_code | numeric indicator of the statement status | 1 | Numeric |
statement_status_descr | description of the statement status | "Successful Completion: Billing Cycle Statement is prepared, and the Billing Cycle is now LOCKED." | Alphabetic |
Sample file
[
{
"acc_id": 123456789,
"cycle_id": 4,
"start_date": "2022-12-26",
"end_date": "2023-01-25",
"days_no": 31,
"prev_cycle_balances": [
{
"amt_type": "I",
"merchant_type_category": 0,
"mcc_group": "0",
"mcc_code": 0,
"rate_id": 2,
"amt": 524.5
},
],
"prev_cycle_balances_total": 566.4587733,
"payments": 0,
"debits": [
{
"merchant_type_category": 0,
"mcc_group": "0",
"mcc_code": 0,
"amt": 0
}
],
"credits": [
{
"merchant_type_category": 0,
"mcc_group": "0",
"mcc_code": 0,
"amt": 0
}
],
"reversals": [
{
"merchant_type_category": 0,
"mcc_group": "0",
"mcc_code": 0,
"amt": 0
}
],
"total_reversals_refund_amt": 0,
"total_reward_points_reversed": 0,
"interest_total": 25.8549,
"interest_unpaid": 67.81368544,
"interest_categorized": [
{
"interest_rate_id": 2,
"is_default": true,
"amt": 25.8549
},
{
"interest_rate_id": 1,
"is_default": false,
"amt": 0
}
],
"interest_rates": [
{
"interest_rate_id": 1,
"condition_function_call": "public.f_UniversalCheck3EC(`<CTP>`, _c_DE3_1_PATTERN_STR=>'IN;01')",
"priority": 0,
"is_default": false,
"amount_referenced": "OWD",
"charge_rate_perc": 40,
"charge_rate_fixed": 0,
"charge_rate_logic": "SUM",
"charge_rate_perc_grace": 40,
"charge_rate_fixed_grace": 0,
"charge_rate_logic_grace": "SUM",
"charge_rate_perc_elevated": 52.5,
"charge_rate_fixed_elevated": 0,
"charge_rate_logic_elevated": "SUM",
"charge_rate_min_perc": 0,
"charge_rate_min_fixed": 0,
"charge_rate_min_logic": "MIN",
"charge_rate_max_perc": 0,
"charge_rate_max_fixed": 0,
"charge_rate_max_logic": "MIN",
"compounding": "D",
"method": 1,
"special_actions": "",
"start_counting_from": "TXN",
"no_interest_period_days_after_txn": 0,
"grace_period_cycles_no": 0
},
{
"interest_rate_id": 2,
"condition_function_call": "public.f_UniversalCheck3EC(`<CTP>`, _c_DE3_1_PATTERN_STR=>'NOT IN;01')",
"priority": 0,
"is_default": true,
"amount_referenced": "OWD",
"charge_rate_perc": 35,
"charge_rate_fixed": 0,
"charge_rate_logic": "SUM",
"charge_rate_perc_grace": 35,
"charge_rate_fixed_grace": 0,
"charge_rate_logic_grace": "SUM",
"charge_rate_perc_elevated": 52.5,
"charge_rate_fixed_elevated": 0,
"charge_rate_logic_elevated": "SUM",
"charge_rate_min_perc": 0,
"charge_rate_min_fixed": 0,
"charge_rate_min_logic": "MIN",
"charge_rate_max_perc": 0,
"charge_rate_max_fixed": 0,
"charge_rate_max_logic": "MIN",
"compounding": "D",
"method": 1,
"special_actions": "",
"start_counting_from": "TXN",
"no_interest_period_days_after_txn": 0,
"grace_period_cycles_no": 1
}
],
"interest_wp": 0,
"interest_wc": 0,
"fees_total": 0,
"tax_total": 0,
"unpaid_fees_from_previous_period": 0,
"installments_total": 0,
"installments_current_cycle_unpaid": 0,
"credit_limits": [
{
"merchant_type_category": 0,
"mcc_group": "0",
"mcc_code": 0,
"credit_limit_amount": 2000,
"overdraft": 1000
}
],
"include_interest_in_available_amt": false,
"credit_available": [
{
"merchant_type_category": 0,
"mcc_group": "0",
"mcc_code": 0,
"amt": 1099.68631456
}
],
"new_balances": [
{
"amt_type": "I",
"merchant_type_category": 0,
"mcc_group": "0",
"mcc_code": 0,
"rate_id": -1,
"amt": 0
},
{
"amt_type": "I",
"merchant_type_category": 0,
"mcc_group": "0",
"mcc_code": 0,
"rate_id": 1,
"amt": 0
},
{
"amt_type": "I",
"merchant_type_category": 0,
"mcc_group": "0",
"mcc_code": 0,
"rate_id": 2,
"amt": 524.5
},
{
"amt_type": "L",
"merchant_type_category": 0,
"mcc_group": "0",
"mcc_code": 0,
"rate_id": -1,
"amt": 524.5
}
],
"new_balances_total": 592.31368544,
"min_payment": 592.31,
"payment_due_date": "2023-02-09",
"statement_status_code": 1,
"statement_status_descr": "Successful Completion: Billing Cycle Statement is prepared, and the Billing Cycle is now LOCKED."
}
]Updated 7 months ago