CommBank Regular Payments API

Download OpenAPI specification:Download OpenAPI specification

Regular Payments API

Obtain the Regular Payment details authorised to be shared by the customer.

Regular Payments API is a consumer API. To access data you'll need the customer's consent.

Host URL

CommBank requests are passed to the URL https://secure.api.commbank.com.au/api/cds-au/v1/banking

CBA – CommBiz requests are passed to the URL https://secure.cdr.commbiz.api.commbank.com.au/cbzapi/cds-au/v1/banking

Get Direct Debits For Account

Obtain direct debit authorisations for a specific account.

path Parameters

accountId

required

string

ID of the account to get direct debit authorisations for.

query Parameters

page	integer Default: 1 Page number being requested
page-size	integer [ 1 .. 1000 ] Default: 25 Number of records to return with the page

header Parameters

x-v	integer Example: 1 Version of the API end point being requested.
x-min-v	integer Example: 1 Minimum version of the API end point you are requesting.
x-fapi-interaction-id	string Example: "f688ae24-9719-4975-9f58-f6b7e655c37d" Reflects the value of the Interaction ID in the request.
x-fapi-auth-date	string Example: "2002-10-03T01:00:00+10:00" The time when the customer last logged in to the data recipient.
x-fapi-customer-ip-address	string Example: "192.168.1.1" The customer's original IP address if the customer is currently logged in to the data recipient.
x-cds-client-headers	string Example: "Q3VzdG9tZXJzRGV2OkN1c3RvbWVyc0Rldg==" The customer's original standard http headers encoded, including the original User Agent header, if the customer is currently logged in to the data recipient.

Responses

200

Success

400

Bad Request

406

Not Acceptable

422

Unprocessable Entity.

429

Too Many Requests.

500

Internal Server Error.

get /accounts/{accountId}/direct-debits

https://secure.api.commbank.com.au/api/cds-au/v1/banking/accounts/{accountId}/direct-debits

Response samples

application/json

{

"data":
{
- "directDebitAuthorisations":
  [
  - {
    "accountId": "ygEST5viDcah5JJcdvT2uRDxuCbQezp0zWMrWrgSDb4",
    "lastDebitDateTime": "2020-07-07T14:00:00Z",
    "lastDebitAmount": "30.00",
    "authorisedEntity":
    {
    "description": "Kleenheat Gas Murdoch"
    }
    },
  - {
    "accountId": "ygEST5viDcah5JJcdvT2uRDxuCbQezp0zWMrWrgSDb4",
    "lastDebitDateTime": "2020-09-01T14:00:00Z",
    "lastDebitAmount": "89.99",
    "authorisedEntity":
    {
    "description": "TPG Internet Pty Ltd"
    }
    }
  ]
},
"links":
{
},
"meta":
{
- "totalRecords": 2,
- "totalPages": 1
}

}

Get Bulk Direct Debits

Obtain direct debit authorisations for multiple, filtered accounts.

query Parameters

product-category	string Enum:"BUSINESS_LOANS" "CRED_AND_CHRG_CARDS" "LEASES" "MARGIN_LOANS" "OVERDRAFTS" "PERS_LOANS" "REGULATED_TRUST_ACCOUNTS" "RESIDENTIAL_MORTGAGES" "TERM_DEPOSITS" "TRADE_FINANCE" "TRAVEL_CARDS" "TRANS_AND_SAVINGS_ACCOUNTS" Used to filter results on the productCategory field applicable to accounts. If absent then all accounts returned.
open-status	string Default: "ALL" Enum:"OPEN" "CLOSED" "ALL" Used to filter results according to open/closed status. If absent then ALL is assumed.
is-owned	boolean Filters accounts based on whether they are owned by the authorised customer. True for owned accounts, false for unowned accounts and absent for all accounts.
page	integer Default: 1 Page number being requested
page-size	integer [ 1 .. 1000 ] Default: 25 Number of records to return with the page

header Parameters

x-v	integer Example: 1 Version of the API end point being requested.
x-min-v	integer Example: 1 Minimum version of the API end point you are requesting.
x-fapi-interaction-id	string Example: "f688ae24-9719-4975-9f58-f6b7e655c37d" Reflects the value of the Interaction ID in the request.
x-fapi-auth-date	string Example: "2002-10-03T01:00:00+10:00" The time when the customer last logged in to the data recipient.
x-fapi-customer-ip-address	string Example: "192.168.1.1" The customer's original IP address if the customer is currently logged in to the data recipient.
x-cds-client-headers	string Example: "Q3VzdG9tZXJzRGV2OkN1c3RvbWVyc0Rldg==" The customer's original standard http headers encoded, including the original User Agent header, if the customer is currently logged in to the data recipient.

Responses

200

Success

400

Bad Request

406

Not Acceptable

422

Unprocessable Entity.

429

Too Many Requests

500

Internal Server Error

get /accounts/direct-debits

https://secure.api.commbank.com.au/api/cds-au/v1/banking/accounts/direct-debits

Response samples

application/json

{

"data":
{
- "directDebitAuthorisations":
  [
  - {
    "accountId": "yV9HHs_mV8b14MRed6L0uhHw7CuDez8gm29xDb8TDLw",
    "lastDebitDateTime": "2020-08-20T14:00:00Z",
    "lastDebitAmount": "11.99",
    "authorisedEntity":
    {
    "description": "Spotify P10fc4db06"
    }
    },
  - {
    "accountId": "yV9HHs_mV8b14MRed6L0uhHw7CuDez8gm29xDb8TDLw",
    "lastDebitDateTime": "2020-06-02T14:00:00Z",
    "lastDebitAmount": "29.95",
    "authorisedEntity":
    {
    "description": "NRMA Insurance 1"
    }
    },
  - {
    "accountId": "yV9HHs_mV8b14MRed6L0uhHw7CuDez8gm29xDb8TDLw",
    "lastDebitDateTime": "2020-10-26T13:00:00Z",
    "lastDebitAmount": "371.96",
    "authorisedEntity":
    {
    "description": "Nib"
    }
    },
  - {
    "accountId": "yV9HHs_mV8b14MRed6L0uhHw7CuDez8gm29xDb8TDLw",
    "lastDebitDateTime": "2020-06-02T14:00:00Z",
    "lastDebitAmount": "29.95",
    "authorisedEntity":
    {
    "description": "Commonwealth Sec"
    }
    },
  - {
    "accountId": "yV9HHs_mV8b14MRed6L0uhHw7CuDez8gm29xDb8TDLw",
    "lastDebitDateTime": "2020-08-25T14:00:00Z",
    "lastDebitAmount": "130.00",
    "authorisedEntity":
    {
    "description": "Optus Billing"
    }
    },
  - {
    "accountId": "ygEST5viDcah5JJcdvT2uRDxuCbQezp0zWMrWrgSDb4",
    "lastDebitDateTime": "2020-07-07T14:00:00Z",
    "lastDebitAmount": "30.00",
    "authorisedEntity":
    {
    "description": "Kleenheat Gas Murdoch"
    }
    },
  - {
    "accountId": "ygEST5viDcah5JJcdvT2uRDxuCbQezp0zWMrWrgSDb4",
    "lastDebitDateTime": "2020-09-01T14:00:00Z",
    "lastDebitAmount": "89.99",
    "authorisedEntity":
    {
    "description": "TPG Internet Pty Ltd"
    }
    }
  ]
},
"links":
{
},
"meta":
{
- "totalRecords": 7,
- "totalPages": 1
}

}

Get Direct Debits For Specific Accounts

Obtain direct debit authorisations for a specified list of accounts.

query Parameters

page	integer Default: 1 Page number being requested
page-size	integer [ 1 .. 1000 ] Default: 25 Number of records to return with the page

header Parameters

x-v	integer Example: 1 Version of the API end point being requested.
x-min-v	integer Example: 1 Minimum version of the API end point you are requesting.
x-fapi-auth-date	string Example: "2002-10-03T01:00:00+10:00" The time when the customer last logged in to the data recipient.
x-fapi-interaction-id	string Example: "f688ae24-9719-4975-9f58-f6b7e655c37d" Reflects the value of the Interaction ID in the request.
x-fapi-customer-ip-address	string Example: "192.168.1.1" The customer's original IP address if the customer is currently logged in to the data recipient.
x-cds-client-headers	string Example: "Q3VzdG9tZXJzRGV2OkN1c3RvbWVyc0Rldg==" The customer's original standard http headers encoded, including the original User Agent header, if the customer is currently logged in to the data recipient.

Request Body schema: application/json

data required	object (RequestAccountIds_data)
meta	object (Meta)

Responses

200

Success

400

Bad Request

406

Not Acceptable

422

Unprocessable Entity.

429

Too Many Requests.

500

Internal Server Error

post /accounts/direct-debits

https://secure.api.commbank.com.au/api/cds-au/v1/banking/accounts/direct-debits

Request samples

Payload

application/json

{

"data":
{
- "accountIds":
  [
  - "2M_8F2Q0aPjdPnO-FYMkt6fOBQNBPobNrXzAjwzrmWQ",
  - "8L_GAHf3425ADFf-FYMkt6fOBQNBPobNrXzAjwzrmWQ"
  ]
},
"meta": { }

}

Get Scheduled Payments for Account

Obtain scheduled, outgoing payments for a specific account.

path Parameters

accountId

required

string

ID of the account to get scheduled payments for.

query Parameters

page	integer Default: 1 Page number being requested
page-size	integer [ 1 .. 1000 ] Default: 25 Number of records to return with the page

header Parameters

x-v	integer Example: 1 Version of the API end point being requested.
x-min-v	integer Example: 1 Minimum version of the API end point you are requesting.
x-fapi-auth-date	string Example: "2002-10-03T01:00:00+10:00" The time when the customer last logged in to the data recipient.
x-fapi-interaction-id	string Example: "f688ae24-9719-4975-9f58-f6b7e655c37d" Reflects the value of the Interaction ID in the request.
x-fapi-customer-ip-address	string Example: "192.168.1.1" The customer's original IP address if the customer is currently logged in to the data recipient.
x-cds-client-headers	string Example: "Q3VzdG9tZXJzRGV2OkN1c3RvbWVyc0Rldg==" The customer's original standard http headers encoded, including the original User Agent header, if the customer is currently logged in to the data recipient.

Responses

200

Success

400

Bad Request.

406

Not Acceptable

422

Unprocessable Entity.

429

Too Many Requests

500

Internal Server Error

get /accounts/{accountId}/payments/scheduled

https://secure.api.commbank.com.au/api/cds-au/v1/banking/accounts/{accountId}/payments/scheduled

Response samples

application/json

{

"data":
{
- "scheduledPayments":
  [
  - {
    "scheduledPaymentId": "zFFDTZuzApyks5JddvD0vhCjv3rVJWgqzGoiXu9ADLo",
    "nickname": "nicknametest",
    "payerReference": "Payer Ref T3",
    "payeeReference": "",
    "status": "ACTIVE",
    "from":
    {
    "accountId": "yV9HHs_mV8b14MRed6L0uhHw7CuDez8gm29xDb8TDLw"
    },
    "paymentSet":
    [
    {
    "to":
    {
    "toUType": "biller",
    "biller":
    {
    "billerCode": "1313",
    "crn": "791940509106",
    "billerName": "EnergyAustralia Electricity"
    }
    },
    "amount": "35.00",
    "currency": "AUD"
    }
    ],
    "recurrence":
    {
    "nextPaymentDate": "2020-10-30",
    "recurrenceUType": "intervalSchedule",
    "intervalSchedule":
    {
    "finalPaymentDate": "2020-12-11",
    "paymentsRemaining": 4,
    "intervals":
    [
    {
    "interval": "P14D"
    }
    ]
    }
    }
    },
  - {
    "scheduledPaymentId": "mF9DTprhA8bysMUIdqSouUn96y2Bc2t3ymxwDroXCr8",
    "payerReference": "Payer Ref T4",
    "payeeReference": "Pay Ref T4",
    "status": "ACTIVE",
    "from":
    {
    "accountId": "yV9HHs_mV8b14MRed6L0uhHw7CuDez8gm29xDb8TDLw"
    },
    "paymentSet":
    [
    {
    "to":
    {
    "toUType": "domestic",
    "domestic":
    {
    "payeeAccountUType": "card",
    "card":
    {
    "cardNumber": "xxxx xxxx xxxx 8706"
    }
    }
    },
    "amount": "45.00",
    "currency": "AUD"
    }
    ],
    "recurrence":
    {
    "nextPaymentDate": "2020-10-31",
    "recurrenceUType": "intervalSchedule",
    "intervalSchedule":
    {
    "finalPaymentDate": "2020-12-31",
    "paymentsRemaining": 2,
    "intervals":
    [
    {
    "interval": "P0.5M"
    }
    ]
    }
    }
    },
  - {
    "scheduledPaymentId": "zVBFQpu0AJGh6ZELdqCo7xGntC-BdmknmWMnWL8dW7k",
    "payerReference": "Payer Ref T2",
    "payeeReference": "Payee Ref T2",
    "status": "ACTIVE",
    "from":
    {
    "accountId": "yV9HHs_mV8b14MRed6L0uhHw7CuDez8gm29xDb8TDLw"
    },
    "paymentSet":
    [
    {
    "to":
    {
    "toUType": "domestic",
    "domestic":
    {
    "payeeAccountUType": "account",
    "account":
    {
    "accountName": "belle",
    "bsb": "032069",
    "accountNumber": "540546"
    }
    }
    },
    "amount": "25.00",
    "currency": "AUD"
    }
    ],
    "recurrence":
    {
    "nextPaymentDate": "2020-10-31",
    "recurrenceUType": "intervalSchedule",
    "intervalSchedule":
    {
    "finalPaymentDate": "2020-11-14",
    "paymentsRemaining": 3,
    "intervals":
    [
    {
    "interval": "P7D"
    }
    ]
    }
    }
    },
  - {
    "scheduledPaymentId": "mANFSMniVsWi4scNdvekukr263_Sdm5znD8iX7lCWe8",
    "payerReference": "Payer reference T1",
    "payeeReference": "Payee Ref T1",
    "status": "ACTIVE",
    "from":
    {
    "accountId": "yV9HHs_mV8b14MRed6L0uhHw7CuDez8gm29xDb8TDLw"
    },
    "paymentSet":
    [
    {
    "to":
    {
    "toUType": "domestic",
    "domestic":
    {
    "payeeAccountUType": "account",
    "account":
    {
    "accountName": "",
    "bsb": "062268",
    "accountNumber": "11993757"
    }
    }
    },
    "amount": "15.00",
    "currency": "AUD"
    }
    ],
    "recurrence":
    {
    "nextPaymentDate": "2020-11-28",
    "recurrenceUType": "intervalSchedule",
    "intervalSchedule":
    {
    "finalPaymentDate": "2020-11-28",
    "paymentsRemaining": 1,
    "intervals":
    [
    {
    "interval": "P1M"
    }
    ]
    }
    }
    }
  ]
},
"links":
{
},
"meta":
{
- "totalRecords": 4,
- "totalPages": 1
}

}

Get Scheduled Payments Bulk

Obtain scheduled payments for multiple, filtered accounts that are the source of funds for the payments

query Parameters

product-category	string Enum:"BUSINESS_LOANS" "CRED_AND_CHRG_CARDS" "LEASES" "MARGIN_LOANS" "OVERDRAFTS" "PERS_LOANS" "REGULATED_TRUST_ACCOUNTS" "RESIDENTIAL_MORTGAGES" "TERM_DEPOSITS" "TRADE_FINANCE" "TRAVEL_CARDS" "TRANS_AND_SAVINGS_ACCOUNTS" Used to filter results on the productCategory field applicable to accounts. If absent then all accounts returned.
open-status	string Default: "ALL" Enum:"OPEN" "CLOSED" "ALL" Used to filter results according to open/closed status. If absent then ALL is assumed.
is-owned	boolean Filters accounts based on whether they are owned by the authorised customer. True for owned accounts, false for unowned accounts and absent for all accounts.
page	integer Default: 1 Page number being requested
page-size	integer [ 1 .. 1000 ] Default: 25 Number of records to return with the page

header Parameters

x-v	integer Example: 1 Version of the API end point being requested.
x-min-v	integer Example: 1 Minimum version of the API end point you are requesting.
x-fapi-auth-date	string Example: "2002-10-03T01:00:00+10:00" The time when the customer last logged in to the data recipient.
x-fapi-interaction-id	string Example: "f688ae24-9719-4975-9f58-f6b7e655c37d" Reflects the value of the Interaction ID in the request.
x-fapi-customer-ip-address	string Example: "192.168.1.1" The customer's original IP address if the customer is currently logged in to the data recipient.
x-cds-client-headers	string Example: "Q3VzdG9tZXJzRGV2OkN1c3RvbWVyc0Rldg==" The customer's original standard http headers encoded, including the original User Agent header, if the customer is currently logged in to the data recipient.

Responses

200

Success

400

Bad Request.

406

Not Acceptable.

422

Unprocessable Entity.

429

Too Many Requests.

500

Internal Server Error.

get /payments/scheduled

https://secure.api.commbank.com.au/api/cds-au/v1/banking/payments/scheduled

Response samples

application/json

{

"data":
{
- "scheduledPayments":
  [
  - {
    "scheduledPaymentId": "20497737",
    "payerReference": "Payer Ref T7",
    "payeeReference": "Payee Ref T7",
    "status": "ACTIVE",
    "from":
    {
    "accountId": "nl9HSZzoVJLzt8APdvL1uUnzvCqAJ25zm2MmWL9BC78"
    },
    "paymentSet":
    [
    {
    "to":
    {
    "toUType": "accountId",
    "accountId": "yV9HHs_mV8b14MRed6L0uhHw7CuDez8gm29xDb8TDLw"
    },
    "amount": "10.00",
    "currency": "AUD"
    }
    ],
    "recurrence":
    {
    "nextPaymentDate": "2020-10-31",
    "recurrenceUType": "intervalSchedule",
    "intervalSchedule":
    {
    "intervals":
    [
    {
    "interval": "P7D"
    }
    ]
    }
    }
    },
  - {
    "scheduledPaymentId": "20496938",
    "payerReference": "Payer reference T1",
    "payeeReference": "Payee Ref T1",
    "status": "ACTIVE",
    "from":
    {
    "accountId": "yV9HHs_mV8b14MRed6L0uhHw7CuDez8gm29xDb8TDLw"
    },
    "paymentSet":
    [
    {
    "to":
    {
    "toUType": "accountId",
    "accountId": "nl9HSZzoVJLzt8APdvL1uUnzvCqAJ25zm2MmWL9BC78"
    },
    "amount": "15.00",
    "currency": "AUD"
    }
    ],
    "recurrence":
    {
    "nextPaymentDate": "2020-10-28",
    "recurrenceUType": "intervalSchedule",
    "intervalSchedule":
    {
    "finalPaymentDate": "2020-11-28",
    "paymentsRemaining": 2,
    "intervals":
    [
    {
    "interval": "P1M"
    }
    ]
    }
    }
    },
  - {
    "scheduledPaymentId": "20496940",
    "nickname": "nicknametest",
    "payerReference": "Payer Ref T3",
    "payeeReference": "",
    "status": "ACTIVE",
    "from":
    {
    "accountId": "yV9HHs_mV8b14MRed6L0uhHw7CuDez8gm29xDb8TDLw"
    },
    "paymentSet":
    [
    {
    "to":
    {
    "toUType": "biller",
    "biller":
    {
    "billerCode": "1313",
    "crn": "791940509106",
    "billerName": "EnergyAustralia Electricity"
    }
    },
    "amount": "35.00",
    "currency": "AUD"
    }
    ],
    "recurrence":
    {
    "nextPaymentDate": "2020-10-30",
    "recurrenceUType": "intervalSchedule",
    "intervalSchedule":
    {
    "finalPaymentDate": "2020-12-11",
    "paymentsRemaining": 4,
    "intervals":
    [
    {
    "interval": "P14D"
    }
    ]
    }
    }
    },
  - {
    "scheduledPaymentId": "20496939",
    "payerReference": "Payer Ref T2",
    "payeeReference": "Payee Ref T2",
    "status": "ACTIVE",
    "from":
    {
    "accountId": "yV9HHs_mV8b14MRed6L0uhHw7CuDez8gm29xDb8TDLw"
    },
    "paymentSet":
    [
    {
    "to":
    {
    "toUType": "domestic",
    "domestic":
    {
    "payeeAccountUType": "account",
    "account":
    {
    "accountName": "belle",
    "bsb": "032069",
    "accountNumber": "540546"
    }
    }
    },
    "amount": "25.00",
    "currency": "AUD"
    }
    ],
    "recurrence":
    {
    "nextPaymentDate": "2020-10-31",
    "recurrenceUType": "intervalSchedule",
    "intervalSchedule":
    {
    "finalPaymentDate": "2020-11-14",
    "paymentsRemaining": 3,
    "intervals":
    [
    {
    "interval": "P7D"
    }
    ]
    }
    }
    },
  - {
    "scheduledPaymentId": "20496941",
    "payerReference": "Payer Ref T4",
    "payeeReference": "Pay Ref T4",
    "status": "ACTIVE",
    "from":
    {
    "accountId": "yV9HHs_mV8b14MRed6L0uhHw7CuDez8gm29xDb8TDLw"
    },
    "paymentSet":
    [
    {
    "to":
    {
    "toUType": "domestic",
    "domestic":
    {
    "payeeAccountUType": "card",
    "card":
    {
    "cardNumber": "xxxx xxxx xxxx 8706"
    }
    }
    },
    "amount": "45.00",
    "currency": "AUD"
    }
    ],
    "recurrence":
    {
    "nextPaymentDate": "2020-10-31",
    "recurrenceUType": "intervalSchedule",
    "intervalSchedule":
    {
    "finalPaymentDate": "2020-12-31",
    "paymentsRemaining": 2,
    "intervals":
    [
    {
    "interval": "P0.5M"
    }
    ]
    }
    }
    }
  ]
},
"links":
{
},
"meta":
{
- "totalRecords": 5,
- "totalPages": 1
}

}

Get Scheduled Payments For Specific Accounts

Obtain scheduled payments for a specified list of accounts.

query Parameters

page	integer Default: 1 Page number being requested
page-size	integer [ 1 .. 1000 ] Default: 25 Number of records to return with the page

header Parameters

x-v	integer Example: 1 Version of the API end point being requested.
x-min-v	integer Example: 1 Minimum version of the API end point you are requesting.
x-fapi-auth-date	string Example: "2002-10-03T01:00:00+10:00" The time when the customer last logged in to the data recipient.
x-fapi-interaction-id	string Example: "f688ae24-9719-4975-9f58-f6b7e655c37d" Reflects the value of the Interaction ID in the request.
x-fapi-customer-ip-address	string Example: "192.168.1.1" The customer's original IP address if the customer is currently logged in to the data recipient.
x-cds-client-headers	string Example: "Q3VzdG9tZXJzRGV2OkN1c3RvbWVyc0Rldg==" The customer's original standard http headers encoded, including the original User Agent header, if the customer is currently logged in to the data recipient.

Request Body schema: application/json

data required	object (RequestAccountIds_data)
meta	object (Meta)

Responses

200

Success

400

Bad Request.

406

Not Acceptable.

422

Unprocessable Entity.

429

Too Many Requests.

500

Internal Server Error.

post /payments/scheduled

https://secure.api.commbank.com.au/api/cds-au/v1/banking/payments/scheduled

Request samples

Payload

application/json

{

"data":
{
- "accountIds":
  [
  - "2M_8F2Q0aPjdPnO-FYMkt6fOBQNBPobNrXzAjwzrmWQ",
  - "8L_GAHf3425ADFf-FYMkt6fOBQNBPobNrXzAjwzrmWQ"
  ]
},
"meta": { }

}