Query Loan Statement Entries

Return a paginated list of matching loan statement entries.

Alpha release - Consider this endpoint experimental and very likely to change in future.

Request

query Parameters

limit	integer <int32> Maximum results per page. Default to 20, must be between 1 and 500.
page	integer <int32> Page number of results to show (starting at page 1).
sort	string Comma-delimited list of fields to sort by with sort priority from first to last. Fields are sorted by their natural ordering unless prefixed with a `-` character.
loanStatementId	Array of strings Filter by loan statement system identifier

Responses

200

400

401

403

404

405

406

409

422

429

500

503

get/loans/statements/entries

Request samples

Curl
JavaScript

Response samples

application/json

{"currency": "AUD",
"entries": [{"entryTimestamp": "2019-08-24T14:15:22Z",
"entryDescription": "string",
"loanStatementId": "lstmt_aF3M4-z6Qgc6IbI3",
"referenceStatementId": "string",
"loanId": "loan_aF3M4-z6Qgc6IbIx",
"netTotal": 0,
"taxTotal": 0,
"insuranceTotal": 0,
"billingAmountTotal": 0,
"transactionId": "string",
"issuerTransactionId": "itxn_aF3M3uz6Qgc6IbIe",
"issuerSettlementType": "open_loop",
"digitalCardDetails": {"cardHolderName": "string",
"cardBrand": "string",
"expiryDate": "string",
"issuerCountry": "AF",
"bin": "string",
"last4": "string"
},
"acquiringMerchantDetails": {"name": "string",
"taxId": "string",
"postCode": "string",
"merchantCategoryCode": "string",
"country": "AF",
"city": "string",
"emailAddress": "lucy.diamond@star.com",
"phoneNumber": "+61401234567"
},
"metadata": { },
"lineItems": [{"entryType": "Charge",
"description": "string",
"netAmount": 0,
"taxAmount": 0,
"totalAmount": 0,
"taxRate": 0,
"taxType": "string",
"originalAmount": {"sourceAmount": 0,
"sourceTaxAmount": 0,
"sourceNetAmount": 0,
"sourceCurrency": "string",
"targetAmount": 0,
"targetTaxAmount": 0,
"targetNetAmount": 0,
"targetCurrency": "string",
"exchangeRate": 0,
"rateUpdatedAt": "2019-08-24T14:15:22Z"
}
}
]
}
],
"totalPages": 0,
"totalRecords": 0
}