Skip to main content

API Testing

API Testing is currently in Beta. This feature allows you to verify your product data through the CDR Products endpoint without leaving the Console.
The API Test feature provides a built-in way to verify how your products are exposed through the CDR API in both Staging and Production environments. Use it to confirm your product configuration is correct before and after publishing changes.

Open Product Portal

Access the API Test feature in the Fiskil Console.

Why use API Testing

Instant verification

Test your Products endpoint directly from Product Portal without switching tools.

Environment comparison

Compare API responses between Staging and Production to verify deployments.

Debug configuration

Quickly identify issues with product data or API exposure settings.

Validate before go-live

Confirm your products appear correctly in the API before publishing to Production.

Accessing API Test

1

Navigate to Product Portal

In the Fiskil Console, go to Product Portal from the main navigation.
2

Open API Test

Click the Test API button in the top-right corner of the Products page.
3

View the API Test panel

The API Test panel opens, showing the CDR Products endpoint configuration and response preview.

Using the API Test panel

The API Test panel provides a complete interface for testing your Products endpoint.

Select environment

Choose which environment to test against:
EnvironmentUse case
StagingVerify new products or changes before publishing to Production
ProductionConfirm live product data is correct and accessible
Always test in Staging first when making changes. Once verified, publish to Production and test again to confirm the deployment.

Request configuration

The panel displays the following request details:
Request URL
string
The full URL of the CDR Products endpoint for your Data Provider. This is automatically populated based on your instance configuration and selected environment.
Headers
object
Required headers for the API request, including the x-v header specifying the API version.

Send a request

Click Send Request to execute the API call. The response appears in the panel below.

Understanding the response

After sending a request, the API Test panel displays:

Response status

A status badge indicates the result:
StatusDescription
200 OKRequest successful — products returned
400 Bad RequestInvalid request parameters
401 UnauthorizedAuthentication failed
404 Not FoundEndpoint not found
500 Server ErrorInternal server error

Response body

The response body shows the JSON payload returned by the Products endpoint. The Get Products endpoint returns a list of products with core fields:
Get Products response
{
  "data": {
    "products": [
      {
        "productId": "home-loan-variable-001",
        "name": "Standard Variable Home Loan",
        "description": "Our standard variable rate home loan for owner occupiers with flexible repayment options.",
        "brand": "Example Bank",
        "brandName": "Example Bank",
        "productCategory": "RESIDENTIAL_MORTGAGES",
        "isTailored": false,
        "lastUpdated": "2025-01-15T09:30:00Z",
        "additionalInformation": {
          "overviewUri": "https://www.example.com.au/home-loans/variable",
          "termsUri": "https://www.example.com.au/home-loans/terms",
          "eligibilityUri": "https://www.example.com.au/home-loans/eligibility",
          "feesAndPricingUri": "https://www.example.com.au/home-loans/fees"
        }
      }
    ]
  },
  "links": {
    "self": "https://api.example.com.au/cds-au/v1/banking/products"
  },
  "meta": {
    "totalRecords": 1,
    "totalPages": 1
  }
}
To retrieve the full product details including rates, fees, and features, call the Get Product Detail endpoint:
Get Product Detail response
{
  "data": {
    "productId": "home-loan-variable-001",
    "name": "Standard Variable Home Loan",
    "description": "Our standard variable rate home loan for owner occupiers with flexible repayment options.",
    "brand": "Example Bank",
    "brandName": "Example Bank",
    "productCategory": "RESIDENTIAL_MORTGAGES",
    "isTailored": false,
    "lastUpdated": "2025-01-15T09:30:00Z",
    "additionalInformation": {
      "overviewUri": "https://www.example.com.au/home-loans/variable",
      "termsUri": "https://www.example.com.au/home-loans/terms",
      "eligibilityUri": "https://www.example.com.au/home-loans/eligibility",
      "feesAndPricingUri": "https://www.example.com.au/home-loans/fees"
    },
    "features": [
      {
        "featureType": "OFFSET",
        "additionalInfo": "100% offset account available"
      },
      {
        "featureType": "REDRAW",
        "additionalInfo": "Free redraw facility available"
      },
      {
        "featureType": "DIGITAL_BANKING",
        "additionalInfo": "Manage your loan via online and mobile banking"
      }
    ],
    "eligibility": [
      {
        "eligibilityType": "MIN_AGE",
        "additionalValue": "18"
      },
      {
        "eligibilityType": "RESIDENCY_STATUS",
        "additionalValue": "Australian citizen or permanent resident"
      }
    ],
    "fees": [
      {
        "name": "Application Fee",
        "feeType": "UPFRONT",
        "amount": "600.00",
        "currency": "AUD"
      },
      {
        "name": "Monthly Service Fee",
        "feeType": "PERIODIC",
        "amount": "10.00",
        "currency": "AUD",
        "additionalValue": "P1M"
      }
    ],
    "lendingRates": [
      {
        "lendingRateType": "VARIABLE",
        "rate": "0.0649",
        "comparisonRate": "0.0672",
        "calculationFrequency": "P1D",
        "applicationFrequency": "P1M",
        "interestPaymentDue": "IN_ARREARS",
        "repaymentType": "PRINCIPAL_AND_INTEREST",
        "loanPurpose": "OWNER_OCCUPIED",
        "additionalInfo": "Standard variable rate for owner occupied, principal and interest repayments"
      }
    ],
    "constraints": [
      {
        "constraintType": "MIN_LIMIT",
        "additionalValue": "50000.00"
      },
      {
        "constraintType": "MAX_LIMIT",
        "additionalValue": "5000000.00"
      }
    ]
  },
  "links": {
    "self": "https://api.example.com.au/cds-au/v1/banking/products/home-loan-variable-001"
  }
}
The response follows the CDR Banking Product API specification. Rates are expressed as decimals (e.g., 0.0649 represents 6.49%). Refer to the standard for complete field definitions.

Common testing scenarios

Verify a new product

After creating a product in Product Portal:
1

Deploy to Staging

Deploy your new product to the Staging environment.
2

Open API Test

Click Test API and select Staging as the environment.
3

Send request

Click Send Request and verify your product appears in the response.
4

Check product fields

Confirm all fields are correctly populated, including:
  • productId
  • name
  • description
  • productCategory
  • lastUpdated

Compare Staging and Production

To verify a deployment was successful:
1

Test Staging

Select Staging environment and send a request. Note the products and their lastUpdated timestamps.
2

Test Production

Switch to Production environment and send a request.
3

Compare responses

Verify the expected products appear in Production with the correct data.

Debug missing products

If a product doesn’t appear in the API response:
Check the product status in Product Portal. Products must be deployed to appear in the API.
  • NEEDS_REVIEW — Product has pending changes that need approval
  • DRAFT — Product not yet deployed
  • PUBLISHED — Product is live
Verify you’re testing the correct environment. Products deployed to Staging won’t appear in Production until published.
Archived products may not appear in the Products list endpoint. Check if the product has an expired effectiveTo date.
Products with validation errors cannot be deployed. Return to the product editor and resolve any errors shown.

Best practices

Test after every deployment

Always verify the API response after deploying changes to catch issues early.

Compare environments regularly

Regularly compare Staging and Production to ensure they’re in sync as expected.

Check timestamps

Use the lastUpdated field to confirm you’re seeing the latest version of your products.

Document issues

If you encounter unexpected responses, note the details before contacting support.

Limitations

API Testing is currently in Beta and has the following limitations:
  • Products endpoint only — Currently supports testing the Get Products endpoint. Additional endpoints may be added in future releases.
  • Read-only — You cannot modify product data through the API Test panel.
  • No authentication testing — The test uses internal authentication. It does not test external client authentication flows.