Query Loan Summaries

Return a paginated list of matching loan summaries.

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.
loanId	Array of strings Filter by loan system identifiers.
referenceLoanId	Array of strings Filter by reference loan id.
loanProductType	Array of strings (LoanProductType) Filter by loan product type. Items Value: "TradingAccount"
merchantId	string Filter by merchant identifier
customerId	Array of strings Filter by customer identifier
currency	string Filter by currency Example: currency=AUD
status	Array of strings (Status) Filter by loan status Items Enum: "enabled" "disabled"
createdFromInclusive required	string <date-time> Return loans that were created at or after this timestamp in ISO-8601 format Example: createdFromInclusive=2025-05-30T10:56:46.147443127Z
createdToExclusive	string <date-time> Return loans that were created before this timestamp in ISO-8601 format

Responses

200

Matching items sorted as specified

400

401

403

404

405

406

409

422

429

500

503

get/loans

Request samples

Curl
JavaScript

Response samples

application/json

[{"loanId": "loan_aDmO7lwjHQXwZI0o",
"referenceLoanId": "string",
"loanAccountName": "string",
"loanMetadata": { },
"timeZone": "Australia/Sydney",
"borrowerMerchantId": "mcht_aDmO6FwjHQXwZIz_",
"borrowerMarketplaceId": "mktp_aDmO6FwjHQXwZI0I",
"currency": "AUD",
"status": "enabled",
"specification": {"TradingAccountProductSpec": {"customerId": "cust_aDmO6FwjHQXwZI0A",
"customerFees": {"annualFixedFee": 0,
"implementationFixedFee": 0,
"statementReissueFixedFee": 0,
"currencyConversionVariableFee": 0,
"internationalProcessingVariableFee": 0,
"transactionFixedFee": 0,
"hotelEnrichmentFixedFee": 0,
"latePaymentReminderFixedFee": 0,
"latePaymentInterestVariableFee": 0
},
"metadataTemplate": {"validations": [{"path": {"path": null,
"steps": [ ]
},
"validator": {"name": null,
"statementConstraint": null,
"transactionConstraint": null,
"minLength": null,
"maxLength": null,
"format": null
}
}
]
},
"supportedIssuerBrands": ["UATP"
],
"statementPeriod": "monthly"
}
},
"loanBalances": {"availableBalance": 0,
"usedBalance": 0,
"reservedBalance": 0,
"pendingBalance": 0,
"accountLimit": 0
},
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
]