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
"}],"x-tagGroups":[{"name":"","tags":["Transaction API"]}],"paths":{"/accounts/{accountId}/transactions":{"get":{"summary":"Get Transactions","description":"Obtain transactions for a specific account","operationId":"getTransactions","tags":["Transaction API"],"consumes":["application/json"],"produces":["application/json"],"x-scopes":["bank:transactions:read"],"x-version":"1","parameters":[{"name":"accountId","in":"path","description":"ID of the account.","required":true,"type":"string","x-cds-type":"ASCIIString"},{"name":"oldest-time","in":"query","description":"Constrain transactions with effective time (UTC) at or after this date/time.","required":false,"type":"string","x-cds-type":"DateTimeString"},{"name":"newest-time","in":"query","description":"Constrain transactions with effective time (UTC) at or before this date/time.","required":false,"type":"string","x-cds-type":"DateTimeString"},{"name":"min-amount","in":"query","description":"Filter transactions to only transactions with amounts higher or equal to than this amount.","required":false,"type":"string","x-cds-type":"AmountString"},{"name":"max-amount","in":"query","description":"Filter transactions to only transactions with amounts less than or equal to this amount.","required":false,"type":"string","x-cds-type":"AmountString"},{"$ref":"#/parameters/ParamAcceptHeader"},{"$ref":"#/parameters/ParamXVHeader"},{"$ref":"#/parameters/ParamXMinVHeader"},{"$ref":"#/parameters/ParamXFapiInterationId"},{"$ref":"#/parameters/ParamXFapiCustomerIpAddress"},{"$ref":"#/parameters/ParamXCdsClientHeaders"},{"$ref":"#/parameters/ParamPage"},{"$ref":"#/parameters/ParamPageSize"}],"responses":{"200":{"description":"Success","headers":{"Content-Type":{"type":"string","description":"Payload format responded with."},"x-v":{"type":"integer","description":"Version of the API end point responded with."},"x-fapi-interaction-id":{"type":"string","description":"Reflects the value of the Interaction ID in the request."}},"schema":{"$ref":"#/definitions/ResponseBankingTransactionList"}},"400":{"description":"Bad Request","headers":{"Content-Type":{"type":"string","description":"Payload format responded with."},"x-v":{"type":"integer","description":"Version of the API end point responded with."},"x-fapi-interaction-Id":{"type":"string","description":"Reflects the value of the Interaction ID in the request."}},"schema":{"$ref":"#/definitions/ErrorResponse400"}},"406":{"description":"Not Acceptable","headers":{"Content-Type":{"type":"string","description":"Payload format responded with."},"x-v":{"type":"integer","description":"Version of the API end point responded with."},"x-fapi-interaction-Id":{"type":"string","description":"Reflects the value of the Interaction ID in the request."}},"schema":{"$ref":"#/definitions/ErrorResponse406"}},"422":{"description":"Unprocessable Entity","headers":{"Content-Type":{"type":"string","description":"Payload format responded with."},"x-v":{"type":"integer","description":"Version of the API end point responded with."},"x-fapi-interaction-Id":{"type":"string","description":"Reflects the value of the Interaction ID in the request."}},"schema":{"$ref":"#/definitions/ErrorResponse422"}},"429":{"description":"Too Many Requests","headers":{"Content-Type":{"type":"string","description":"Payload format responded with."},"Retry-After":{"type":"integer","description":"Amount of time the client should wait before re-trying the operation."},"x-v":{"type":"integer","description":"Version of the API end point responded with."},"x-fapi-interaction-Id":{"type":"string","description":"Reflects the value of the Interaction ID in the request."}},"schema":{"$ref":"#/definitions/ResponseNoBody"}},"500":{"description":"Internal Server Error","headers":{"Content-Type":{"type":"string","description":"Payload format responded with."},"x-v":{"type":"integer","description":"Version of the API end point responded with."},"x-fapi-interaction-Id":{"type":"string","description":"Reflects the value of the Interaction ID in the request."}},"schema":{"$ref":"#/definitions/ErrorResponse500"}}}}},"/accounts/{accountId}/transactions/{transactionId}":{"get":{"summary":"Get Transaction detail","description":"Obtain detailed information on a transaction for a specific account","operationId":"getTransactionDetail","tags":["Transaction API"],"consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"accountId","in":"path","description":"ID of the account.","required":true,"type":"string","x-cds-type":"ASCIIString"},{"name":"transactionId","in":"path","description":"CommBank's unique identifier for this transaction.","required":true,"type":"string","x-cds-type":"ASCIIString"},{"$ref":"#/parameters/ParamAcceptHeader"},{"$ref":"#/parameters/ParamXVHeader"},{"$ref":"#/parameters/ParamXMinVHeader"},{"$ref":"#/parameters/ParamXFapiInterationId"},{"$ref":"#/parameters/ParamXFapiCustomerIpAddress"},{"$ref":"#/parameters/ParamXCdsClientHeaders"}],"x-scopes":["bank:transactions:read"],"x-version":"1","responses":{"200":{"description":"Success","headers":{"Content-Type":{"type":"string","description":"Payload format responded with."},"x-v":{"type":"integer","description":"Version of the API end point responded with."},"x-fapi-interaction-Id":{"type":"string","description":"Reflects the value of the Interaction ID in the request, if provided."}},"schema":{"$ref":"#/definitions/ResponseBankingTransactionById"}},"400":{"description":"Bad Request","headers":{"Content-Type":{"type":"string","description":"Payload format responded with."},"x-v":{"type":"integer","description":"Version of the API end point responded with."},"x-fapi-interaction-Id":{"type":"string","description":"Reflects the value of the Interaction ID in the request, if provided."}},"schema":{"$ref":"#/definitions/ErrorResponse400"}},"406":{"description":"Not Acceptable","headers":{"Content-Type":{"type":"string","description":"Payload format responded with."},"x-v":{"type":"integer","description":"Version of the API end point responded with."},"x-fapi-interaction-Id":{"type":"string","description":"Reflects the value of the Interaction ID in the request, if provided."}},"schema":{"$ref":"#/definitions/ErrorResponse406"}},"429":{"description":"Too Many Requests","headers":{"Content-Type":{"type":"string","description":"Payload format responded with."},"Retry-After":{"type":"integer","description":"Amount of time the client should wait before re-trying the operation."},"x-v":{"type":"integer","description":"Version of the API end point responded with."},"x-fapi-interaction-Id":{"type":"string","description":"Reflects the value of the Interaction ID in the request, if provided."}},"schema":{"$ref":"#/definitions/ResponseNoBody"}},"500":{"description":"Internal Server Error","headers":{"Content-Type":{"type":"string","description":"Payload format responded with."},"x-v":{"type":"integer","description":"Version of the API end point responded with."},"x-fapi-interaction-Id":{"type":"string","description":"Reflects the value of the Interaction ID in the request, if provided."}},"schema":{"$ref":"#/definitions/ErrorResponse500"}}}}}},"parameters":{"ParamPage":{"name":"page","in":"query","description":"Page number being requested","required":false,"type":"integer","default":1},"ParamXFapiInterationId":{"name":"x-fapi-interaction-id","in":"header","description":"Reflects the value of the Interaction ID in the request.","required":false,"example":"f688ae24-9719-4975-9f58-f6b7e655c37d","type":"string"},"ParamXFapiAuthDate":{"name":"x-fapi-auth-date","in":"header","description":"The time when the customer last logged in to the data recipient.","required":false,"example":"2002-10-03T01:00:00+10:00","type":"string"},"ParamXFapiCustomerIpAddress":{"name":"x-fapi-customer-ip-address","in":"header","description":"The customer's original IP address if the customer is currently logged in to the data recipient.","required":false,"example":"192.168.1.1","type":"string"},"ParamXCdsClientHeaders":{"name":"x-cds-client-headers","in":"header","description":"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.","required":false,"example":"Q3VzdG9tZXJzRGV2OkN1c3RvbWVyc0Rldg==","type":"string","x-cds-type":"Base64"},"ParamPageSize":{"name":"page-size","in":"query","description":"Number of records to return with the page","required":false,"type":"integer","default":25,"maximum":1000,"minimum":1},"ParamAcceptHeader":{"name":"Accept","in":"header","description":"Content-Type that is acceptable for the server's response.","type":"string","enum":["application/json"],"required":true},"ParamXVHeader":{"name":"x-v","in":"header","description":"Version of the API end point being requested.","type":"integer","example":1,"required":false},"ParamXMinVHeader":{"name":"x-min-v","in":"header","description":"Minimum version of the API end point you are requesting.","type":"integer","example":1,"required":false},"ParamProductCategory":{"name":"product-category","in":"query","description":"Used to filter results on the productCategory field applicable to accounts. Any one of the valid values for this field can be supplied. If absent then all accounts returned.","required":false,"type":"string","enum":["TRANS_AND_SAVINGS_ACCOUNTS","TERM_DEPOSITS","TRAVEL_CARDS","REGULATED_TRUST_ACCOUNTS","RESIDENTIAL_MORTGAGES","CRED_AND_CHRG_CARDS","PERS_LOANS","MARGIN_LOANS","LEASES","TRADE_FINANCE","OVERDRAFTS","BUSINESS_LOANS"]}},"definitions":{"ResponseBankingTransactionList":{"type":"object","required":["data","links","meta"],"example":{"data":{"transactions":[{"accountId":"2M_8F2Q0aPjdPnO-FYMkt6fOBQNBPobNrXzAjwzrmWQ","transactionId":"28879966775383520753837158396707","isDetailAvailable":false,"type":"PAYMENT","status":"POSTED","description":"Reversal 12/08/19\n,Transfer ATM CBA ATM CBA 999909 Aus","postingDateTime":"2019-08-12T05:02:15.959Z","executionDateTime":"2019-08-12T05:02:15.959Z","amount":"20.00","currency":"AUD","reference":"H101301659134"},{"accountId":"2M_8F2Q0aPjdPnO-FYMkt6fOBQNBPobNrXzAjwzrmWQ","transactionId":"28879966765717429006698102865231","isDetailAvailable":false,"type":"PAYMENT","status":"POSTED","description":"Transfer ATM CBA ATM CBA 999909 Aus","postingDateTime":"2019-08-12T05:02:15.435Z","executionDateTime":"2019-08-12T05:02:15.435Z","amount":"-20.00","currency":"AUD","reference":"H101301659134"},{"accountId":"2M_8F2Q0aPjdPnO-FYMkt6fOBQNBPobNrXzAjwzrmWQ","transactionId":"28879963193855927570890858862075","isDetailAvailable":false,"type":"PAYMENT","status":"POSTED","description":"Reversal 12/08/19\n,Transfer ATM CBA ATM CBA 999909 Aus","postingDateTime":"2019-08-12T04:59:01.804Z","executionDateTime":"2019-08-12T04:59:01.804Z","amount":"20.00","currency":"AUD","reference":"H101301659132"},{"accountId":"2M_8F2Q0aPjdPnO-FYMkt6fOBQNBPobNrXzAjwzrmWQ","transactionId":"28879963184706342171028107200708","isDetailAvailable":false,"type":"PAYMENT","status":"POSTED","description":"Transfer ATM CBA ATM CBA 999909 Aus","postingDateTime":"2019-08-12T04:59:01.308Z","executionDateTime":"2019-08-12T04:59:01.308Z","amount":"-20.00","currency":"AUD","reference":"H101301659132"},{"accountId":"2M_8F2Q0aPjdPnO-FYMkt6fOBQNBPobNrXzAjwzrmWQ","transactionId":"28875361480350259116235038339749","isDetailAvailable":false,"type":"OTHER","status":"POSTED","description":"Cash Deposit\n,CBA ATM Ricketty Streetnsw 999909 Aus","postingDateTime":"2019-08-09T07:41:22.415Z","executionDateTime":"2019-08-09T07:41:22.415Z","amount":"120.00","currency":"AUD","reference":"H101301162644"},{"accountId":"2M_8F2Q0aPjdPnO-FYMkt6fOBQNBPobNrXzAjwzrmWQ","transactionId":"28875359798486814222581211335864","isDetailAvailable":false,"type":"OTHER","status":"POSTED","description":"Withdrawal ATM CBA ATM Ricketty Streetnsw 999909 Aus","postingDateTime":"2019-08-09T07:39:51.241Z","executionDateTime":"2019-08-09T07:39:51.241Z","amount":"-20.00","currency":"AUD","reference":"H101301162640"},{"accountId":"2M_8F2Q0aPjdPnO-FYMkt6fOBQNBPobNrXzAjwzrmWQ","transactionId":"28875349334497451314286720233447","isDetailAvailable":false,"type":"OTHER","status":"POSTED","description":"Withdrawal ATM CBA ATM Ricketty Streetnsw 999912 Aus","postingDateTime":"2019-08-09T07:30:23.987Z","executionDateTime":"2019-08-09T07:30:23.987Z","amount":"-20.00","currency":"AUD","reference":"H101301162620"},{"accountId":"2M_8F2Q0aPjdPnO-FYMkt6fOBQNBPobNrXzAjwzrmWQ","transactionId":"28875160095437426386013171543174","isDetailAvailable":false,"type":"FEE","status":"POSTED","description":"Transfer Fee","postingDateTime":"2019-08-09T04:39:25.317Z","executionDateTime":"2019-08-09T04:39:25.317Z","amount":"-22.00","currency":"AUD","reference":"ZA8AB77799899"},{"accountId":"2M_8F2Q0aPjdPnO-FYMkt6fOBQNBPobNrXzAjwzrmWQ","transactionId":"28875160095437426287226782314699","isDetailAvailable":false,"type":"PAYMENT","status":"POSTED","description":"Imt 89563214522 Sdf\n,Ref C221908641066\n,Inr 21462.54000 Rate:47.4835","postingDateTime":"2019-08-09T04:39:25.317Z","executionDateTime":"2019-08-09T04:39:25.317Z","amount":"-452.00","currency":"AUD","reference":"H201297516487"},{"accountId":"2M_8F2Q0aPjdPnO-FYMkt6fOBQNBPobNrXzAjwzrmWQ","transactionId":"28875137901403312496927567774669","isDetailAvailable":false,"type":"TRANSFER_INCOMING","status":"POSTED","description":"Transfer from Xx1115 NetBank\n,Transfer 9 Aug","postingDateTime":"2019-08-09T04:19:22.176Z","executionDateTime":"2019-08-09T04:19:22.176Z","amount":"1023.00","currency":"AUD","reference":"N080992261235"},{"accountId":"2M_8F2Q0aPjdPnO-FYMkt6fOBQNBPobNrXzAjwzrmWQ","transactionId":"28874980265379021302027835091521","isDetailAvailable":false,"type":"OTHER","status":"POSTED","description":"Withdrawal ATM CBA ATM CBA 999901 Aus","postingDateTime":"2019-08-09T01:56:56.71Z","executionDateTime":"2019-08-09T01:56:56.71Z","amount":"-50.00","currency":"AUD","reference":"H101301162219"},{"accountId":"2M_8F2Q0aPjdPnO-FYMkt6fOBQNBPobNrXzAjwzrmWQ","transactionId":"28874979048096825522495271510250","isDetailAvailable":false,"type":"OTHER","status":"POSTED","description":"Withdrawal ATM CBA ATM CBA 999901 Aus","postingDateTime":"2019-08-09T01:55:50.721Z","executionDateTime":"2019-08-09T01:55:50.721Z","amount":"-50.00","currency":"AUD","reference":"H101301162218"},{"accountId":"2M_8F2Q0aPjdPnO-FYMkt6fOBQNBPobNrXzAjwzrmWQ","transactionId":"28873582173105765443742494311561","isDetailAvailable":false,"type":"PAYMENT","status":"POSTED","description":"EnergyAustralia Elec NetBank BPAY 1313\n,797904710804 BPAY Testing 8 Aug","postingDateTime":"2019-08-08T04:53:45.976Z","executionDateTime":"2019-08-08T04:53:45.976Z","amount":"-222.00","currency":"AUD","reference":"N080892238878","billerCode":"1313","crn":"797904710804"},{"accountId":"2M_8F2Q0aPjdPnO-FYMkt6fOBQNBPobNrXzAjwzrmWQ","transactionId":"28864107792680523534244030021566","isDetailAvailable":false,"type":"TRANSFER_OUTGOING","status":"POSTED","description":"Transfer to Xx1115 NetBank\n,Sense Test","postingDateTime":"2019-08-02T06:13:38.784Z","executionDateTime":"2019-08-02T06:13:38.784Z","amount":"-123.00","currency":"AUD","reference":"N080291454752"},{"accountId":"2M_8F2Q0aPjdPnO-FYMkt6fOBQNBPobNrXzAjwzrmWQ","transactionId":"28861222330744186929465311117487","isDetailAvailable":false,"type":"OTHER","status":"POSTED","description":"Cardless Cash Return\n,Test","postingDateTime":"2019-07-31T10:46:37.579Z","executionDateTime":"2019-07-31T10:46:37.579Z","amount":"40.00","currency":"AUD","reference":"C212908534068"},{"accountId":"2M_8F2Q0aPjdPnO-FYMkt6fOBQNBPobNrXzAjwzrmWQ","transactionId":"28861221992394008924783946135174","isDetailAvailable":false,"type":"OTHER","status":"POSTED","description":"Cardless Cash for Third Party Collection\n,Test","postingDateTime":"2019-07-31T10:46:19.237Z","executionDateTime":"2019-07-31T10:46:19.237Z","amount":"-40.00","currency":"AUD","reference":"C212908534067"},{"accountId":"2M_8F2Q0aPjdPnO-FYMkt6fOBQNBPobNrXzAjwzrmWQ","transactionId":"28861220933993622033956612355517","isDetailAvailable":false,"type":"OTHER","status":"POSTED","description":"Cardless Cash Return\n,Test","postingDateTime":"2019-07-31T10:45:21.861Z","executionDateTime":"2019-07-31T10:45:21.861Z","amount":"40.00","currency":"AUD","reference":"C212908534066"},{"accountId":"2M_8F2Q0aPjdPnO-FYMkt6fOBQNBPobNrXzAjwzrmWQ","transactionId":"28861219900108956720008865947461","isDetailAvailable":false,"type":"OTHER","status":"POSTED","description":"Cardless Cash for Collection\n,Test","postingDateTime":"2019-07-31T10:44:25.814Z","executionDateTime":"2019-07-31T10:44:25.814Z","amount":"-40.00","currency":"AUD","reference":"C212908534065"},{"accountId":"2M_8F2Q0aPjdPnO-FYMkt6fOBQNBPobNrXzAjwzrmWQ","transactionId":"28861202145265358387124795003311","isDetailAvailable":false,"type":"PAYMENT","status":"POSTED","description":"EnergyAustralia Elec CommBank App BPAY 1313\n,797904710804 Test","postingDateTime":"2019-07-31T10:28:23.322Z","executionDateTime":"2019-07-31T10:28:23.322Z","amount":"-0.01","currency":"AUD","reference":"N073190390054","billerCode":"1313","crn":"797904710804"},{"accountId":"2M_8F2Q0aPjdPnO-FYMkt6fOBQNBPobNrXzAjwzrmWQ","transactionId":"28851230353809514384540036706486","isDetailAvailable":true,"type":"PAYMENT","status":"POSTED","description":"Transfer to Jmcuxyz4\n,PayID Phone from CommBank App\n,Bill","postingDateTime":"2019-07-25T04:18:51.424Z","executionDateTime":"2019-07-25T04:18:51.424Z","amount":"-1.00","currency":"AUD","reference":"C206908399077"},{"accountId":"2M_8F2Q0aPjdPnO-FYMkt6fOBQNBPobNrXzAjwzrmWQ","transactionId":"28828689989198384075115861901259","isDetailAvailable":false,"type":"TRANSFER_OUTGOING","status":"POSTED","description":"Transfer to Xx1115 CommBank App","postingDateTime":"2019-07-11T00:53:35.81Z","executionDateTime":"2019-07-11T00:53:35.81Z","amount":"-558.52","currency":"AUD","reference":"N071195017096"}]},"links":{"self":"https://secure.api.commbank.com.au/cds-au/v1/banking/accounts/2M_8F2Q0aPjdPnO-FYMkt6fOBQNBPobNrXzAjwzrmWQ/transactions?oldest-time=2019-01-01&newest-time=2019-10-01&page=1&page-size=25","first":"https://secure.api.commbank.com.au/cds-au/v1/banking/accounts/2M_8F2Q0aPjdPnO-FYMkt6fOBQNBPobNrXzAjwzrmWQ/transactions?oldest-time=2019-01-01&newest-time=2019-10-01&page=1&page-size=25","next":"https://secure.api.commbank.com.au/cds-au/v1/banking/accounts/2M_8F2Q0aPjdPnO-FYMkt6fOBQNBPobNrXzAjwzrmWQ/transactions?oldest-time=2019-01-01&newest-time=2019-10-01&page=2&page-size=25","last":"https://secure.api.commbank.com.au/cds-au/v1/banking/accounts/2M_8F2Q0aPjdPnO-FYMkt6fOBQNBPobNrXzAjwzrmWQ/transactions?oldest-time=2019-01-01&newest-time=2019-10-01&page=6&page-size=25"},"meta":{"totalRecords":21,"totalPages":1}},"properties":{"data":{"$ref":"#/definitions/ResponseBankingTransactionList_data"},"links":{"$ref":"#/definitions/LinksPaginated"},"meta":{"$ref":"#/definitions/MetaPaginated"}}},"BankingTransaction":{"type":"object","required":["accountId","amount","description","isDetailAvailable","reference","status","type"],"properties":{"accountId":{"type":"string","description":"ID of the account.","x-cds-type":"ASCIIString"},"transactionId":{"type":"string","description":"A unique ID of the transaction.","x-cds-type":"ASCIIString"},"isDetailAvailable":{"type":"boolean","description":"True if extended information is available.","x-cds-type":"Boolean"},"type":{"type":"string","description":"The type of the transaction","enum":["FEE","INTEREST_CHARGED","INTEREST_PAID","TRANSFER_OUTGOING","TRANSFER_INCOMING","PAYMENT","DIRECT_DEBIT","OTHER"]},"status":{"type":"string","description":"Status of the transaction whether pending or posted.","enum":["PENDING","POSTED"]},"description":{"type":"string","description":"The transaction description as applied by CommBank."},"postingDateTime":{"type":"string","description":"The time the transaction was posted.","x-cds-type":"DateTimeString"},"valueDateTime":{"type":"string","description":"Date and time at which assets become available to the account owner in case of a credit entry, or cease to be available to the account owner in case of a debit transaction entry.