Home
/
Our APIs
/
Ext Catalogue Spec for Testing Purposes Jan 19 2026
/
customer

Ext Catalogue Spec for Testing Purposes Jan 19 2026 (1.0.1)

Provides examples for a conformant API

Download OpenAPI description
api.json
api.yaml
Languages
Servers
Mock server

https://developer.api.test.commbank.com.au/_mock/apis/dummy-product/rest-spec-2/api/

customer

counterparty api tag description

Operations

Provides the reference data of Customers

Request

Provides the reference data of the Customers

Description of documentation link
Security
OAuth2
Query
pageSizeinteger(int64)>= 1

Maximum number of results to return at one time

Default 10
Example: pageSize=50
pageinteger(int64)>= 1

The page of the results

Default 1
Example: page=1
Headers
x-request-idstring(uuid)<= 10 characters^[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{...

A unique ID for each API request.

Example:
x-idempotency-idstring(uuid)

A unique id generated by consumer which the server uses to recognise subequent retries of the same request.

Example: 
curl -i -X GET \
  -u <username>:<password> \
  'https://developer.api.test.commbank.com.au/_mock/apis/dummy-product/rest-spec-2/api/party-reference/customers?page=1&pageSize=50' \
  -H 'x-idempotency-id: b8b5ee3a-a755-45e5-a814-d869e432d9a9' \
  -H 'x-request-id: 582dd6b6-61d3-46d5-bcdc-81fad7c27822'

Responses

successful operation

Headers
X-RateLimit-Limitnumber(int32)

The maximum number of requests you're permitted to make per hour.

Example: 10000
X-RateLimit-Remainingnumber(int32)

The number of requests remaining in the current rate limit window.

Example: 9999
X-RateLimit-Resetnumber(int32)

The time at which the current rate limit window resets in UTC epoch seconds.

Example: 1670798639
Content-Typestringrequired

Specifies the media type of the request or response body. If the content is a text-based type, the Content-type must include a character-set parameter of UTF-8.

Example: "application/json; charset=utf-8"
Content-Languagestring

Specifies the language of the content.

Default "en-US"
Example: "de-DE"
Bodyapplication/jsonArray [
idstring(uuid)= 36 characters
namestring<= 1024 characters^[ A-Za-z0-9_,\"@.\/#&+-]*$
Example: "ABC Corp Ltd"
dateOfBirthstring(date)

birthday of the person format YYYY-MM-DD

Example: "1990-06-12"
createdAtstring(date-time)

date and time of the creation of the customer model

Example: "2023-06-25T06:43:40.252Z"
modifiedAtstring(date-time)

last date and time the customer model was modified

Example: "2023-06-29T06:43:40.252Z"
]
Response
application/json
[
  {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "ABC Corp Ltd",
    "dateOfBirth": "1990-06-12",
    "createdAt": "2023-06-25T06:43:40.252Z",
    "modifiedAt": "2023-06-29T06:43:40.252Z"
  }
]

Retrieves customer

Request

Retrieves requested customer data by a unique customer identifier.

Security
OAuth2
Path
customer-idstring>= 6 charactersrequired

The unique identifier of the customer of which details are being accessed.

Query
pageSizeinteger(int64)>= 1

Maximum number of results to return at one time

Default 10
Example: pageSize=50
pageinteger(int64)>= 1

The page of the results

Default 1
Example: page=1
Headers
x-request-idstring(uuid)

A unique ID for each API request.

Example:
x-idempotency-idstring(uuid)

A unique id generated by consumer which the server uses to recognise subequent retries of the same request.

Example: 
curl -i -X GET \
  -u <username>:<password> \
  'https://developer.api.test.commbank.com.au/_mock/apis/dummy-product/rest-spec-2/api/party-reference/customers/{customer-id}?page=1&pageSize=50' \
  -H 'x-idempotency-id: b8b5ee3a-a755-45e5-a814-d869e432d9a9' \
  -H 'x-request-id: 582dd6b6-61d3-46d5-bcdc-81fad7c27822'

Responses

Successful response

Headers
X-RateLimit-Limitnumber(int32)

The maximum number of requests you're permitted to make per hour.

Example: 10000
X-RateLimit-Remainingnumber(int32)

The number of requests remaining in the current rate limit window.

Example: 9999
X-RateLimit-Resetnumber(int32)

The time at which the current rate limit window resets in UTC epoch seconds.

Example: 1670798639
Content-Typestringrequired

Specifies the media type of the request or response body. If the content is a text-based type, the Content-type must include a character-set parameter of UTF-8.

Example: "application/json; charset=utf-8"
Content-Languagestring

Specifies the language of the content.

Default "en-US"
Example: "de-DE"
Bodyapplication/json
idstring(uuid)= 36 characters
namestring<= 1024 characters^[ A-Za-z0-9_,\"@.\/#&+-]*$
Example: "ABC Corp Ltd"
dateOfBirthstring(date)

birthday of the person format YYYY-MM-DD

Example: "1990-06-12"
createdAtstring(date-time)

date and time of the creation of the customer model

Example: "2023-06-25T06:43:40.252Z"
modifiedAtstring(date-time)

last date and time the customer model was modified

Example: "2023-06-29T06:43:40.252Z"
Response
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "ABC Corp Ltd",
  "dateOfBirth": "1990-06-12",
  "createdAt": "2023-06-25T06:43:40.252Z",
  "modifiedAt": "2023-06-29T06:43:40.252Z"
}

Updates customer

Request

Updates the reference data of a customer.

Security
OAuth2
Path
customer-idstring>= 6 charactersrequired

The unique identifier of the customer of which details are being accessed.

Query
namestring

Name of the customer that needs to be updated

Headers
x-request-idstring(uuid)

A unique ID for each API request.

Example:
x-idempotency-idstring(uuid)

A unique id generated by consumer which the server uses to recognise subequent retries of the same request.

Example:
Bodyapplication/jsonArray [
idstring(uuid)= 36 characters
namestring<= 1024 characters^[ A-Za-z0-9_,\"@.\/#&+-]*$
Example: "ABC Corp Ltd"
dateOfBirthstring(date)

birthday of the person format YYYY-MM-DD

Example: "1990-06-12"
createdAtstring(date-time)

date and time of the creation of the customer model

Example: "2023-06-25T06:43:40.252Z"
modifiedAtstring(date-time)

last date and time the customer model was modified

Example: "2023-06-29T06:43:40.252Z"
]
curl -i -X PUT \
  -u <username>:<password> \
  'https://developer.api.test.commbank.com.au/_mock/apis/dummy-product/rest-spec-2/api/party-reference/customers/{customer-id}?name=string' \
  -H 'Content-Type: application/json' \
  -H 'x-idempotency-id: b8b5ee3a-a755-45e5-a814-d869e432d9a9' \
  -H 'x-request-id: 582dd6b6-61d3-46d5-bcdc-81fad7c27822' \
  -d '[
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "name": "ABC Corp Ltd",
      "dateOfBirth": "1990-06-12",
      "createdAt": "2023-06-25T06:43:40.252Z",
      "modifiedAt": "2023-06-29T06:43:40.252Z"
    }
  ]'

Responses

successful operation

Headers
X-RateLimit-Limitnumber(int32)

The maximum number of requests you're permitted to make per hour.

Example: 10000
X-RateLimit-Remainingnumber(int32)

The number of requests remaining in the current rate limit window.

Example: 9999
X-RateLimit-Resetnumber(int32)

The time at which the current rate limit window resets in UTC epoch seconds.

Example: 1670798639
Content-Typestringrequired

Specifies the media type of the request or response body. If the content is a text-based type, the Content-type must include a character-set parameter of UTF-8.

Example: "application/json; charset=utf-8"
Content-Languagestring

Specifies the language of the content.

Default "en-US"
Example: "de-DE"
Bodyapplication/jsonArray [
idstring(uuid)= 36 characters
namestring<= 1024 characters^[ A-Za-z0-9_,\"@.\/#&+-]*$
Example: "ABC Corp Ltd"
dateOfBirthstring(date)

birthday of the person format YYYY-MM-DD

Example: "1990-06-12"
createdAtstring(date-time)

date and time of the creation of the customer model

Example: "2023-06-25T06:43:40.252Z"
modifiedAtstring(date-time)

last date and time the customer model was modified

Example: "2023-06-29T06:43:40.252Z"
]
Response
application/json
[
  {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "ABC Corp Ltd",
    "dateOfBirth": "1990-06-12",
    "createdAt": "2023-06-25T06:43:40.252Z",
    "modifiedAt": "2023-06-29T06:43:40.252Z"
  }
]

counterparty

counterparty api tag description

health check endpoint

Request

Health check endpoint for checking API. Provides information on if the service is up and running

Security
OAuth2
Headers
x-request-idstring(uuid)<= 10 characters^[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{...

A unique ID for each API request.

Example: 
curl -i -X GET \
  -u <username>:<password> \
  https://developer.api.test.commbank.com.au/_mock/apis/dummy-product/rest-spec-2/api/health \
  -H 'x-request-id: 582dd6b6-61d3-46d5-bcdc-81fad7c27822'

Responses

successful operation

Headers
X-RateLimit-Limitnumber(int32)

The maximum number of requests you're permitted to make per hour.

Example: 10000
X-RateLimit-Remainingnumber(int32)

The number of requests remaining in the current rate limit window.

Example: 9999
X-RateLimit-Resetnumber(int32)

The time at which the current rate limit window resets in UTC epoch seconds.

Example: 1670798639
Content-Typestringrequired

Specifies the media type of the request or response body. If the content is a text-based type, the Content-type must include a character-set parameter of UTF-8.

Example: "application/json; charset=utf-8"
Content-Languagestring

Specifies the language of the content.

Default "en-US"
Example: "de-DE"
Bodyapplication/health+json
statusstringrequired

Indicates whether service is acceptable or not

Enum"HEALTHY""UNHEALTHY""DEGRADED""WARN"
Example: "HEALTHY"
messagestring<= 1024 characters^[ A-Za-z0-9_,\"@.\/#&+-]*$
checksobject
Response
application/health+json
{
  "status": "HEALTHY",
  "message": "string",
  "checks": {}
}

health check endpoint for downstream

Request

Health check endpoint for checking API downstream services

Headers
x-request-idstring(uuid)<= 10 characters^[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{...

A unique ID for each API request.

Example: 
curl -i -X GET \
  https://developer.api.test.commbank.com.au/_mock/apis/dummy-product/rest-spec-2/api/health/info \
  -H 'x-request-id: 582dd6b6-61d3-46d5-bcdc-81fad7c27822'

Responses

sucessful operation

Headers
X-RateLimit-Limitnumber(int32)

The maximum number of requests you're permitted to make per hour.

Example: 10000
X-RateLimit-Remainingnumber(int32)

The number of requests remaining in the current rate limit window.

Example: 9999
X-RateLimit-Resetnumber(int32)

The time at which the current rate limit window resets in UTC epoch seconds.

Example: 1670798639
Content-Typestringrequired

Specifies the media type of the request or response body. If the content is a text-based type, the Content-type must include a character-set parameter of UTF-8.

Example: "application/json; charset=utf-8"
Content-Languagestring

Specifies the language of the content.

Default "en-US"
Example: "de-DE"
Bodyapplication/health+json
statusstringrequired

Indicates whehter service is acceptable or not

Enum"HEALTHY""UNHEALTHY""DEGRADED""WARN"
Example: "HEALTHY"
messagestring<= 1024 characters^[ A-Za-z0-9_,\"@.\/#&+-]*$
checksobject
Response
application/health+json
{
  "status": "HEALTHY",
  "message": "string",
  "checks": {}
}
Terms of use
© 2025 Commonwealth Bank of Australia ABN 48 123 123 124 AFSL and Australian credit licence 234945