Credit statement report
This report will contain the statement data including a list of transactions which have been applied to the account during the statement period.
Format:
<<glossary:JSON>>
File name: [ClientID]_CREDITSTATEMENT_[yyyymmdd].json
Frequency: Monthly statement day for all active accounts
Stored in: API call or client-hosted<<glossary:SFTP>>folder
Product applicability: PayCredit
Data fields
| Seq No | Field Name | Description | Example | Format |
|---|---|---|---|---|
| 1 | client_id | Client ID | 123456 | Numeric |
| 2 | account_id | Unique identifier for the account in <<glossary:PayCredit>> | 468677892 | Numeric |
| 3 | account_reference | Client provided account reference | abcd-1234-ghjk-5678 | Numeric |
| 4 | statement_id | Unique identifier for the statement in <<glossary:PayCredit>> | 42186 | Numeric |
| 5 | sequence_number | The number of the statement i.e. 1 for the first billing cycle of the account | 1 | Numeric |
| 6 | statement_date | The date statement was produced, this is the last day of the billing cycle | 2024-10-01 | YYYY-MM-DD |
| 7 | start_date | Start date of statement | 2024-09-12 | YYYY-MM-DD |
| 8 | end_date | End date of statement | 2024-09-30 | YYYY-MM-DD |
| 9 | balance_open | The opening balance of the statement | 0.00 | Numeric |
| 10 | balance_close | The closing balance of the statement | 89.36 | Numeric |
| 11 | repayment_due_date | The date by which minimum repayment is due | 2024-10-15 | YYYY-MM-DD |
| 12 | total_debits | The total of all debit transactions during the statement period, excluding interest and fees | 83.99 | Numeric |
| 13 | total_credits | The total of all credit transactions during the statement period | 0.00 | Numeric |
| 14 | total_interest | The total interest added during the statement period | 0.00 | Numeric |
| 15 | total_fees | The total of all fees added during the statement period | 5.37 | Numeric |
| 16 | overpayment | The amount of any overpayment on the account | 0.00 | Numeric |
| 17 | repayment_minimum_actual_due | The minimum repayment due based on Product configuration | 1.34 | Numeric |
| 18 | transactions | Multiple transaction records for purchases, credits, fees and posted interest | Array | |
| transaction_id | 5426220 | Numeric | ||
| transaction_amount | 11.12 | Numeric | ||
| transaction_amount_settled | 11.12 | Numeric | ||
| transaction_type_id | 1 | Numeric | ||
| transaction_description | Purchase - card | Alphabetic | ||
| transaction_datetime | 2024-09-12 02:05:59 | YYYY-MM-DD hh:mm:ss | ||
| transaction_settled_date | 2024-09-12 | YYYY-MM-DD | ||
| spend_location | Record from <<glossary:FAST>> data | W.H.Smith Signature Edinburgh GBR | Alphanumeric |
Sample report data
"client_id": 123456,
"account_id": 468677892,
"account_reference": null,
"statement_id": 42186,
"sequence_number": 1,
"statement_date": "2024-10-01",
"start_date": "2024-09-12",
"end_date": "2024-09-30",
"balance_open": 0.00,
"balance_close": 89.36,
"repayment_due_date": "2024-10-15",
"total_debits": 83.99,
"total_credits": 0.00,
"total_interest": 0.00,
"total_fees": 5.37,
"overpayment": 0.00,
"repayment_minimum_actual_due": 1.34,
"transactions": [
{
"transaction_id": 5426220,
"transaction_amount": 10.00,
"transaction_amount_settled": 10.00,
"transaction_type_id": 1,
"transaction_description": "Purchase - card",
"transaction_datetime": "2024-09-12 02:05:59",
"transaction_settled_date": "2024-09-12"
},
{
"transaction_id": 5426221,
"transaction_amount": 11.12,
"transaction_amount_settled": 11.12,
"transaction_type_id": 1,
"transaction_description": "Purchase - card",
"transaction_datetime": "2024-09-12 02:07:13",
"transaction_settled_date": "2024-09-12"
},
{
"transaction_id": 5426222,
"transaction_amount": 11.12,
"transaction_amount_settled": 11.12,
"transaction_type_id": 1,
"transaction_description": "Purchase - card",
"transaction_datetime": "2024-09-12 02:59:10",
"transaction_settled_date": "2024-09-12"
},
{
"transaction_id": 5426223,
"transaction_amount": 10.12,
"transaction_amount_settled": 10.12,
"transaction_type_id": 1,
"transaction_description": "test refund",
"transaction_datetime": "2024-09-12 04:00:46",
"transaction_settled_date": "2024-09-12"
},Updated 7 months ago