Product Manager Public API (Internal Lookup)
Product Manager API Documentation (1.1.0)
Download OpenAPI specification:Download
This is the API of Product Manager
Get Internal Product Detail
Retrieve detailed information for a single publicly available product using an internalId.
Unlike the public GET /banking/products/{productId} endpoint (which looks the product up by the productId published to the CDR), this endpoint resolves a product by one of the internalId values configured against it in Product Manager. A product in PM can have one or more internalId entries linked to it, which lets a customer's HaaS data adapter map its own internal product identifiers to the CDR-published product without needing to know the generated public productId.
path Parameters
| spaceId required | string <uuid> ID of the PRD Admin space |
| internalProductId required | string One of the A product can have one or more |
header Parameters
| x-v required | string Version of the API endpoint requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See HTTP Headers |
| x-min-v | string Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. |
Responses
Response samples
- 200
- 400
- 404
- 406
- 500
- 503
{- "meta": { },
- "version": "V3",
- "data": {
- "additionalInformation": {
}, - "brand": "ACME",
- "brandName": "string",
- "cardArt": [
- {
- "title": "Customise your card and look snazzy"
}
], - "description": "An amazing example product",
- "effectiveFrom": "2019-08-24T14:15:22Z",
- "effectiveTo": "2019-08-24T14:15:22Z",
- "isTailored": true,
- "lastUpdated": "2022-08-20T03:01:42+00:00",
- "name": "Example Product",
- "productCategory": "TRANS_AND_SAVINGS_ACCOUNTS",
- "productId": "9bf2cae7-ca32-4124-905b-68404de9628f",
- "bundles": [
- {
- "additionalInfo": "A great bundle with all the extras",
- "description": "Provides a savings account and loan",
- "name": "ACME Super Bundle",
- "productIds": [
- "string"
]
}
], - "constraints": [
- {
- "additionalInfo": "Some information about the constraint",
- "additionalValue": "Type specific value, see documentation",
- "constraintType": "MIN_BALANCE"
}
], - "depositRates": [
- {
- "additionalInfo": "A great deposit rate",
- "additionalValue": "Type specific value, see docs",
- "applicationFrequency": "P30D",
- "calculationFrequency": "P1D",
- "depositRateType": "FIXED",
- "rate": "0.011",
- "tiers": [
- {
- "additionalInfo": "string",
- "applicabilityConditions": {
- "additionalInfo": "Package discount is assessed on the package lending balance when you apply for a package.",
}, - "maximumValue": 0,
- "minimumValue": 0.05,
- "name": "Example Rate Tier",
- "rateApplicationMethod": "WHOLE_BALANCE",
- "unitOfMeasure": "DOLLAR"
}
]
}
], - "eligibility": [
- {
- "additionalInfo": "Eligibility Criteria",
- "additionalValue": "Type dependent value, see docs",
- "eligibilityType": "MIN_TURNOVER"
}
], - "features": [
- {
- "additionalInfo": "Additional Feature Information",
- "additionalValue": "Type specific value, see docs",
- "featureType": "CARD_ACCESS"
}
], - "fees": [
- {
- "accrualFrequency": "P1D",
- "accruedRate": "0.002",
- "additionalInfo": "Additional Fee Information",
- "additionalValue": "Type specific value, see docs",
- "amount": "10.01",
- "balanceRate": "0.0023",
- "currency": "AUD",
- "discounts": [
- {
- "accruedRate": "0.012",
- "additionalInfo": "Discount Information",
- "additionalValue": "Type specific value, see docs",
- "amount": "11.00",
- "balanceRate": "0.0103",
- "description": "A great discount offer for having multiple accounts with us.",
- "discountType": "BALANCE",
- "eligibility": [
- {
- "additionalInfo": "Eligibility criteria explanation",
- "additionalValue": "Type specific value, see docs",
- "discountEligibilityType": "BUSINESS"
}
], - "feeRate": "0.0124",
- "transactionRate": "0.00234"
}
], - "feeType": "EXIT",
- "name": "Fee Name",
- "transactionRate": "0.0023"
}
], - "lendingRates": [
- {
- "additionalInfo": "Owner Occupied with Principal and Interest repayment type",
- "additionalInfoUri": "https://www.bank.com.au/personal/apply-online/download-printed-forms/home-loan-update-002842.pdf",
- "additionalValue": "P1Y",
- "applicationFrequency": "P1M",
- "calculationFrequency": "P1D",
- "comparisonRate": "0.0456",
- "interestPaymentDue": "IN_ARREARS",
- "lendingRateType": "FIXED",
- "loanPurpose": "OWNER_OCCUPIED",
- "rate": "0.0456",
- "repaymentType": "PRINCIPAL_AND_INTEREST",
- "tiers": [
- {
- "additionalInfo": "string",
- "applicabilityConditions": {
- "additionalInfo": "Package discount is assessed on the package lending balance when you apply for a package.",
}, - "maximumValue": 0,
- "minimumValue": 0.05,
- "name": "Example Rate Tier",
- "rateApplicationMethod": "WHOLE_BALANCE",
- "unitOfMeasure": "DOLLAR"
}
]
}
]
}
}