CCeS Webservice Interface Spec V7.18

Data Automation and Engineering Branch
Digital Business Solutions
Centrelink Confirmation eService

Webservice (CCwS)
Version Number: 7.18

Last Edited: 01 May 2023
Produced by: Digital Business Solutions
Contact Person: CCeS Helpdesk
Contact Phone: FreeCALL™ 1800 887 774
Contact Email: helpdesk.ccs@servicesaustralia.gov.au
CCwS Centrelink Confirmation electronic Service Interface Specification
Document Control
Document Location:
Server Share
Path\File Name R:\NAT\DATAONLINE\ONLINESYS\Digital_Business_Solutions\CONF-Customer

Confirmation Program\24 June 2023
Change History:
Version Version
Number Date Author Details of Change
For earlier Versions please refer to Word Pro spec

1.3 7/09/2011 Andrew Vogt Converted to Word Document and December:
• DVA MRCA confirmation details
1.4 11/10/2011 Leo Lam Updates from Internal review
1.4a 17/11/2011 Leo Lam Updates from External review
1.5 23/03/2015 Ed Craig Updated for Transport NSW Changes
1.6 17/2/2016 Ed Craig Update to enable Housing Authorities to utilise
retrieveIncomeDetailsResult functionality
3.1 13/02/2018 Jannine Leech Add Veteran Payment – Appendix B
3.2 22/02/2018 Jannine Leech Amendments
4.0 28/02/2018 Jannine Leech Final
4.1 07/03/2018 Jannine Leech Changes for LIC customer confirmation for SA
Government
4.2 16/03/2018 Jannine Leech Further LIC changes
POS PROD fix changes
4.3 19/04/2018 Jannine Leech Amendments to POS PROD fix changes
4.4 18/05/2018 Jannine Leech Amendments to POS PROD fix changes
7.1 4/11/2019 Ed Craig Updated tables at Appendix A and Appendix J for
JobSeeker Payment
7.2 05/03/2020 Ed Craig Update Income Type table at Appendix F
7.3 12/06/2020 Ed Craig Updated tables at Appendix C, Appendix D and
Appendix J
7.4 22/06/2020 Ed Craig Updates from Deduction and Confirmation Programmes
Branch
7.5 25/09/2020 Ed Craig Updates from Deduction and Confirmation Programmes
Branch
7.6 25/09/2020 Ed Craig Update System Availability
7.7 27/11/2020 Ed Craig Update Appendix D – Frequency Codes
7.8 03/2/2021 Ed Craig Update table – Verify DVA Details Response Overview
Update tables – Exception Tables
Update Stakeholders
7.9 15/2/2021 Ed Craig Update Sect 4.6.2 – Example SOAP Fault
Version: 7.18
Page 2 of 102
Version Version
Number Date Author Details of Change
7.10 16/2/2021 Ed Craig Update tables at Appendix A, Appendix C and Appendix

J for Tertiary Access Payment
7.11 17/03/2021 Ed Craig Update Sect 4.4.3 to reflect DVA <state> processing
7.12 24/03/2021 Ed Craig Update tables at Appendix C and Appendix J to cater
for flexible PPL scattered payments (SCAT)
for Cost of Living – One Time Payment (CLP)
for Home Equity Access Scheme (HEAS)
7.15 25/07/2022 Ed Craig Updated to merge QLD Transit version
7.16 22/03/2023 Ed Craig Update tables at Appendix F and Appendix G to cater
for Former Home Sale Proceeds
7.17 04/04/2023 Ed Craig Updates for <ftbInd>
Sections 4.3.5 / 4.3.6
7.18 01/05/2023 Ed Craig Update Section 4.3.5 following review with business
Related Documentation:
Document Name Location (TOP6FS1)
CCeS Web Service Interface Spec Word Pro and Pre December 2011 version
v1.2.lwp
Version: 7.18
Page 3 of 102
Table of Contents
1. Introduction ...................................................................................................................................... 6
1.1 Purpose of the document ......................................................................................................... 6
1.2 Definitions, acronyms and abbreviations .................................................................................. 6
1.3 References ............................................................................................................................... 6
2. CCwS Overview ............................................................................................................................... 7
2.1 CCwS Requirements, Objectives and Scope ........................................................................... 7
2.2 System Availability .................................................................................................................... 7
3. CCwS Design ................................................................................................................................... 8
3.1 Design Overview....................................................................................................................... 8
3.1.1 Successful Execution ........................................................................................................ 8
3.1.2 Failed Execution ................................................................................................................ 8
3.2 Overall Security Solution .......................................................................................................... 9
3.2.1 High Level Overview ......................................................................................................... 9
3.2.2 Key Elements .................................................................................................................... 9
3.2.3 Obtaining Security ............................................................................................................. 9
3.3 Communication Protocol ........................................................................................................ 10
4. CCwS Operations Descriptions ..................................................................................................... 12
4.1 Special XML Characters ......................................................................................................... 12
4.2 Verify Name Address .............................................................................................................. 13
4.2.1 Purpose ........................................................................................................................... 13
4.2.2 Invocation ........................................................................................................................ 13
4.2.3 Verify Name Address Request Structure ........................................................................ 14
4.2.4 Example Format .............................................................................................................. 16
4.2.5 Verify Name Address Response Structure ..................................................................... 17
4.2.6 Example Format .............................................................................................................. 18
4.3 Retrieve Benefit Status Subset ............................................................................................... 19
4.3.1 Purpose ........................................................................................................................... 19
4.3.2 Invocation ........................................................................................................................ 19
4.3.3 Retrieve Benefit Status Subset Request Structure ......................................................... 19
4.3.4 Example Format .............................................................................................................. 21
4.3.5 Retrieve Benefit Status Response Structure ................................................................... 22
4.3.6 Example Format .............................................................................................................. 27
4.4 Verify DVA Details .................................................................................................................. 29
4.4.1 Purpose ........................................................................................................................... 29
4.4.2 Invocation ........................................................................................................................ 29
4.4.3 Verify DVA Details Request Structure ............................................................................. 30
4.4.4 Example Format .............................................................................................................. 32
4.4.5 Verify DVA Details Response Overview ......................................................................... 33
Version: 7.18
Page 4 of 102
4.4.6 Example Format .............................................................................................................. 40

4.5 Retrieve Income Details ......................................................................................................... 42
4.5.1 Purpose ........................................................................................................................... 42
4.5.2 Invocation ........................................................................................................................ 42
4.5.3 Retrieve Income Details Request Structure .................................................................... 43
4.5.4 Example Format .............................................................................................................. 46
4.5.5 Retrieve Income Details Response Overview ................................................................. 47
4.5.6 Example Format .............................................................................................................. 61
4.6 Standard Fault Operation ....................................................................................................... 67
4.6.1 SOAP fault Structure ....................................................................................................... 67
4.6.2 Example SOAP Fault ...................................................................................................... 67
5. CCwS Exception Specifications ..................................................................................................... 69
5.1 Exception Tables .................................................................................................................... 69
5.1.1 Verify Name Address Operation...................................................................................... 69
5.1.2 Verify DVA Details Operation .......................................................................................... 70
5.1.3 Retrieve Benefit Status Subset ....................................................................................... 71
5.1.4 Retrieve Income Details .................................................................................................. 72
5.2 Schema Exceptions ................................................................................................................ 74
5.2.1 Schema Exception Structure ........................................................................................... 74
5.2.2 Example Format .............................................................................................................. 75
5.2.3 Schema Exception Table ................................................................................................ 76
6. CCwS Response Values Mapping Table....................................................................................... 77
7. CCwS External Agency Match Code values table ......................................................................... 78
8. Appendix A - Centrelink Payment Descriptions ............................................................................. 79
9. Appendix B - Entitlement Descriptions - DVA ................................................................................ 81
10. Appendix C – Payment Components ......................................................................................... 82
11. Appendix D – Frequency Code Descriptions ............................................................................... 91
12. Appendix E – Deduction Type Code Descriptions ..................................................................... 92
13. Appendix F – Income Type Codes ............................................................................................. 93
14. Appendix G – Asset Type Codes ............................................................................................... 94
15. Appendix H – Foreign Income Component Codes ...................................................................... 95
16. Appendix I – Currency Codes ...................................................................................................... 96
17. Appendix J – Payment Group and Applicable Components ...................................................... 101
Version: 7.18
Page 5 of 102
1. Introduction
1.1 Purpose of the document

The purpose of this document is to provide Business Partners with detailed technical specifications to
allow them to build their system to interface with Centrelink Confirmation Web Service (CCwS).
The document is intended for Business Partner Interface developers and contains only the
information required for Business Partners to interface with CCwS.
1.2 Definitions, acronyms and abbreviations

Abbreviations/ Definition
Acronyms
ACF Access Control Facility
Business A user of the system outlined in this document

Partner
CCwS Centrelink Confirmation Web Service
CRN Centrelink Reference Number
DVA Department of Veterans’ Affairs
DSD Defence Signals Directorate
HTTPS Hyper Text Transport Protocol, Secure
SOAP Simple Object Access Protocol
SSL Secure Sockets Layer
WSDL Web Service Definition Language
1.3 References
The following references have been used:
• Various Internet resources on SOAP.
• Institute of Electrical & Electronics Engineers standard 1016-1987,
• Architectural Design Description (ADD).
Version: 7.18
Page 6 of 102
2. CCwS Overview
Centrelink Confirmation Web Service is a system to system application that is part of Centrelink
Confirmation eServices. A confirmation request submitted by the Business Partner will interface
directly with Centrelink's CCwS application without the need for a user interface. The request is
processed in 'real time' and the response will be delivered back to the sending system.
2.1 CCwS Requirements, Objectives and Scope

The system provides the ability to verify that a Centrelink CRN matches the credentials supplied.
Such credentials include name, address and date of birth. SOAP Response operations return results
for characteristics based on an Organisation’s profile.
The system provides the ability to verify the concession entitlement status for a supplied Centrelink
CRN. SOAP Response operations return results for characteristics based on an Organisation’s
profile.
The system also provides a facility to verify non-Centrelink customer’s entitlement and details, based
on supplied credentials and relevant reference numbers. Initially, DVA customer’s entitlement and
address details can be verified via the CCwS system provided a correct DVA reference number and
matching name details are provided.
The system also providers a facility to retrieve Centrelink Customers benefits, payments, income and
assets details. SOAP Response operations return results for characteristics based on an
Organisation’s profile.
The Business Partners system must interact with the CCwS system directly.
Before negotiating your Characteristic Profile with Centrelink, please be aware that personal
information shall not be collected by a Concession Provider (CP) for inclusion in a record, or in a
generally available publication unless the information is collected for a purpose that is a lawful
purpose directly related to a function or activity of the CP. For further information please refer to the
Centrelink CCwS contract Schedule 4, page 34, clause 6.1.
2.2 System Availability

As a guide the system is available and supported by the Centrelink Confirmation Services Helpdesk
between 0830 and 1700 AEST, all other times the system is available but unsupported.
It is not monitored on national public holidays or outside of the above times. Subject to system
availability, you can access the services outside of these times. If you experience problems when the
service is not monitored, please try again during the above times.
Note: Centrelink regularly conducts software, hardware and infrastructure releases weeknights and
on weekends. During these times the system will be unavailable. Variations to planned service hours
will be advised in advance on the ‘Business service changes’ section of the website or by contacting
the Centrelink Confirmation Services Helpdesk. Unplanned outages outside of business hours can
also occur from time to time.
Version: 7.18
Page 7 of 102
3. CCwS Design
3.1 Design Overview
3.1.1 Successful Execution
Operations will be passed between Business Partners systems and the CCwS using SOAP over
HTTPS. A SOAP request operation will be sent from the Business Partner to CCwS and a SOAP
response operation will be received by the Business Partner from CCwS.
Figure 1 Design Overview of CCwS Web Service
SOAP Request via HTTPS
SOAP Response via HTTPS
Internet
Business Partner
CCwS
System
3.1.2 Failed Execution
Operations will be passed between CCwS and Business Partners system using SOAP over HTTPS. A
SOAP standard fault operation will be sent to Business Partner if any exceptions occur.
Figure 2 Design Overview of CCwS Web Service
SOAP REQUEST via HTTPS
SOAP Standard Fault

Operation via HTTPS
Internet
Business Partner CCwS

System
Version: 7.18
Page 8 of 102
3.2 Overall Security Solution
3.2.1 High Level Overview
H T T PS C onnection
Centrelink
DSA
C onsum ers
In tern et
Centrelink
Gateway
WEB Service
E xternal F ramewo rk
O rganisation ST
Lightwe ight Se c urity

Web service Secu rity
co n t ro ls are b u ilt in t o
SOA P H ead er
Figure 3 CCwS Web Services Security Architecture Overview
The above diagram provides an overview of the use of a lightweight security token in the context of
the CCwS Web Services Architecture:
3.2.2 Key Elements
The key elements of this security solution are:

• Stateless messaging security operation is used to authenticate CCwS Users;
• Stateless messaging is implemented using the WS-Security standard using SAML;
• Transport-level (HTTPS) with minimum 128 bit encryption security is used to provide
confidentiality and integrity of the operations passing between Centrelink and
consumers;
• The Transport-level security will be appropriate to support the transmission of in-
confidence data. An appropriate level of encryption that meets with DSD standards will
be applied;
• There is no reverse gateway to the client.
The key attributes of a Lightweight Security Token are:

• Shared symmetric key. The security token uses a signature mechanism based on a
shared secret key;
• Low Security Processing Overheads. The signature mechanism is an Operation
Authentication Code (MAC), essentially a keyed hash that is computationally cheap to
create and verify.
3.2.3 Obtaining Security
This Web Service uses the WS-Security standard to implement message-level authentication of
users. It uses a username token and a password digest that includes a nonce and timestamp
(Timestamp must use GMT time not local time).
Version: 7.18
Page 9 of 102
Third Party Organisations will be required to contact Centrelink Confirmation Services Helpdesk on
1800 887 774 or email heldesk.ccs@servicesaustralia.gov.au to obtain the required User ID and
Security Key.
<soapenv:Header>
<wsse:Security soapenv:mustUnderstand="1">
<wsse:UsernameToken wsu:Id="UsernameToken-22347273">
<wsse:Username>CCWS-ABC121</wsse:Username>
<wsse:Password Type="http://docs.oasis-
open.org/wss/2004/01/oasis-200401-wss-username-token-profile-
1.0#PasswordDigest">AXsYUKPBQzPqJq/QkW+QSsNZ+HE</wsse:Pas
sword>
<wsse:Nonce>VFRUMjAwODA1MjMwNjA3Mzg3OTY</wsse:Nonce>
<wsu:Created>2008-05-23T06:07:38.796Z</wsu:Created>
</wsse:UsernameToken>
</wsse:Security>
</soapenv:Header>
The soap request message for the Web Service has to come with a WS-Security header with the
above format in the soap header.
Here is the example code in JSP that creates a soap header with WS-Security header:
String ISO_8601_UTC_PATTERN = "yyyy-MM-dd'T'HH:mm:ss'Z'";
String errorMsg = null;
String vResponseMsg = null;
String vHeaderMessage = null;
String vBodyMessage = null;
String nonceString = request.getParameter("nonceField");
String username = request.getParameter("userIdField");
String key = request.getParameter("keyField");
java.text.SimpleDateFormat dateFormat = new java.text.SimpleDateFormat();
java.util.Date aDate = new java.util.Date();
dateFormat.applyPattern(ISO_8601_UTC_PATTERN);
String timestamp = dateFormat.format(aDate);
byte[] nonce = nonceString.getBytes();
UsernameToken test = new UsernameToken(username,key.getBytes());
vHeaderMessage = "<soapenv:Header>" + test.getWSToken(nonce,timestamp,
true, true) + "</soapenv:Header>";
3.3 Communication Protocol

Communication between a Business Partners interfacing system and the CCwS will be via HTTPS
(HTTP version 1.1 over SSL version 3.0). The client application must support SSL version 3.0 and at
least one of:
0Triple-DES 168bit with SHA
1Triple-DES 168bit with MD5
Version: 7.18
Page 10 of 102
2RC4 128bit with SHA

3RC4 128bit with MD5.
See the DSD SSL Policy located at http://www.dsd.gov.au/library/infosec/ssl.html for more details.
Operations are to be sent using an action of POST.
The URL for Web Service end Point is:

https://si.centrelink.gov.au/ConfirmationServices/services/customerConfirmationPort
Request SOAP Action Standard. The request will be formatted as follows:

POST /PointOfSale HTTP/1.1
Host: 127.0.0.1:8080
Content-Type: text/xml; charset="utf-8"
Content-Length: nnnn
SOAPAction: "https://olb.centrelink.gov.au/apps/ccs/pos"
<soapenv:Envelope……………………..>
<soapenv:Body>
………….body of request operation (see Operation Descriptions)
</soapenv:Body>
</soapenv:Envelope>
Response Standard. The response will be formatted as follows:

HTTP/1.1 200 OK
Content-Type: text/xml; charset="utf-8"
Content-Length: nnnn
SOAPAction: "https://olb.centrelink.gov.au/apps/ccs/pos"
<soapenv:Envelope……………………..>
<soapenv:Body>
………….body of request operation (see Operation Descriptions)
</soapenv:Body>
</soapenv:Envelope>
Version: 7.18
Page 11 of 102
4. CCwS Operations Descriptions

Centrelink Confirmation Web Service caters for the following SOAP operations received from a
Business Partner’s interfacing system:
• Verify Customer's Name and Address operation (see Section 4.2) - Centrelink
customers;
• Retrieve Benefit Status (see Section 4.3) - Centrelink customers;
• Verify DVA Details (see Section 4.4) - non-Centrelink customers;
• Retrieve Income Details (see Section 4.5) - Centrelink customers.
Each of the operations listed above will be described as a component. The following pages contain
details examples of the operations - fields, behaviours that are represented are contained in the
WSDL. If there is a case of obscurity then WSDL file is considered the master file with the valid values
for each field.
SOAP messages will comply with name space and format standards as specified in the WSDL file
that will accompany this document. Any Name space can be used as long as it is valid SOAP.
4.1 Special XML Characters

Certain characters passed as simple text will cause the XML to fail validation. There are 4 characters
(and if they exist in a data item) that must be encoded using either CDATA tags or entity replace
characters. The following table outlines the entity replacement characters in question:
Character Entity Replacement Characters

& &
< <
> >
‘ '
Additionally: the XML file should not contain any binary or other special non-printing character values.
XML fields (or node values) should not include tab, line feed or carriage return control characters etc.
These characters can exist within the XML document itself for readability of the XML document, or
ease of generation purposes (providing the document remains valid XML).
Version: 7.18
Page 12 of 102
4.2 Verify Name Address
4.2.1 Purpose
The purpose of the verifyNameAddress operation is to confirm a Centrelink customer's personal and
contact details (eg: name, address, date of birth).
4.2.2 Invocation
Verify Name Address Operation

Business Partner CCwS
System Web service
Verify Name Address Request

1
inputRefId= 123, crn=123456789A,
surname=Downer, firstName =Bobbie,
middleName=John, , dob=19980101, addrLn1=Unit
1, addrLn2=This St, suburb=Cairns, state=QLD,
pcode=4870, cnfrmDate=2007-10-16
Verify Name Address Response

2
inputRefId= 123,Crn=123456789A,
cnfrmDate =2007-10-16, name=Y or (firstName=Y,
middleName=Y, surname=Y), dob=Y, addr=Y
OR
Fault
3
faultcode, faultstring
Figure 4 Verify Name Address Operation Overview
Version: 7.18
Page 13 of 102
4.2.3 Verify Name Address Request Structure
The optional elements depend on whether the Business Partner is authorised to match on those
particular characteristics. If the Business Partner includes these in the verifyNameAddress operation
but does not have them in their work unit (characteristic) profile, the values within these fields will be
ignored.
Mandatory
Tag Name Description Valid Values
/Optional
<inputRefId> Business partner's reference Up to 50 alphanumeric Optional

number for the request. characters. Apostrophes ('),
hyphens (-) and blank characters
are also allowed but not in
consecutive order and not
allowed as the first character.
Foreign characters are not
allowed.
<crn> A valid CRN issued to a customer 9 consecutive numeric Mandatory

by Centrelink. characters followed by an alpha
character.
<surname> If enquiring on a customer’s Up to 30 alphanumeric Optional

name. characters. Apostrophes ('),
If enquiring
For customers known by a single on
name, i.e., 'Madonna', the name customer’s
should be populated in the name,
<surname> element. <surname>
is
allowed.
mandatory.
<firstName> If enquiring on a customer’s Up to 30 alphanumeric Optional

If enquiring
For customers known by a single on
name, i.e., 'Madonna', the name customer’s
should be populated in the name, if
<surname> element. middle
name is
allowed.
entered
then first
name is
mandatory.
<middleName> If enquiring on a customer’s Up to 30 alphanumeric Optional

For customers known by a single
name, i.e., 'Madonna', the name
should be populated in the
<surname> element.
allowed.
<dob> Element containing a customer's 8 numeric characters in the Optional

date of birth. format CCYY-MM-DD. Dates
cannot be in the future.
Version: 7.18
Page 14 of 102
Mandatory
/Optional
<addrLn1> Represents the first line of a Up to 50 alphanumeric Optional

customer’s address. characters. Apostrophes('),
Mandatory
forward slashes(/), hyphens(-)
Note: enquiries on overseas if enquiring
and commas(,) are also
addresses cannot be conducted. on a
accepted.
customer’s
address.
<addrLn2> Represents the second line of a Up to 50 alphanumeric Optional

Note: enquiries on overseas
addresses cannot be conducted.
accepted.
<suburb> Contains a valid Australian Up to 50 alphanumeric Optional

suburb or town. characters. Apostrophes('),
Mandatory
accepted.
customer’s
address.
<state> Contains a valid Australian state. ACT, NSW, NT, QLD, SA, TAS, Optional
VIC or WA
Note: enquiries on overseas Mandatory
addresses cannot be conducted. if enquiring
on a
For TPO’s with State
customer’s
characteristic – can be input
address.
without other address fields
<pcode> Contains a valid Australian 4 numeric characters. Optional

postcode.
Mandatory
customer’s
address.
<cnfrmDate> Confirm a customer’s details as at 10 alphanumeric characters in Optional

a particular point in time within the the format CCYY-MM-DD. Dates
last 2 years. cannot be more than 2 years in
the past and cannot be in the
Note: if a Business Partner has
future.
this characteristic selected as part
of their characteristic profile and
no date is entered, the date used
for enquiry will be the current
date. If the Business Partner
does not have this characteristic
selected as part of their
characteristic profile, the date
used for enquiry will also be the
current date. The confirmation
date will not be applied to a
customers name or date of birth.
Version: 7.18
Page 15 of 102
4.2.4 Example Format
verifyNameAddress format, refer to 1 in diagram in 4.2.2.
SOAP request format:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-
instance" xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-
1.0.xsd" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-
1.0.xsd">
<soapenv:Header>
<wsse:Username> CCWS-ABC121</wsse:Username>
1.0#PasswordDigest">AXsYUKPBQzPqJq/QkW+QSsNZ+HE</wsse:Pas
sword>
<wsse:Nonce>VFRUMjAwODA1MjMwNjA3Mzg3OTY</wsse:Nonce>
</wsse:Security>
</soapenv:Header>
<soapenv:Body>
<p194:verifyNameAddress
xmlns:p194="http://www.centrelink.gov.au/xml/schema/ccs/verifynameaddress/v1
">
<p194:verifyNameAddressDto>
<p194:inputRefId>2345678901</p194:inputRefId>
<p194:crn>123456789A</p194:crn>
<p194:surname>CITIZEN</p194:surname>
<p194:firstName>JANE</p194:firstName>
<p194:middleName>ANN</p194:middleName>
<p194:dob>1973-08-08</p194:dob>
<p194:addrLn1>1 AVENUE ST</p194:addrLn1>
<p194:suburb>SUBURBVILLE</p194:suburb>
<p194:state>QLD</p194:state>
<p194:pcode>4000</p194:pcode>
<p194:cnfrmDate>2008-07-01</p194:cnfrmDate>
</p194:verifyNameAddressDto>
</p194:verifyNameAddress>
</soapenv:Body>
</soapenv:Envelope>
Version: 7.18
Page 16 of 102
4.2.5 Verify Name Address Response Structure
The optional elements which will be returned are based on an organisation's work unit (characteristic)
profile. For a description of the codes in valid return values, see Section 6 CCwS POS Response
Values Mapping Table.
Mandator
y/Optional

allowed.
<crn> A valid CRN issued to a customer 9 consecutive numeric characters Mandatory

by Centrelink. followed by an alpha character.
<cnfrmDate> Confirm a customer’s details as at 10 alphanumeric characters in the Optional

a particular point in time within the format CCYY-MM-DD. Dates
future.
<name> If enquiring on a customer’s Y,N,NP Optional

name.
<firstName> If enquiring on a customer’s Y, N, NP Optional

name.
<middleName> If enquiring on a customer’s Y, N, NP Optional

name.
<surname> If enquiring on a customer’s Y, N, NP Optional

name.
<dob> Element containing a customer's Y, N, NP Optional

date of birth.
Version: 7.18
Page 17 of 102
Mandator
y/Optional
<addr> Indicates whether the <addrLn1>, Y, N, NP or UC Optional

<addrLn2>, <suburb>, <state>
and <pcode> elements submitted
within the verifyNameAddress
operation matches the clients
address details in the Centrelink
database. This result will only be
returned if it is selected as part of
the Business Partners
characteristic profile.
<stateMtch> Indicates if there has been a Y,N,NP or UC Optional

match on <state>
verifyNameAddress format, refer to 2 in diagram in 4.4.3.
SOAP response format:
instance">
<soapenv:Header/>
<soapenv:Body>
<p548:verifyNameAddressResult
xmlns:p548="http://www.centrelink.gov.au/xml/schema/ccs/verifynameaddressres
ult/v1">
<p548:verifyNameAddressResultDto>
<p548:crn>123456789A</p548:crn>
<p548:firstName>Y</p548:firstName>
<p548:middleName>Y</p548:middleName>
<p548:surname>Y</p548:surname>
<p548:dob>Y</p548:dob>
<p548:addr>Y</p548:addr>
<p548:stateMtch>Y</p548:stateMtch>
</p548:verifyNameAddressResultDto>
</p548:verifyNameAddressResult>
</soapenv:Body>
</soapenv:Envelope>
Version: 7.18
Page 18 of 102
4.3 Retrieve Benefit Status Subset
4.3.1 Purpose
The purpose of the RetrieveBenefitStatusSubset operation is to retrieve information about the

Centrelink customer's benefits (eg. Aged care, payment start/end dates, payment status, number of
children).
4.3.2 Invocation
Retrieve Benefit Status Subset Operation

Business CCwS
Partner System Web Service
1
Retrieve Benefit Status Request
inputRefId=123,crn=123456789A, pcode=4000'
cnfrmDate=20150901,scndryCrn=123456789A
2
Retrieve Benefit Status Response
inputRefId=123,crn=123456789A,
cnfrmDate=20150901,pcc=Y, hcc=N, shc=N,
deceased=N, blind=N, over70=N, war=N, pcode=Y,
numChild=3, scndryCrn=CHI, lookingForWork=Y
paymentDetails (pymtType=PPS, pymtStatus=CUR,
pymtStartDate=2001-01-02, pymtEndDate=NA,
datePaidTo=20150910, maxrate=Y,
rateRatio=Y,rateThold=Y)
OR
Fault
Faultcode, faultstring
3
Figure 5 Retrieve Benefit Status Operation Overview
4.3.3 Retrieve Benefit Status Subset Request Structure
particular characteristics. If the Business Partner includes these in the retrieveBenfitStatusSubset
operation but does not have them in their work unit (characteristic) profile, the values within these
fields will be ignored.
Version: 7.18
Page 19 of 102
Mandator
y/Optional

number for the request characters. Apostrophes ('),
allowed
<crn> A valid CRN issued to a 9 consecutive numeric characters Mandatory

Customer by Centrelink followed by an alpha character.
<pcode> Valid Australian postcode. 4 numeric characters. Optional
<cnfrmDate> Confirm a customers details as at 10 alphanumeric characters in the Optional

Note If a Business Partner has
future.
customer’s name or date of birth.
<scndryCrn> Contains a valid CRN issued to a 9 consecutive numeric characters Optional

Customer by Centrelink (child or followed by an alpha character.
partner CRN). When the <crn>
provided in this status request
XML block is a card holder and
this element is populated, the
result indicates if it is linked as a
record on that card.
Version: 7.18
Page 20 of 102
retrieveBenfitStatusSubset format, refer to 1 in diagram in 4.3.2:
1.0.xsd">
<soapenv:Header>
1.0#PasswordDigest">TmvdNwxowqGpL0j8S5RaX8/9zf4</wsse:Passwo
rd>
<wsse:Nonce>VFRUMjAwODA1MjMwNTUyMzA5Mzc</wsse:Nonce
>
</wsse:Security>
</soapenv:Header>
<soapenv:Body>
<p755684194:retrieveBenefitStatusSubset
xmlns:p755684194="http://www.centrelink.gov.au/xml/schema/ccs/retrievebenefit
statussubset/v1">
<p755684194:retrieveBenefitStatusSubsetDto>
<p755684194:crn>123456789A</p755684194:crn>
<p755684194:pcode>4000</p755684194:pcode>
<p755684194:scndryCrn>111222333A</p755684194:scndryCrn>
</p755684194:retrieveBenefitStatusSubsetDto>
</p755684194:retrieveBenefitStatusSubset>
</soapenv:Body>
</soapenv:Envelope>
Version: 7.18
Page 21 of 102
4.3.5 Retrieve Benefit Status Response Structure
profile. For a description of the codes in valid values, see Section 6 CCwS Response Values
Mapping Table.
Mandator
y/Optional

allowed.
<crn> A valid CRN issued to a 9 consecutive numeric characters Mandatory

customer by Centrelink. followed by an alpha character.
<cnfrmDate> Confirm a customer’s details as 10 numeric characters in the Optional

at a particular point in time format CCYY-MM-DD. Dates
within the last 2 years. cannot be more than 2 years in
If a Business Partner has this
future.
characteristic selected as part of
their characteristic profile and no
date is entered, the date
returned will be the current date.
If the Business Partner does not
have this characteristic selected
as part of their characteristic
profile, the date returned will
also be the current date. Except
in the circumstances outlined
above, this value will match the
value submitted in the
<cnfrmDate>.
<pcc> Indicates whether the customer Y, N or UC Optional

has a current Pensioner
Concession Card (PCC). This
result will only be returned if it is
selected as part of the Business
Partners characteristic profile.
<hcc> Indicates whether the customer Y, N or UC Optional

has a current Health Care Card
(HCC). This result will only be
returned if it is selected as part
of the Business Partners
<shc> Indicates whether the customer Y, N or UC Optional

has a current Commonwealth
Seniors Health Card (SHC). This
Version: 7.18
Page 22 of 102
Mandator
y/Optional
<lic> Indicates whether the customer Y, N or UC Optional

has a current Low Income Card
(LIC). This result will only be
<cardDetails> This element indicates the N/A Optional

beginning of the card details
section. This includes the card
type, the card entitlement start
date (for SHC or LIC cards) and
the card entitlement end date
(for LIC card only). When
returned, this element may
contain <cardType>,
<entStartDate> and/or
<entEndDate>
The result detail for each card
will only be returned if the Card
Details Data (CDD)
characteristic is selected as part
characteristic profile. If the CDD
characteristic is not selected on
characteristic profile then the
<cardDetails> section will not
display
<cardType> Indicates the card type that the SHC, LIC Optional
Business Partner has
permission to confirm. Results
may include:
Commonwealth Seniors Health
Card (SHC)
Low Income Card (LIC)
<entStartDate> Returns the date that the 8 alphanumeric characters in the Optional
Customer was first issued with a format CCYYMMDD or UC
card for the entitlement in
question
This result will display for SHC
and LIC card types
<entEndDate> Returns the date that the card 8 alphanumeric characters in the Optional
expires for the entitlement in format CCYYMMDD or UC
question
This result will display for LIC
card type only
Version: 7.18
Page 23 of 102
Mandator
y/Optional
<deceased> Indicates whether the customer Y or N Optional

is deceased. This result will only
be returned if it is selected as
part of the Business Partners
<blind> Indicates whether the customer Y or N Optional

is blind. This result will only be
<over70> Indicates whether the customer Y or N Optional

is over 70. This result will only
<war> Indicates whether the customer Y or N Optional

is a war widow. This result will
only be returned if it is selected
as part of the Business Partners
<inst> Indicates whether the customer Y or N Optional

is in an institution. This result will
only be returned if it is selected
as part of the Business Partners
<pcode> Indicates whether the <pcode> Y, N, UC or NP Optional

provided in the
RetrieveBenefitStatusSubset
operation matches the
customer’s postcode in the
Centrelink database. This result
will only be returned if it is
<numChild> Indicates the number of Family 1 to 2 numeric characters. Optional

Tax Benefit (FTB) eligible
dependant children the
customer has in their care. This
Version: 7.18
Page 24 of 102
Mandator
y/Optional
<scndryCrn> When the <crn> provided in the CHI, PTR, NCR or NP Optional
operation is a card holder, this
result indicates whether the
<scndryCrn> provided in the
operation is linked as a record
on that card. This result will only
<lookingforWork> Indicates if the customer is Y,N or UC Optional

“looking for work” Customer is
on Youth Allowance Other
payment category
<ythAllowOth> Indicates if the customer is Y,N or UC Optional

“Youth Allowance Other”
Customer is on Youth Allowance
Other payment category
<ythAllowOthStatu Indicates if the customer is CUR, CAN or SUS Optional

s> “Youth Allowance Other”
Customer is on Youth Allowance
Other payment category
<ftbInd> Indicates if the customer was Y or N or UC Optional

eligible for FTB Part A and/or
FTB Part B for one or more
day/s in the current financial year
and/or immediate previous
financial year at the time of the
check.
<paymentDetails> This element indicates the start Optional

of the payment details section.
This includes the payment type
and details for the customer.
When returned, this element
may contain a <pymType>,
<pymtStatus>,
<pymtStartDate>,
<pymtEndDate>,<datePaidTo> ,
<rateRatio>, and / or
<rateThold>.
Version: 7.18
Page 25 of 102
Mandator
y/Optional
<pymtType> Indicates the type of payment Valid payment code or NAP. Optional
listed on a customer’s record. If
the customer is on a payment
which is part of the Business
Partners characteristic profile,
the payment code will be
returned (see Appendix A -
Centrelink Payment
Descriptions). If the customer is
not on a payment, or on a
payment which is not part of the
Business Partners characteristic
profile, NAP will be returned.
<pymtStatus> If a payment code is returned in CUR, CAN, SUS or NA Optional

<pymtType>, this result
indicates the status of this
payment. If NAP is returned in
<pymtType>, this field will be
populated with NA. This result
<pymtStartDate> If a payment code is returned in 8 alphanumeric characters in the Optional

<pymtType>, this result format CCYYMMDD, UC or NA.
indicates the start date of this
payment. If NAP is returned in
<pymtType>, the field will be
populated with NA. If the
customer does not have a
payment file, UC will be
returned. This result will only be
<pymtEndDate> If a payment code is returned in 8 alphanumeric characters in the Optional

<pymtType> and this payment is format CCYYMMDD, UC or NA.
cancelled (CAN), this result
indicates the end date of this
payment. Otherwise, the field
will be populated with NA. This
Version: 7.18
Page 26 of 102
Mandator
y/Optional
<datePaidTo> If a payment code is returned in 8 alphanumeric characters in the Optional

<pymtType>, this result format CCYYMMDD, UC or NA.
indicates the date in which the
customer has been paid to for
the applicable payment. If NAP
is returned in <pymtType>, the
field will be populated with NA.
If the customer does not have a
payment file, UC will be
<maxRate> Indicates if a customer is Y, N or NA Optional

receiving the maximum rate of
Pension payment. This result
<rateRatio> Indicates if a customer is Y, N or NA Optional

receiving more than 80% of the
Pension maximum rate. This
<rateThold> Indicates if a customer is Y, N or NA Optional

receiving more than $100 of a
Pension payment. This result
retrieveBenfitStatusSubsetResult format, refer to 2 in diagram in 4.3.2.
<?xml version="1.0" encoding="UTF-8"?>

instance">
<soapenv:Header/>
<soapenv:Body>
<p269:retrieveBenefitStatusSubsetResult
xmlns:p269="http://www.centrelink.gov.au/xml/schema/ccs/retrievebenefitstatuss
ubsetresult/v1">
<p269:retrieveBenefitStatusSubsetResultDto>
<p269:crn>123456789A</p269:crn>
Version: 7.18
Page 27 of 102
<p269:pcc>N</p269:pcc>
<p269:hcc>N</p269:hcc>
<p269:shc>Y</p269:shc>
<p269:lic>Y</p269:lic>
<p269:cardDetails>
<p269:cardType>SHC</p269:cardType>
<p269:entStartDate>20161230</p269:entStartDate>
</p269:cardDetails>
<p269:cardDetails>
<p269:cardType>LIC</p269:cardType>
<p269:entStartDate>20150701</p269:entStartDate>
<p269:entEndDate>20181201</p269:entEndDate>
</p269:cardDetails>
<p269:deceased>N</p269:deceased>
<p269:blind>N</p269:blind>
<p269:over70>N</p269:over70>
<p269:war>N</p269:war>
<p269:inst>N</p269:inst>
<p269:pcode>Y</p269:pcode>
<p269:numChild>3</p269:numChild>
<p269:scndryCrn>CHI</p269:scndryCrn>
<p269:lookingForWork>Y</p269:lookingForWork>
<p269: ythAllowOth >Y</p269: ythAllowOth >
<p269: ythAllowOthStatus>CUR</p269: ythAllowOthStatus>
<p269:ftbInd>Y</p269: ftbInd>
<p269:paymentDetails>
<p269:pymtType>PPS</p269:pymtType>
<p269:pymtStatus>CUR</p269:pymtStatus>
<p269:pymtStartDate>20060602</p269:pymtStartDate>
<p269:pymtEndDate>NA</p269:pymtEndDate>
<p269:datePaidTo>20080630</p269:datePaidTo>
<p269:maxRate>Y</p269:maxRate>
<p269:rateRatio>Y</p269:rateRatio>
<p269:rateThold>Y</p269:rateThold>
</p269:paymentDetails>
</p269:retrieveBenefitStatusSubsetResultDto>
</p269:retrieveBenefitStatusSubsetResult>
</soapenv:Body>
<soapenv:Envelope>
Version: 7.18
Page 28 of 102
4.4 Verify DVA Details
4.4.1 Purpose
The purpose of the verifyDvaDetails operation is to enquire on the customer's details as obtained
from the Department of Veteran Affairs (eg. Disability, address, max rate, rate ratio, payment type,
payment start date and status).
4.4.2 Invocation
Verify DVA Details Operation

Business CCwS
Verify Dva Details Request
1 inputRefId=123, custId=QX123A,
orgType=DVA,cnfrmDate=20030901,
pcodeMtch=4820,firstName=bobbie,
surname=Downer, dob=19480715, addrLn1=Unit 1,
addrLn2=10 strasse St, suburb=Inala, state=QLD,
pcode=4870
Verify Dva Details Response

2
custId=QX123A, orgType=DVA, mtchCode=9,
cnfrmDate=20030901, pcc=Y, shc=Y, gch=N,
firstName=Y, middlename=Y, surname=Y, dob=N,
addr=Y, pcodeMtch=N, pymtType=SER,
pymtStatus=CAN, pymtStartDate=19990101,
maxRate=Y, rateRatio=Y, deceased=N,
cnfrmId=1234567890, wwp=Y, pow=N, disability=N,
sda=N
OR
3 Fault
faultcode, faultstring,
Figure 6 Verify DVA Details Operation Overview
Version: 7.18
Page 29 of 102
4.4.3 Verify DVA Details Request Structure
particular characteristics. If the Business Partner includes these in the verifyDvaDetails operation but
does not have them in their work unit (characteristic) profile, the values within these fields will be
ignored.
Tag Name Description Valid Values Mandatory/

Optional

allowed.
<custId> A valid Reference Number issued Up to 23 alpha-numeric Mandatory

to a customer by DVA. characters as stipulated by DVA.
<orgType> A code for the external 3 consecutive alpha characters. Mandatory

Department where the customer’s
'DVA' is currently the only code
entitlement resides.
available for this service.

future.
Note: Point in Time processing is
available for all DVA data, except
for name and date of birth
characteristics.
<pcodeMtch> Containing a valid Australian 4 numeric characters. Optional

postcode. This postcode is
provided as a separate and
discrete match to the <pcode>
match provided in the address
match. This match does not
require any other address details,
and will return a separate
response element in the response
file.
Version: 7.18
Page 30 of 102

Optional
<surname> Customer’s surname. Up to 30 alphanumeric Mandatory

characters. Apostrophes ('),
DVA customers with only one
name (eg. 'Madonna') cannot be
matched by this system. Contact
DVA for matching on these
allowed as the first or last
customers.
characters. Foreign characters
are not allowed.
<firstName> Customer’s first name. Up to 30 alphanumeric Mandatory

DVA customers with only one
name (eg. 'Madonna') cannot be
matched with this service.
Contact DVA for matching on
allowed as the first or last
these cases.
characters. Foreign characters
are not allowed.
<middleName> Customer’s middle name. Not used - any details entered in Optional
this field will be ignored.
<dob> Customer's date of birth. 10 alphanumeric characters in the Optional

format CCYY-MM-DD. Dates

Mandatory
and commas(,) are also accepted.
customer’s
address.

customers address. characters. Apostrophes('),
<suburb> Contains a valid Australian Up to 50 alpha characters. Optional

suburb or town. Fullstops(.), apostrophes('),
Mandatory
Numeric characters are not
customer’s
accepted.
address.
Version: 7.18
Page 31 of 102

Optional
<state> Contains a valid Australian state ACT, NSW, NT, QLD, SA, TAS, Optional
code. VIC or WA are the only
Mandatory
acceptable values.
customer’s
For TPO’s with OI1 or OI3 or BLS
address.
or BLP or WLS characteristics -
Can be input without other
address fields
Else
All address fields must be entered
<addrLn1> or <addrLn2> and
<suburb> and
<state> and
<postcode>
<pcode> Valid Australian postcode. 4 numeric characters. Optional

on a
customer’s
address.
verifyDvaDetails format, refer to 1 in diagram in 4.4.2.
1.0.xsd">
<soapenv:Header>
1.0#PasswordDigest">+Dho9cI7V5L9WtgNW637Uj8SSYk</wsse:Passw
ord>
<wsse:Nonce>VFRUMjAwODA1MjMwNjA0NDgzNDM</wsse:Nonce
>
</wsse:Security>
</soapenv:Header>
Version: 7.18
Page 32 of 102
<soapenv:Body>
<p194:verifyDvaDetails
xmlns:p194="http://www.centrelink.gov.au/xml/schema/ccs/verifydvadetails/v1">
<p194:verifyDvaDetailsDto>
<p194:custId>1234567</p194:custId>
<p194:orgType>DVA</p194:orgType>
<p194:pcodeMtch>2315</p194:pcodeMtch>
<p194:firstName>JOHN</p194:firstName>
<p194:dob>1944-12-01</p194:dob>
<p194:addrLn1>29 MAIN ST</p194:addrLn1>
<p194:suburb>SUBURB BAY</p194:suburb>
<p194:state>NSW</p194:state>
<p194:pcode>2000</p194:pcode>
</p194:verifyDvaDetailsDto>
</p194:verifyDvaDetails>
</soapenv:Body>
</soapenv:Envelope>
4.4.5 Verify DVA Details Response Overview
profile For a description of the codes in valid values, see Section 6 CCwS Response Values Mapping
Table.
Mandatory/
Optional

allowed
<custId> Containing a valid Reference Up to 23 alpha-numeric Mandatory

Number issued to a Customer by characters as stipulated by
their external Department (relative External Dept.
to the <orgType> value).
<orgType> Containing a code for the external 3 consecutive alpha characters. Mandatory
Department where the customer
'DVA' is currently the only code
enquiry originates. (changed as
available for this service, however
customer may not have any
it is anticipated that other
entitlement).
Department’s databases will be
available via this query.
Version: 7.18
Page 33 of 102
Mandatory/
Optional

last 2 years. Note: if a Business cannot be more than 2 years in
Partner has this characteristic the past and cannot be in the
selected as part of their future.
characteristic profile and no date
is entered, the date used for
enquiry will be the current date. If
the Business Partner does not
have this characteristic selected
as part of their characteristic
profile, the date used for enquiry
will also be the current date. The
confirmation date will not be
applied to a customer’s name or
date of birth.
Note: Point in Time processing is
available for all DVA data, except
for name and date of birth
characteristics.
<mtchCode> Element containing a number 1-2 numeric characters (values Mandatory

which represents the level of from 9 to 15). For the description
matching success. of values returned, see Section 7
CCwS External Agency Match
Note: this is for DVA only.
Code values table.
<pcc> Indicates whether the customer Y or N Optional

has a current Pensioner
Concession Card (PCC) from the
external department. This result
<shc> Indicates whether the customer Y or N Optional

has a current Seniors Health Card
(SHC). This result will only be
<gch> Indicates whether the customer Y or N Optional

has a current Gold Card (GCH)
from DVA. This result will only be
Version: 7.18
Page 34 of 102
Mandatory/
Optional
<firstName> Indicates whether the Y, N, UC or NP Mandatory

<firstName> element submitted
within the corresponding external
Dept request matches the
customers first name/s in the
relevant External Department’s
database. This result will only be
Note: this is a required field for
DVA, and as such will always be
returned.
<middleName> Indicates whether the Y, N, NN or NP Optional

<middleName> element
NOTE:
submitted within the
Middle
corresponding external Dept
name
request matches the customers
matches
middle name/s in the relevant
are not
External Department’s database.
available for
This result will only be returned if
DVA data
it is selected as part of the
profile.
Note: middle name matches are
not available for DVA data.
<surname> Indicates whether the <surname> Y, N, UC or NP Mandatory

element submitted within the
surname in the relevant External
Department’s database. This
Note: this is a required field for
DVA, and as such will always be
returned.
<dob> Indicates whether the <dob> Y, N, NP or UC Optional

element submitted within the
date of birth in the relevant
external department’s database.
profile.
Note: some DVA records have no
date of birth. A result of UC will
be returned for these cases.
Version: 7.18
Page 35 of 102
Mandatory/
Optional
<addr> Indicates whether the <addrLn1>, Y, N, NP or UC If any part of the Optional

<addrLn2>, <suburb>, <state> address details fail, will this return
and <pcode> elements submitted UC or N? Need to address this
within the corresponding external issue.
Dept request matched the clients
address details in the external
department’s database. This
<pcodeMtch> Indicates whether the Y, N, UC or NP Optional

<pcodeMtch> provided in the
postcode in the relevant external
Department’s database. This
<stateMtch> Indicates if there has been a Y,N,NP or UC Optional

match on <state>
<pymtType> Indicates the type of payment in Valid payment code or NAP Optional
which you have access to enquire
on, as indicated in the Business
Partners characteristic profile. If
the customer is on a payment in
which you have access to enquire
on, the payment code will be
returned (see Appendix B -
'Entitlement Descriptions - DVA').
If the customer is not on a
payment, or on a payment in
which you don't have access to
enquire on NAP will be returned.
<pymtStatus> If a payment code is returned in CUR, NCUR or NA Optional

<pymtType>, this result indicates
the status of this payment. If NAP
is returned in <pymtType>, this
field will be populated with NA.
profile.
Version: 7.18
Page 36 of 102
Mandatory/
Optional
<pymtStartDate> If a payment code is returned in 8 alphanumeric characters in the Optional

<pymtType>, this result indicates format CCYYMMDD, UC or NA
the start date of this payment. If
NAP is returned in <pymtType>,
the field will be populated with
NA. If the customer does not
have a payment file, UC will be
<maxRate> Indicates if a customer is Y, N or NA Optional

receiving equal to or more than
100% of the maximum rate of
AGE, SER or ISS (See Appendix
B - 'Entitlement Descriptions -
DVA'). This result will only be
<rateRatio> Indicates if a customer is Y, N or NA Optional

receiving more than 80% of the
maximum rate of AGE, SER or
ISS (See Appendix B -
'Entitlement Descriptions - DVA').
profile.
<deceased> Indicates whether the customer is Y, N Optional

deceased. This result will only be
<cnfrmId> Confirms the complete customer Up to 23 alpha-numeric Optional

ID of the customer whose details characters as stipulated by
have been returned from the External Dept.
request. This result will only be
returned for successful DVA
queries, and will be used for any
enquiries against the match
results. confirmId can be different
to the custId, as it is the actual ID
that Centrelink has recorded for
the customer in the Centrelink
System.
Note: this is for DVA only.
Version: 7.18
Page 37 of 102
Mandatory/
Optional
<wwp> Indicates whether the customer is Y or N Optional

in receipt of a War Widow(er)s
Pension from DVA. This result will
only be returned if it is selected as
<pow> Indicates whether the customer is Y or N Optional

recorded as being a Prisoner of
War by DVA. This result will only
be returned if it is selected as part
<disability> Indicates whether the DVA Y or N Optional

customer’s level of incapacity is
assessed as greater than or equal
to the level specified in the
profile. This result will only be
characteristic profile, and will
indicate 'Y' for any positive
assessment of level of disability
which is equal to or greater than
the level coded against the
Business Partners profile for this
characteristic.
<sda> Indicates whether the customer CUR or NCUR Optional

has been assessed with a
Specific Disability Assessment by
DVA. This result will only be
characteristic profile, and will
indicate 'Y' for any positive
assessment of SDA (regardless
of level of disability).
<eyp> Indicates whether the customer Y or N Optional

has a current MRCA Dependent
Eligible Young Person (EYP) from
<mwc> Indicates whether the customer Y or N Optional

has a current MRCA White Card
(MRCA) (MWC) from DVA. This
Version: 7.18
Page 38 of 102
Mandatory/
Optional
<oip> Indicates whether the DVA Y or N Optional

customer’s Overall Impairment
Points is assessed as greater
than or equal to the level
specified in the Business Partners
characteristic profile. This result
Partners characteristic profile,
and will indicate 'Y' for any
positive assessment of level of
disability which is equal to or
greater than the level coded
against the Business Partners
profile for this characteristic.
<srd> Indicates whether the customer Y or N Optional

has a current MRCA Special Rate
Disability Pension (SRD) from
<wdp> Indicates whether the customer Y or N Optional

has a current MRCA Wholly
Dependent Partner (WDP) from
<oip10> Indicates whether the customer Y,N or UC Optional

has Overall Impairment Points EQ
to or GT 10. This result will only
<oip30> Indicates whether the customer Y,N or UC Optional

has Overall Impairment Points EQ
to or GT 30. This result will only
<warlike> Indicates whether the customer is Y,N or UC Optional

receiving warlike/non-warlike
service for MRCA. This result will
Version: 7.18
Page 39 of 102
Mandatory/
Optional
<bliIsp> Indicates if the customer is blind Y,N or UC Optional

and in receipt of an Income
Support Payment. This result will
<bliDsp> Indicates if the customer is blind Y,N or UC Optional

and in receipt of a Disability
Support Pension. . This result will
verifyDvaDetailsResult format, refer to 2 in diagram in 4.4.2:

instance">
<soapenv:Header/>
<soapenv:Body>
<p726:verifyDvaDetailsResult
xmlns:p726="http://www.centrelink.gov.au/xml/schema/ccs/verifydvadetailsresult/
v1">
<p726:verifyDvaDetailsResultDto>
<p726:custId>1526978</p726:custId>
<p726:orgType>DVA</p726:orgType>
<p726:mtchCode>9</p726:mtchCode>
<p726:pcc>N</p726:pcc>
<p726:shc>N</p726:shc>
<p726:gch>N</p726:gch>
<p726:firstName>Y</p726:firstName>
<p726:surname>Y</p726:surname>
<p726:dob>Y</p726:dob>
<p726:addr>Y</p726:addr>
<p726:pcodeMtch>Y</p726:pcodeMtch>
<p726:stateMtch>Y</p726:stateMtch>
<p726:pymtType>NAP</p726:pymtType>
<p726:pymtStatus>NA</p726:pymtStatus>
<p726:pymtStartDate>NA</p726:pymtStartDate>
<p726:maxRate>NA</p726:maxRate>
<p726:rateRatio>NA</p726:rateRatio>
<p726:deceased>N</p726:deceased>
<p726:cnfrmId>1526978</p726:cnfrmId>
Version: 7.18
Page 40 of 102
<p726:wwp>N</p726:wwp>
<p726:pow>N</p726:pow>
<p726:disability>N</p726:disability>
<p726:sda>NCUR</p726:sda>
<p726:eyp>Y</p726:eyp>
<p726:mwc>N</p726:mwc>
<p726:oip>Y</p726:oip>
<p726:srd>Y</p726:srd>
<p726:wdp>Y</p726:wdp>
<p726:oip10>Y</p726:oip10>
<p726:oip30>Y</p726:oip30>
<p726:warLike>Y</p726:warLike>
<p726:bliIsp>Y</p726:bliIsp>
p726:bliDsp>Y</p726:bliDsp>
</p726:verifyDvaDetailsResultDto>
</p726:verifyDvaDetailsResult>
</soapenv:Body>
</soapenv:Envelope>
Version: 7.18
Page 41 of 102
4.5 Retrieve Income Details
4.5.1 Purpose
The purpose of the retreiveIncomeDetails operation is to retrieve information about a Centrelink

customer's benefits (eg. Aged care, payment start/end dates, payment status, number of children),
Assets (Real Estate/Business), income and payments.
4.5.2 Invocation
Retrieve Income Details Operation

Business CCwS
Retrieve Income Details Request
1
inputRefId=123,crn=123456789A, surname = Smith,
firstName = John, dob = 1980-01-01, orgRefNumber =
ATO1122, addrLn1 = test st, suburb = Calwell, state =
ACT, pcode=4000, cnfrmDate=20150901
Retrieve Income Details Response
inputRefId=123,crn=123456789A,orgRefId = 1234,
cnfrmDate=2016-09-01, surname = Smith, firstName =
Jane, dob = 1947-07-26, partnerIndicator = Y,
paidAtSingleRateIndicator = Y,
youthIndependentRateIndicator = Y,
remoteIncomeSupportIndicator = Y
maximumRateDetails (maximumRateTypeCode = AGE,
maximumrateIndicator = N ),
numberOfChildrenAssessed = 1,
percentageOfCareForChildren = 100,
streetSuburbMatchIndicator = Y,
postcodeMatchIndicator = Y,
previousRegularPaymentDetails (paymenttypeCode =
FTB, amount = 250.00, lastPaymentDate = 2016-02-16
grantDate = 2016-03-16,
legislatedMaximumEntitlement = 600.00,
previousIrregularPaymentDetails (paymentTypeCode
= AGE, amount = 65.00, lastpaymentDate = 2016-02-
18, frequencyCode = 2WE)
2 deductionFromPaymentDetails (paymentTypeCode
=PPS, deductionTypeCode = PQN, amount = 37.10,
lastPaymentDate = 2016-03-11,) deductionDetails
(organisationName = Test Org, deductionTypeCode =
RDS, amount = 100.00, lastPaymentDate = 2016-02-16
targetAmount = 1500.25, outstandingBalance =
1200.25, deductionEndDate = 2016-09-09,
yearToDateAmount = 1300.25)
incomeManagementDeductionDetails
(organisationName =Basics Card , deductionTypeCode
= PQN, amount = 100.00, lastPaymentDate = 2016-02-
16, targetAmount = 1500.25, outstandingBalance =
1200.25, deductionEndDate = 2016-09-09,
yearToDateAmount = 200.25)
futureRegularPaymentDetails ( paymentTypeCode =
FTBA, amount = 212.35, dateToBePaid = 2016-04-01,
grantDate = 2015-01-01,
legislatedMaximumEntitlement = 285.25 )
futureIrregularPaymentDetails ( paymentTypeCode =
RA, amount = 500.33, dateToBePaid = 2016-05-01,
frequencyCode = MTH ) nonCentrelinkIncome Details
(incomeTypeCode = REB, amount=8125.33,
frequencyCode = ANN, dateOfEffect = 2016-04-25 )
foreignIncomeFinancialDetails (incomeTypeCode =
FOR, componentCode = SOC, amount = 18000.20
currencyType = BRL ) assetDetails (assetTypeCode =
HPE, assetValueAmount = 5000, dateOfEffect = 2016-
10-10 ) assetFinancialDetails ( assetTypeCode = MIV
amount = 32000, currencyType = USD, dateOfEffect =
2016-04-03, institutionName = American
Independent, AccountType = Investment, unitCount =
1000, unitValue = 32, percentageOwned = 50 )
OR
3 Fault
Faultcode, faultstring
Figure 7 Retrieve Income Details Operation Overview
Version: 7.18
Page 42 of 102
4.5.3 Retrieve Income Details Request Structure
particular characteristics. If the Business Partner includes these in the retrieveIncomeDetails
operation but does not have them in their work unit (characteristic) profile, the values within these
fields will be ignored.
Mandatory/
Optional
<inputRefId> Business Partner's reference Up to 50 alphanumeric Optional

allowed.
<crn> A valid CRN issued to a customer 9 consecutive numeric characters Mandatory

by Centrelink. followed by an alpha character.
<surname> If enquiring on a customer’s Up to 30 alphanumeric Mandatory

allowed
<surname> is mandatory.
<firstName> and <middleName>
are optional. If middle name is
entered then first name is
mandatory. For customer's known
by a single name, eg 'Madonna',
the name should be populated in
the <surname> element.
<firstName> If enquiring on a customer’s Up to 30 alphanumeric Optional

allowed.
<surname> is mandatory.
<firstName> and <middleName>
are optional. If middle name is
entered then first name is
mandatory. For customer's known
by a single name, eg 'Madonna',
the name should be populated in
the <surname> element.
<dob> Element containing a customer's 10 alphanumeric characters in the Mandatory

date of birth. format CCYY-MM-DD. Dates
Version: 7.18
Page 43 of 102
Mandatory/
Optional
<orgRefNumber> Element contains the Business Up to 12 alphanumeric Optional

Partner’s reference number for a characters. Apostrophes('),
Centrelink customer with DVA forward slashes(/), hyphens(-)
income. and commas(,) are also accepted
.

Mandatory
if enquiring
on a
Note: enquiries on overseas customer’s
addresses cannot be conducted. address.

addresses cannot be conducted .
<suburb> Contains a valid Australian Up to 50 alphanumeric Optional

suburb or town. characters. Apostrophes('),
Mandatory
if enquiring
on a
Note: enquiries on overseas customer’s
addresses cannot be conducted. address.
<state> Contains a valid Australian state ACT, NSW, NT, QLD, SA, TAS, Optional
code. VIC or WA
Mandatory
customer’s
address.
<pcode> Contains a valid Australian 4 numeric characters Optional

postcode.
on a
customer’s
address.
Version: 7.18
Page 44 of 102
Mandatory/
Optional

future.
customer’s name or date of birth.
Version: 7.18
Page 45 of 102
retrieveIncomeDetails format, refer to 1 in diagram in 4.5.2:
1.0.xsd">
<soapenv:Header>
<wsse:Username>in01-002</wsse:Username>
1.0#PasswordDigest">ASr7Kflt4+MO7bDpYzi8VD1sUkE</wsse:Passwor
d>
<wsse:Nonce>VFRUMjAwODA1MjMwNjExMjQ1MzE</wsse:Nonce>
</wsse:Security>
</soapenv:Header>
<soapenv:Body>
<p755684194:retrieveIncomeDetails
xmlns:p755684194="http://www.centrelink.gov.au/xml/schema/ccs/retrieveincome
details/v1">
<p755684194:retrieveIncomeDetailsDto>
<p755684194:crn>111222333A</p755684194:crn>
<p755684194:firstName>MICHELLE</p755684194:firstName>
<p755684194:dob>1965-01-10</p755684194:dob>
<p755684194:orgRefNumber>9876543210</p755684194:orgRefNu
mber>
<p755684194:addrLn1>37 MAIN ST</p755684194:addrLn1>
<p755684194:suburb>MOUNT SUBURB</p755684194:suburb>
<p755684194:state>QLD</p755684194:state>
<p755684194:pcode>4000</p755684194:pcode>
</p755684194:retrieveIncomeDetailsDto>
</p755684194:retrieveIncomeDetails>
</soapenv:Body>
</soapenv:Envelope>
Version: 7.18
Page 46 of 102
4.5.5 Retrieve Income Details Response Overview
profile. For a description of the codes in valid values, see Section 6 CCwS Response Values
Mapping Table.
Mandatory
/Optional

hyphens (-) and blank
characters are also allowed
but not in consecutive order
and not allowed as the first
character. Foreign characters
are not allowed.
<crn> A valid CRN issued to a 9 consecutive numeric Mandatory

customer by Centrelink. characters followed by an
alpha character.
<orgRefNumber> Business Partner’s reference Up to 12 alphanumeric Optional

number for a Centrelink characters. Apostrophes ('),
customer with DVA income. forward slashes(/), hyphens(-
) and commas(,) are also
accepted .
<cnfrmDate> Confirm a customer’s details Date Optional

as at a particular point in
10 alphanumeric characters
time within the last 2 years.
in the format CCYY-MM-DD.
Note: If a Business Partner
Dates cannot be more than 2
has this characteristic
years in the past and cannot
be in the future.
characteristic profile and no
date is entered, the date
used for enquiry will be the
current date. If the Business
Partner does not have this
characteristic selected as
part of their characteristic
profile, the date used for
enquiry will also be the
current date. The
confirmation date will not be
applied to a customer’s
name or date of birth.
Note: Point in Time
processing is available for all
DVA data, except for name
and date of birth
characteristics.
Version: 7.18
Page 47 of 102
Mandatory
/Optional
<surname> Customer’s surname. Up to 30 alphanumeric Mandatory

character. Foreign characters
are not allowed.
<firstName> If enquiring on a client’s Up to 30 alphanumeric Optional

character. Foreign
characters are not allowed.
<dob> Customer's date of birth. Date Mandatory

10 alphanumeric characters
in the format CCYY-MM-DD.
Dates cannot be in the future.
<partnerIndicator> This field displays whether Y or N Optional

the customer is partnered as
at the confirmation date.
If the Business Partner does
not have this characteristic in
their profile, this field will not
be returned.
<paidAtSingleRateIndicato This field confirms if a Y or N Optional

r> partnered customer is paid
at the single rate.
be returned.
<youthIndependentRateIn This field returns whether the Y or N Optional

dicator> customer receives the Youth
Independent Rate
be returned.
Version: 7.18
Page 48 of 102
Mandatory
/Optional
<remoteIncomeSupportInd This field returns whether the Y or N Optional

icator> customer has been identified
3 char
as a Remote Income
Support Recipient as a result
of living in a remote income
support region.
be returned.
It should be noted that the
amount of payment and
delivery date are subject to
changes as determined by
the CDP provider.
<maximumRateDetails> Delineates the maximum Occurs 0….. M Optional

rate details block.
<maximumRateTypeCode This field returns a Max length 5 Optional

> description of the maximum
Alpha numeric chars
rate type code as at the
confirmation date. See Appendix A – Centrelink
Payment Descriptions
<maximumRateIndicator> This field returns whether the Y or N Optional

customer was on Maximum
rate Family Tax Benefit as at
the confirmation date.
<numberOfChildrenAsses This field returns the number Integer Optional

sed> of children in the care of the
2 numeric characters
customer for whom Family
Assistance payments are 0...(thru to 99)
received as at the
confirmation date.
Version: 7.18
Page 49 of 102
Mandatory
/Optional
<percentageOfCareforChil This field returns the Decimal Optional

dren> percentage of care for
Len 5
dependent children as at the
confirmation date. nnn.nn
The field is to be repeated
(with n incrementing at each
repeat) for each dependent
child.
Sort order for the children is
from first born to youngest
be returned.
If the Business partner has
this characteristic in their
profile but the customer has
no children then this field will
not be returned.
<streetSuburbMatchIndica This field returns the match Y or N Optional

tor> result for the customer’s
residential street / suburb as
at the confirmation date
be returned.
<stateMatchIndicator> This field returns the match Y or N Optional

result for the customer’s
residential state as at the
confirmation date
be returned.
<postcodeMatchIndicator> This field returns the match Y or N Optional

result for the customer’s
residential postcode as at
be returned.
Version: 7.18
Page 50 of 102
Mandatory
/Optional
<previousRegularPayment Delineates the previous Occurs 0…M Optional

Details> regular payments details
block
The block returns details
about the customer’s most
recent regular payments at
the component level as at
the delivery date (first
payday prior to confirmation
date).
their profile, this block will
not be returned.
If the Business Partner has
no information for that
characteristic then the block
will not be returned.
<benefitTypeCode> This field returns the type of Max length 3 Optional

benefit that the payment is
Alpha numeric chars
being made for.
See Appendix A – Centrelink
<paymentTypeCode> This field returns the Max length 5 Optional

description of each of the
Alpha numeric chars
most recent regular
payments as at the delivery See Appendix C – Payment
date. Components
It should be noted that for
FTB payments, in some
cases, the payments
reported will be different to
the amount actually
received.
<amount> This field returns the amount Decimal len 10 Optional

of each most recent regular
99999999.99
payment as at the delivery
date
<lastPaymentDate> This field returns the delivery Date Optional

date for the most recent
CCYY-MM-DD
regular payment.
<grantDate> This field returns the Grant Date Optional

Date for the most recent
CCYY-MM-DD
regular payments as at the
delivery date.
Version: 7.18
Page 51 of 102
Mandatory
/Optional
<legislatedMaximumEntitle This field returns the Decimal len 10 Optional

ments> maximum entitlement for the
99999999.99
payment type.
<previousIrregularPaymen Delineates the previous Occurs 0…M Optional

tDetails> irregular payment details
block.
This block returns details
about the customer’s most
recent irregular payments at
the component level as at
the delivery date.
not be returned.

Alpha numeric chars
being made for.

description of each of the
Alpha numeric chars
most recent irregular
payments as at the delivery See Appendix C – Payment
date. Components

of the irregular payment.
99999999.99
<lastPaymentDate> This field returns the delivery Date Optional

date for the most recent
CCYY-MM-DD
irregular payment
<frequencyCode> This field returns the 3 alpha numeric chars Optional

frequency for the most
See Appendix D – Frequency
recent irregular payment
Codes Descriptions.
represented.
Version: 7.18
Page 52 of 102
Mandatory
/Optional
<deductionFromPaymentD Delineates the deduction Occurs 0…..M Optional

etails> from payment details block.
about deductions from the
customer’s most recent
regular payments at the
component level as at the
delivery date.
not be returned.
will not be returned
<paymentTypeCode> This field returns the 3 alpha chars Optional

description of each payment
for which there was a
deduction as at the delivery
date. See Appendix C – Payment
Components
<deductionTypeCode> This field returns the type of 3 alpha chars Optional

deduction from each
See Appendix E Deduction
payment as at the delivery
Codes.
date.

of the deduction.
99999999.99
<lastPaymentDate> This field returns the date of Date Optional

last payment each deduction
CCYY-MM-DD
was taken out as at the
delivery date.
<deductionDetails> Delineates the deduction Occurs 0…….M Optional

details block
This block returns details of
deductions from a
customer’s payment paid to
an organisation.
not be returned.
Version: 7.18
Page 53 of 102
Mandatory
/Optional
<organisationName> This field returns the name Length 60 Optional

of the organisation receiving
Alpha, numeric and special
the payment.
character combinations

deduction paid.
Codes.

of the deduction paid.
99999999.99
<lastPaymentDate> This field returns the date Date Optional

the deduction was paid
CCYY-MM-DD
<targetAmount> This field returns the Decimal len 10 Optional

customer’s nominated target
99999999.99
amount with each payment
deduction contributing
towards reaching that target.
<outstandingBalance> This field returns the residual Decimal len 10 Optional

target amount remaining
99999999.99
after all contributing
deduction amounts have
been taken into account.
<deductionEndDate> This field returns the final Date Optional

payment date for the
CCYY-MM-DD
deduction arrangement.
<yearToDateAmount> This field returns the year to Decimal len 10 Optional

date total paid to the
99999999.99
organisation for each
deduction type.
<incomeManagementDed Delineates the Income Occurs 0….M Optional

uctionDetails> Management Deduction
Details block.
This block returns details of
a customer’s Income
Management Deductions
which are paid to an
organisation or paid to a
Basics Card.
not be returned.
<organisationName> This field returns the name Length 60 Optional

of the organisation receiving
the payment.
Version: 7.18
Page 54 of 102
Mandatory
/Optional

deduction paid.
Codes.

of the deduction paid.
99999999.99
<lastPaymentDate> This field returns the date Date Optional

the deduction was paid
CCYY-MM-DD
<targetAmount> This field returns the Decimal len 10 Optional

customer’s nominated target
99999999.99
amount with each payment
deduction contributing
towards reaching that target.
<outstandingBalance> This field returns the residual Decimal len 10 Optional

target amount remaining
99999999.99
after all contributing
deduction amounts have
been taken into account.
<deductionEndDate> This field returns the final Date Optional

payment date for the
CCYY-MM-DD
deduction arrangement.
<yearToDateAmount> This field returns the year to Decimal len 10 Optional

date total paid to the
99999999.99
organisation for each
deduction type.
Version: 7.18
Page 55 of 102
Mandatory
/Optional
<futureRegularPaymentDe Delineates the Future Occurs 0…M Optional

tails> Regular Payments Details
block
about the customer’s next
regular payments at the
component level. If the
Business Partner does not
have this characteristic in
not be returned.
is not returned.
It should be noted that the See Appendix D – Frequency
payment maybe for a period Code Descriptions’
less than 14 days.
It should be noted that the
data returned is provisional
and is therefore subject to
change
This block does not return
historical Income
Statements.

Alpha numeric chars
being made for.

description of each next
Alpha numeric chars
regular payment.
See Appendix C – Payment
This field returns the
Components
regular payment as at the
projected delivery date.
It should be noted that for
FTB payments. In some
cases, the payments
reported will be different to
the amount actually
received.

of the future regular payment
99999999.99
Version: 7.18
Page 56 of 102
Mandatory
/Optional
<dateToBePaid> This field returns the date Date Optional

each next regular payment is
CCYY-MM-DD
due to be sent.
<grantDate> This field returns the Grant Date Optional

Date for the next regular
CCYY-MM-DD
payment.
<legislatedMaximumEntitle This field returns the Decimal len 10 Optional

ments> maximum entitlement for the
99999999.99
payment type.
<futureIrregularPaymentD Delineates the Future Occurs 0…M Optional

etails> Irregular Payments Details
block.
about the customer’s next
irregular payments at the
component level.
not be returned.
This block does not return
Historical Income
Statements.

Alpha numeric chars
being made for.

Alpha numeric chars
irregular payment.
See Appendix C – Payment
Components
<amount> This field returns the amount 99999999.99 Optional

of the future irregular
payment
<dateToBePaid> This field returns the date CCYY-MM-DD Optional

each next irregular payment
is due to be sent.
Version: 7.18
Page 57 of 102
Mandatory
/Optional
<frequencyCode> This field returns the Len 3 alpha numeric Optional

frequency that each future
irregular payment represents
Codes Descriptions.
<nonCentrelinkIncomeDet Delineates the nonCentrelink Occurs 0….M Optional

ails> Income Details block
This table returns details
about the customer’s income
from non-Centrelink sources
as at the confirmation date.
For types of income returned
refer to Appendix E
not be displayed.
The data returned in the
Foreign Income Financial
Details block is accrued and
returned in this block.
<incomeTypeCode> This field returns the 3 alpha chars Optional

description of each income
See Appendix F – Income
type as at the confirmation
Type Codes.
date.

of each income type as at
99999999.99
<frequencyCode> This field returns the Len 3 alpha numeric Optional

frequency of payment
associated with the amount
Codes Descriptions.
and income type
<dateOfEffect> This field returns the date Date Optional

the income was last updated
CCYY-MM-DD
by Centrelink prior to the
confirmation date.
Version: 7.18
Page 58 of 102
Mandatory
/Optional
<foreignIncomeFinancialD Delineates the Foreign Occurs 0…..M Optional

etails> Income Financial Details
block.
This table displays an
accumulation of earned and
unearned income from
overseas sources.
not be returned.
<incomeTypeCode> This field returns the 3 alpha chars Optional

description of each foreign
See Appendix F – Income
income type as at the
Type Codes.
confirmation date
<componentCode> This field returns the 3 alpha chars Optional

description of the component
See Appendix H – Foreign
associated with the foreign
Income Component Codes
income type.

of each foreign income type
99999999.99
<currencyType> This field returns the 3 alpha chars

currency code for the
See Appendix I – Currency
associated foreign income
Codes
amount
<assetDetails> Delineates the Asset Details Occurs 0…M Optional

block.
about the customer’s assets
not be returned.
will not be returned
<assetTypeCode> This field returns the 3 alpha chars Optional

description of each asset
See Appendix F – Asset Type
Codes.
date.
Version: 7.18
Page 59 of 102
Mandatory
/Optional
<assetValueAmount> This field returns the net Decimal len 10 Optional

market value of each asset
99999999.99
date.
<dateOfEffect> This field returns the date Date Optional

the value of each asset was
CCYY-MM-DD
last updated by Centrelink
prior to the confirmation
date.
<assetFinancialDetails> Delineates the Asset Occurs 0…..M Optional

Financial Details block.
This block returns an
individual breakdown of the
following assets –
Deposit Accounts and Direct
Investments
Managed Investments
Securities and Investments
Superannuation and
Annuities
not be returned.
<assetTypeCode> This field returns the type of 3 alpha chars Optional

asset held at the
See Appendix G – Asset
confirmation date
Type Codes

of the asset in the relevant
99999999.99
currency
<currencyType> This field returns the 3 alpha chars Optional

currency in which the asset
See Appendix I – Currency
is held.
Codes
<dateOfEffect> This field returns the last Date Optional

date of assessment by
CCYY-MM-DD
Services Australia -
Centrelink
<institutionName> This field returns the name Length 60 Optional

of the institution where the
asset is held.
<accountType> This field returns the type of Length 60 Optional

account in which the asset is
held.
Version: 7.18
Page 60 of 102
Mandatory
/Optional
<unitCount> This field returns the number Integer Optional

of units held for a unit based
Length 9
investment
nnnnnnnnn
<unitValue> This field returns the $ value Decimal len 10 Optional

per unit
99999999.99
<percentageOwned> This field returns the Integer len 3 Optional

percentage ownership for
nnn
the customer
retrieveIncomeDetailsResults format, refer to 2 in diagram in 4.5.2.
<?xml version="1.0"?>
<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Header/>
<soapenv:Body>
<p15:retrieveIncomeDetailsResult
xmlns:p15="http://www.centrelink.gov.au/xml/schema/ccs/retrieveincomedetailsresult/v1">
<p15:retrieveIncomeDetailsResultDto>
<p15:crn>111222333A</p15:crn>
<p15:orgRefNumber>9876543210</p15:orgRefNumber>
<p15:firstName>MICHELLE</p15:firstName>
<p15:dob>1965-01-10</p15:dob>
<p15:partnerIndicator>Y</p15:partnerIndicator>
<p15:paidAtSingleRateIndicator>N</p15:paidAtSingleRateIndicator>
<p15:youthIndependentRateIndicator>Y</p15:youthIndependentRateIndicator>
<p15:remoteIncomeSupportIndicator>N</p15:remoteIncomeSupportIndicator>
<p15:maximumRateDetails>
<p15:maximumRateTypeCode>AGE</p15:maximumRateTypeCode>
<p15:maximumRateIndicator>N</p15:maximumRateIndicator>
</p15:maximumRateDetails>
<p15:maximumRateTypeCode>FTB</p15:maximumRateTypeCode>
<p15:maximumRateIndicator>Y</p15:maximumRateIndicator>
<p15:maximumRateTypeCode>NSA</p15:maximumRateTypeCode>
<p15:maximumRateIndicator>Y</p15:maximumRateIndicator>
Version: 7.18
Page 61 of 102
<p15:numberOfChildrenAssessed>3</p15:numberOfChildrenAssessed>
<p15:percentageOfCareForChildren>51.35</p15:percentageOfCareForChildren>
<p15:streetSuburbMatchIndicator>Y</p15:streetSuburbMatchIndicator>
<p15:stateMatchIndicator>N</p15:stateMatchIndicator>
<p15:postcodeMatchIndicator>Y</p15:postcodeMatchIndicator>
<p15:previousRegularPaymentDetails>
<p15:paymentTypeCode>FTBA</p15:paymentTypeCode>
<p15:benefitTypeCode>FTB/p15:benefitTypeCode>
<p15:amount>1115.12</p15:amount>
<p15:lastPaymentDate>2008-02-14</p15:lastPaymentDate>
<p15:grantDate>2000-02-01</p15:grantDate>
<p15:legislatedMaximumEntitlement>1125.12</p15:legislatedMaximumEntitlement>
</p15:previousRegularPaymentDetails>
<p15:paymentTypeCode>FTBB</p15:paymentTypeCode>
<p15:benefitTypeCode>FTB</p15:benefitTypeCode>
<p15:paymentTypeCode>RA</p15:paymentTypeCode>
<p15:previousIrregularPaymentDetails>
<p15:paymentTypeCode>BASIC</p15:paymentTypeCode>
<p15:benefitTypeCode>AGE</p15:benefitTypeCode>
<p15:frequencyCode>ONE</p15:frequencyCode>
</p15:previousIrregularPaymentDetails>
<p15:frequencyCode>1WE</p15:frequencyCode>
<p15:paymentTypeCode>EEP</p15:paymentTypeCode>
<p15:frequencyCode>ONE</p15:frequencyCode>
<p15:deductionFromPaymentDetails>
<p15:paymentTypeCode>PPS</p15:paymentTypeCode>
<p15:deductionTypeCode>PQN</p15:deductionTypeCode>
Version: 7.18
Page 62 of 102
</p15:deductionFromPaymentDetails>
<p15:paymentTypeCode>AGE</p15:paymentTypeCode>
<p15:deductionTypeCode>DDF</p15:deductionTypeCode>
<p15:paymentTypeCode>NSA</p15:paymentTypeCode>
<p15:deductionTypeCode>RCS</p15:deductionTypeCode>
<p15:deductionDetails>
<p15:organisationName>Test Org1</p15:organisationName>
<p15:deductionTypeCode>RDS</p15:deductionTypeCode>
<p15:targetAmount>15001.10</p15:targetAmount>
<p15:outstandingBalance>15002.10</p15:outstandingBalance>
<p15:deductionEndDate>2009-02-08</p15:deductionEndDate>
<p15:yearToDateAmount>15003.10</p15:yearToDateAmount>
</p15:deductionDetails>
<p15:deductionTypeCode>TAX</p15:deductionTypeCode>
<p15:deductionTypeCode>DDF</p15:deductionTypeCode>
<p15:incomeManagementDeductionDetails>
<p15:organisationName>Basics Card</p15:organisationName>
</p15:incomeManagementDeductionDetails>
<p15:organisationName>Telstra</p15:organisationName>
Version: 7.18
Page 63 of 102
<p15:futureRegularPaymentDetails>
<p15:paymentTypeCode>FTBA</p15:paymentTypeCode>
<p15:benefitTypeCode>FTB/p15:benefitTypeCode>
<p15:dateToBePaid>2016-02-28</p15:dateToBePaid>
</p15:futureRegularPaymentDetails>
<p15:paymentTypeCode>FTBB</p15:paymentTypeCode>
<p15:futureIrregularPaymentDetails>
</p15:futureIrregularPaymentDetails>
<p15:frequencyCode>MTH</p15:frequencyCode>
<p15:benefitTypeCode>NSA</p15: >
Version: 7.18
Page 64 of 102
<p15:nonCentrelinkIncomeDetails>
<p15:incomeTypeCode>MIV</p15:incomeTypeCode>
<p15:frequencyCode>ANN</p15:frequencyCode>
<p15:dateOfEffect>2008-02-08</p15:dateOfEffect>
</p15:nonCentrelinkIncomeDetails>
<p15:incomeTypeCode>SUP</p15:incomeTypeCode>
<p15:incomeTypeCode>REB</p15:incomeTypeCode>
<p15:foreignIncomeFinancialDetails>
<p15:incomeTypeCode>FPN</p15:incomeTypeCode>
<p15:componentCode>DIS</p15:componentCode>
<p15:currencyType>USD</p15:currencyType>
</p15:foreignIncomeFinancialDetails>
<p15:incomeTypeCode>FOR</p15:incomeTypeCode>
<p15:componentCode>SOC</p15:componentCode>
<p15:currencyType>BRL</p15:currencyType>
<p15:incomeTypeCode>FOR</p15:incomeTypeCode>
<p15:componentCode>WID</p15:componentCode>
<p15:currencyType>AUD</p15:currencyType>
<p15:assetDetails>
<p15:assetTypeCode>HPE</p15:assetTypeCode>
<p15:assetValueAmount>5000.10</p15:assetValueAmount>
</p15:assetDetails>
<p15:assetDetails>
<p15:assetTypeCode>CIS</p15:assetTypeCode>
</p15:assetDetails>
<p15:assetDetails>
<p15:assetTypeCode>GMV</p15:assetTypeCode>
</p15:assetDetails>
<p15:assetFinancialDetails>
<p15:assetTypeCode>MIV</p15:assetTypeCode>
<p15:currencyType>USD</p15:currencyType>
Version: 7.18
Page 65 of 102
<p15:institutionName>COMMONWEALTH BANK OF AUSTRALIA</p15:institutionName>

<p15:accountType>Saving</p15:accountType>
<p15:unitCount>1000</p15:unitCount>
<p15:unitValue>332000.10</p15:unitValue>
<p15:percentageOwned>10</p15:percentageOwned>
</p15:assetFinancialDetails>
<p15:assetTypeCode>SHR</p15:assetTypeCode>
<p15:institutionName>Colonial First State</p15:institutionName>
<p15:accountType>Superannuation</p15:accountType>
<p15:assetTypeCode>CIS</p15:assetTypeCode>
<p15:institutionName>ANZ Banking Group</p15:institutionName>
<p15:accountType>Term Deposit</p15:accountType>
</p15:retrieveIncomeDetailsResultDto>
</p15:retrieveIncomeDetailsResult>
</soapenv:Body>
</soapenv:Envelope>
Version: 7.18
Page 66 of 102
4.6 Standard Fault Operation

There are five types of exceptions for CCwS Web service. These are:
• ServiceUnavailableException
• ServiceInfrastructureException
• ServiceSecurityException
• ServiceBusinessException
• RemoteException.
Note: normally the user will only get the ServiceBusinessException (wrong input etc) and
ServiceSecurityException (wrong user id, etc).
4.6.1 SOAP fault Structure
Mandator
y/Optional
<code> The exception code returned by See Section 5.1 CCwS POS Mandatory
failed web service operation. Exception Specifications.
<literal> The description of the code See Section 5.1 CCwS POS Mandatory
returned by CCwS web service. Exception Specifications.

allowed.
<attributeInError> The actual field input that has See Section 5.1 CCwS POS Optional
caused the exceptions eg. Exception Specifications.
mandatory field missing.
4.6.2 Example SOAP Fault
xmlns:xsd="http://www.w3.org/2001/XMLSchema" <xmlns:xsi="http://www.w3.org/2001/XMLSchema-
instance">
<soapenv:Header/>
<soapenv:Body>
<soapenv:Fault>
<faultcode
xmlns:p957="http://www.centrelink.gov.au/xml/schema/cws/messages/v1">P957:Serv
iceBusinessException</faultcode>
<faultstring>au.gov.centrelink.jsh.exception.ServiceBusinessException</faultstring>
<detail encodingStyle="">
<p957:ServiceBusinessExceptionmlns:p957="http://www.centrelink.gov.au/xml/schema/cw
s/messages/v1">
<p957:messageDto>
<p957:code>E044AX</p957:code><p957:literal>E044AX - Date outside
available period.</p957:literal><p957:inputRefId>123</p957:inputRefId>
Version: 7.18
Page 67 of 102
<p957:attributeInError>%1=cnfrmDate</p957:attributeInError>
<p957:attributeInError>%2=env info=PAN#MNX1 WSNIM1 2021-02-
15T09:26:26</p957:attributeInError><p957:attributeInError>%3=serviceCall=C
USTOMERCONCESSIONCONFIRMATION:RETRIEVEBENEFITSTATUSSUBSET</p9
57:attributeInError>
</p957:messageDto>
</p957:ServiceBusinessException>
</detail>
</soapenv:Fault>
</soapenv:Body>
</soapenv:Envelope>
Version: 7.18
Page 68 of 102
5. CCwS Exception Specifications

The following table will list the exceptions (along with their meaning and follow-up actions) which may
be returned to the Business Partner’s system via a SOAP Fault operation.
The Exception String listed in the table is the value returned in the FaultString of a SOAP Fault
operation.
When more than one action is listed in the Possible Follow-up Actions, this refers to the order of
actions to try. If the first action is successful the following suggested actions need not be applied.
The "Centrelink Helpdesk" referred to in the following table is the Confirmation Services Helpdesk.
The contact details are:
• FreeCALL™ 1800 887 774; or
• e-mail: helpdesk.ccs@servicesaustralia.gov.au.
5.1 Exception Tables
5.1.1 Verify Name Address Operation
Exception Possible Follow-up

Exception String Meaning
Code Actions
E008AX E008AX - Postcode Postcode cannot be less Re-send operation with

format invalid. than 4 characters. correct postcode.
E017ZZ E017ZZ - Entry Invalid character (eg ‘-’) in Re-send operation with
contains invalid one of the name fields. correct name.
characters
E020ZZ E020ZZ - This code State does not contain a Re-send operation with
may not be entered valid state code. correct values.
E034AX E034AX - Line 1 or Address Line 1 or Address Re-send operation with all
Line 2, Suburb, State Line 2, Suburb, State and values.
and Postcode Postcode are mandatory
mandatory for fields for address
address. confirmation.
E035AX E035AX - Surname is Surname is mandatory Re-send operation with all

mandatory for name field for name values.
confirmation. confirmation.
E036AX E036AX - Name, Date The Centrelink CRN and Re-send operation with all
of Birth or Address at least one of the name, values.
details must be date of birth or address
entered fields are required.
E044AX E044AX - Date Confirmation date cannot Re-send operation with

outside available be in the future or more correct values.
period. than 2 years in the past.
E052AX E052AX - Date cannot Date of Birth for the Re-send operation with
be in the future customer cannot be a correct values.
future date.
Version: 7.18
Page 69 of 102
E118AX E118AX - Unable to The Centrelink CRN Re-send operation with

confirm result as no entered belongs to an correct values.
record found for CRN Organisation record.
E118AX The Centrelink CRN The Centrelink CRN Re-send operation with
entered does not have entered does not have correct values.
correct format Re- correct check digit.
send operation with
correct values
E119AX E119AX - Unable to No record found for Re-send operation with

confirm result for this Centrelink CRN entered. correct values.
CRN please contact
Contact Centrelink
Centrelink
Helpdesk.
E146AX E146AX - Unable to Customer has not given Ask customer to contact
confirm - Customer permission for information Centrelink
has not given to be confirmed
permission for CCeS
X001AX X001AX - No profile Organisation does not Contact Centrelink

exists. have the correct work unit Helpdesk.
or profile for the enquiry.
X004AX X004AX - Child CRN Organisation doesn’t have Ask customer to re-enter
passed. Child CRN match Centrelink CRN or enter
characteristic on profile. Centrelink customer (adult)
CRN and re-send
operation.
X005AX X005AX - Communication problem. Contact Centrelink

Environment links Helpdesk
unavailable
X006AX X006AX - No parent No parents found for the Contact Centrelink

linked to child CRN input Child CRN. Helpdesk.
X017AX X017AX - Unmatched InputRefID in response Contact Centrelink

response from Server doesn’t match request. Helpdesk.
X019AX X019AX - Local Communication problem. Contact Centrelink

environment not Helpdesk.
available
5.1.2 Verify DVA Details Operation
Exception Exception String Meaning Possible Follow-up

Code Actions
E008AX E008AX - Postcode Postcode cannot be less Re-send operation with

format invalid. than 4 characters. correct postcode.
E011AX E011AX - All Cust ID, firstname and Re-send operation with all
mandatory fields must Surname are mandatory. values.
be completed.
E017ZZ E017ZZ - Entry Invalid character (eg ‘-’) in Re-send operation with
contains invalid one of the name fields. correct name
characters characteristics.
Version: 7.18
Page 70 of 102
Exception Exception String Meaning Possible Follow-up

Code Actions
E020ZZ E020ZZ - This code State does not contain a Re-send operation with
may not be entered valid state code. correct values.
E034AX E034AX - Line 1 or Address Line 1 or Address Re-send operation with all
Line 2, Suburb, State Line 2, Suburb, State and values.
and Postcode Postcode are mandatory
mandatory for fields for address
address. confirmation.
E044AX E044AX - Date outside Confirmation date cannot Re-send operation with
available period. be in the future or more correct values.
than 2 years in the past.
E052AX E052AX - Date cannot Date of Birth for the Re-send operation with
be in the future Customer cannot be a correct values.
future date.
X001AX X001AX - No profile Organisation does not Contact Centrelink

exists. have the correct work unit Helpdesk.
X007AX X007AX - Invalid Organisation type is not Contact Centrelink

external department valid. Helpdesk.
enquiry code
5.1.3 Retrieve Benefit Status Subset
Exceptio Possible Follow-up

n Code Actions
E008AX E008AX - Postcode format Postcode cannot be less Re-send operation with
invalid. than 4 characters. correct postcode.
E022ZZ E022ZZ - Check digit is The Secondary CRN Re-send operation with
incorrect or CRN format entered does not have correct values.
invalid correct check digit.
E044AX E044AX - Date outside Confirmation date cannot Re-send operation with
available period be in the future or more correct values.
than 2 years in the past.
E052AX E052AX - Date cannot be Date of Birth for the Re-send operation with
in the future customer cannot be a correct values.
future date.
E118AX E118AX - Unable to The Centrelink CRN Re-send operation with

confirm result as no record entered belongs to an correct values.
found for CRN Organisation record.
correct format Re-send correct check digit.
operation with correct
values
Version: 7.18
Page 71 of 102
Exceptio Possible Follow-up

n Code Actions
E119AX E119AX - Unable to No record found for Re-send operation with

confirm result for this CRN Centrelink CRN entered.. correct values.
please contact Centrelink
Contact Centrelink
Helpdesk.
E146AX E146AX - Unable to Customer has not given Ask customer to contact
confirm - Customer has permission for information Centrelink
not given permission for to be confirmed
CCeS
X001AX X001AX - No profile exists. Organisation does not Contact Centrelink

have the correct work unit Helpdesk.
X004AX X004AX - Child CRN Organisation doesn’t have Ask customer to re-enter
passed. Child CRN match Centrelink CRN or enter
characteristic on profile. Centrelink customer
(adult) CRN and re-send
operation.
X005AX X005AX - Environment Communication problem. Contact Centrelink

links unavailable Helpdesk.
X006AX X006AX - No parent linked No parents found for the Contact Centrelink
to child CRN input Child CRN. Helpdesk.
X017AX X017AX - Unmatched InputRefID in response Check values and re-send

response from Server doesn’t match request. operation.
Contact Centrelink
Helpdesk.
X018AX X018AX - No response Communication problem. Contact Centrelink

from local Core Helpdesk.
Component

environment not available Helpdesk.
5.1.4 Retrieve Income Details
Exceptio Exception String Meaning Possible Follow-up

n Code Actions
CX011 Unable to confirm result as No record found for Re-send operation with
no record found for CRN Centrelink CRN entered. correct values.
entered.
Contact Centrelink
Helpdesk.
E008AX E008AX - Postcode format Postcode cannot be less Re-send operation with
invalid. than 4 characters. correct postcode.
E020ZZ E020ZZ - This code may State does not contain a Re-send operation with
not be entered valid state code. correct values.
Version: 7.18
Page 72 of 102

n Code Actions
E034AX E034AX - Line 1 or Line 2, Address Line 1 or Address Re-send operation with all
Suburb, State and Line 2, Suburb, State and values.
Postcode mandatory for Postcode are mandatory
address. fields for address
confirmation.
E044AX E044AX - Date outside Confirmation Date is Re-send operation with

available period. earlier than 1 July of the correct values.
preceding financial
E047JW Unable to confirm, please Communication problem. Contact Centrelink

contact Centrelink Helpdesk.
helpdesk
E052AX E052AX - Date cannot be Date of birth for the Re-send operation with
in the future customer or confirmation correct values.
date cannot be a future
date.
E067JW E067JW - Unable to Centrelink customer has Contact Centrelink

confirm, please contact Deny Access attribute. Helpdesk.
Centrelink helpdesk
E068JW Customer is deceased Customer is deceased. Contact Centrelink

Helpdesk.
E095AX E095AX - Line 1 or Line 2 Address Line 1 or Line 2 Re-send operation with all
and Suburb mandatory for and Suburb are mandatory values.
Street/Suburb confirmation fields for street/suburb
confirmation.
E008ET E008ET - Customer is an The Centrelink CRN Re-send operation with

organisation. entered belongs to an correct values.
Organisation record.
correct format Re-send correct check digit.
operation with correct
values
E613PI E613PI – Invalid Confirmation Date is Re-send operation with

confirmation date earlier than 1 July of the correct values.
requested preceding financial year.
E659PI Unable to confirm result Child CRN was submitted, Re-send operation with
for this CRN, please please contact family for correct values.
contact the Centrelink the correct Family CRN.
customer and check
correct family member’s
CRN
E661PI E661PI - Unable to Customer is cancelled in Contact Centrelink

confirm result Centrelink System. Helpdesk.
E670PI E670PI – Customer has Customer has not Contact Centrelink

not consented to electronic authorised electronic Helpdesk.
exchange of data exchange of data.
Version: 7.18
Page 73 of 102

n Code Actions
E744PI E744PI - Customer Surname does not match Re-send operation with
surname not matched. Centrelink customer correct values.
record.
E745PI E745PI - Customer first First Name does not Re-send operation with
name not matched. match Centrelink customer correct values.
record (excluding Income
Confirmation).
E746PI E746PI – Customer date Date of Birth does not Re-send operation with
of birth not matched match Centrelink customer correct values.
record.
E751PI E751PI - Surname and Surname and Date of Birth Re-send operation with
date of birth not matched does not match Centrelink correct values.
customer record.
E752PI E752PI - First name and First Name and Date of Re-send operation with
date of birth not matched Birth does not match correct values.
Centrelink customer
Confirmation).
E754PI E754PI - Surname, first Surname, First Name and Re-send operation with
name and date of birth not Date of Birth does not correct values.
matched match Centrelink customer
Confirmation).
X001AX X001AX - No profile exists. Organisation does not Contact Centrelink

have the correct work unit Helpdesk.

environment not available. Helpdesk.
X021CU X021CU - Unable to Customer is Sensitive in Contact Centrelink

confirm, please contact Centrelink System. Helpdesk.
Centrelink helpdesk.
E218ZZ Unable to confirm, please The Centrelink customer Re-send operation.

contact Centrelink record is locked by
Contact Centrelink
helpdesk another user.
Helpdesk.
XnnnZZ Unable to confirm, please Service Infrastructure Contact Centrelink

contact Centrelink Exception Helpdesk
helpdesk.
Generic service
infrastructure exception
5.2 Schema Exceptions
5.2.1 Schema Exception Structure
Business Partners will be required to validate all SOAP operations prior to sending an operation to
Centrelink. SOAP messages can be validated using the relevant WSDL File.
Version: 7.18
Page 74 of 102
Centrelink will also validate all SOAP messages that are sent. If any exception occurs an exception
message will be returned.
Mandator
y/Optional
<transaction-id> Transaction ID record by Centrelink. numeric characters Mandatory
<error-code> The error code returned by failed 10 alphanumeric characters Mandatory

schema validation.
<error-subcode> The erro rsub code returned by 10 alphanumeric characters Mandatory

failed schema validation.
<error-message> The error message explain the alphanumeric characters Mandatory

attribute in error and invalid value/s.
<?xml version="1.0" encoding="UTF-8"?>

<env:Envelope xmlns:env="http://schemas.xmlsoap.org/soap/envelope/">
<env:Body>
<env:Fault>
<faultcode>env:Client</faultcode>``
<faultstring>Internal Error (from client)</faultstring>
<detail>
<transaction-id>174131</transaction-id>
<error-code>0x00230001</error-code>
<error-subcode>0x01d30003</error-subcode>
<error-
message>http://10.246.111.254:6053/ConfirmationServices/services/cust
omerConfirmationPort: cvc-simple-type 1: element
{http://www.centrelink.gov.au/xml/schema/ccs/retrieveincomedetails/v1}fir
stName value '@#$%' is not a valid instance of the element type</error-
message>
</detail>
</env:Fault>
</env:Body>
</env:Envelope>
Version: 7.18
Page 75 of 102
5.2.3 Schema Exception Table
Possible
Exception
Exception String Meaning Follow-up
Code
Actions
0x0023000 http://10.246.111.254:6053/Conf (Attribute in error) contains Re-send

1 irmationServices/services/custo invalid characters or invalid operation with
merConfirmationPort: cvc- length. correct values.
simple-type 1: element
Note : Attribute can be any
{http://www.centrelink.gov.au/x
one or more of the input
ml/schema/ccs/retrieveincomed
fields. If more than one
etails/v1} (attribute in error)
attribute is invalid than
value '(Invalid Value)' is not a
subsequent exceptions will
valid instance of the element
occur.
type
0x0023000 http://10.246.111.254:6053/Conf All mandatory fields are Re-send

1 irmationServices/services/custo required. operation with
merConfirmationPort: cvc- correct values.
Note: MANDATORY FIELD
particle 2.1: in element
only shows the first
Mandatory field that is
required. If more than one
etails/v1}retrieveIncomeDetails
Mandatory field is required,
Dto of type
subsequent exceptions will
occur.
etails/v1}retrieveIncomeDetails
Dto, found
<p755684194:orgRefNumber
> (in namespace
http://www.centrelink.gov.au/xml
/schema/ccs/retrieveincomedeta
ils/v1), but next item should be
etails/v1}
MANDATORY FIELD
Version: 7.18
Page 76 of 102
6. CCwS Response Values Mapping Table

The following table lists the codes returned within SOAP Response tags and their meanings.
Respons
Description
e Code
CAN Cancelled (payment cancelled)
CHI Child (when <crn> provided is a card holder, <scndryCrn> provided

is linked as a child record on that card)
CUR Current (on payment)
N No
NA Not Applicable
NAP Not on an appropriate payment
NCR No Concession Relationship (when <crn> provided is a card holder,

if the <scndryCrn> provided is not linked to the card this result will
be returned)
NCUR Not Current
NN No Name Recorded
NP Not Provided
PTR Partner (when <crn> provided is a card holder, <scndryCrn>

provided is linked as a partner record on that card)
SUS Suspended (payment suspended)
UC Unable to Confirm
Y Yes
Version: 7.18
Page 77 of 102
7. CCwS External Agency Match Code values table

This table lists the match codes returned for non-Centrelink External matches only (extRqst).
Match
Description Possible Follow-up Actions
Code
9 Credentials provided for this None.

record are valid, the record is
located and result returned.
10 No record found for non Check reference number with

Centrelink reference number customer.
provided.
Customer needs to contact
relevant external agency.
11 Multiple records found for non Contact relevant external agency

Centrelink reference (DVA for DVA customers, etc...).
number/details provided.
14 File ID Matched, 1 record found, Check name details with customer.

but the name provided did not
Customer may need to contact
match.
relevant external agency (DVA for
DVA customers, etc...).
15 File ID match, multiple names in Check name details with customer.

list which are all unsuccessful
Customer may need to contact
name matches.
relevant external agency (DVA for
DVA customers, etc...).
Version: 7.18
Page 78 of 102
8. Appendix A - Centrelink Payment Descriptions

The following table contains a list of all Centrelink Payment Descriptions
ABA ABSTUDY - Schooling Applicant
ABT ABSTUDY - Schooling Student
ABY ABSTUDY
AGE Age Pension
AIC Assisted and Isolated children
AUS AUSTUDY Payment
BVA Bereavement Allowance
CAR Carer Payment
CDA Carer Allowance
CLS Low Income Supplement
CRI Crisis Payment
DAP Dad and Partner Pay
DOP Double Orphans Pension
DRA Disaster Recovery Allowance
DSP Disability Support Pension
ECP Exceptional Circumstances Relief Payment
EMG Emergency Payment
EPA AUSTUDY Education Pension Allowance
EPE AIC Pensioner Education Supplement
EPF FACS Pensioner Education Supplement
ERP Emergency Recovery Payment
FFR Farm Family Restart
FHS Farm Household Support
FSP Flexible Support Payment
FTB Family Tax Benefit
INM Income Management
JSP JobSeeker Payment
MEP Essential Medical Equipment Payment
MOB Mobility Allowance
NMA Newstart Mature Age Allowance
Version: 7.18
Page 79 of 102
NSA Newstart Allowance
PPL Paid Parental Leave
PPP Parenting Payment Partnered
PPS Parenting Payment Single
PTA Partner Allowance
SKA Sickness Allowance
SPL Special Benefit
TLA Transition to Independent Living Allowance
TAP Tertiary Access Payment
WDA Widow Allowance
WFA Wife Pension Age
WFD Wife Pension DSP
WID Widow Pension
YAL Youth Allowance
Version: 7.18
Page 80 of 102
9. Appendix B - Entitlement Descriptions - DVA

The following table lists the codes returned within the <pymtType> element in external response XML
blocks and their meanings.
Payment
Description
Code
AGE Age Pension
SER Service Pension
ISS Income Support Supplement
VEP Veteran Payment
The following table illustrates other entitlement types provided by DVA.
Entitlement
Description
Code
GCH Gold Card Holder
IAS Level of Incapacity (Incapacity Assesment)
PCC Pensioner Concession Card
POW Prisoner of War
SDA Specific disability Assesment
SHC Seniors Health Card
WWP War Widow(er) Pension
EYP Dependent Eligible Young Person (MRCA)
MWC MRCA White Card (MRCA)
OIP Overall Impairment Points (MRCA)
SRD Special Rate Disability Pensions (MRCA)
WDP Wholly Dependent Partner (MRCA)
Version: 7.18
Page 81 of 102
10. Appendix C – Payment Components
The following table contains a list of all possible Payment Components
Code Description
ACCMO Accom Expenses OTP
ACCMP Accommodation Expenses (ERP) - Regular
ACM Accommodation
ACSP Annual Carer Supplement Payment
ADD Additional Assistance - Regular
ADDNL Additional Benefit
ADDO Additional Assistance - Oneoff
ADD01 Additional Assistance
ADLTO Adult Expenses (ERP) - Oneoff
ADLTP Adult Expenses (ERP) - Regular
ADU Adult
ADULT Adult
AEP ETR Payment
AIN Additional Incidentals
AOA Assistance for Older Australians
ARN Arrears Non Taxable
ART Arrears Taxable
ASB Training & Learning Bonus - Admin
BABP Living Allowance / Board Provider
BABS Living Allowance / Term / School Boarder
BASIC Basic Payment
BEN Parenting Payment Partnered
BFC One Off Payment for Families/Carers
BPD Child Disability Assistance - Oneoff
BRV Bereavement Allowance
BRVBA Bereavement Pymt - FTB Part A
Version: 7.18
Page 82 of 102
BRVCA Bereavement Pymt - Energy Supp Part A
BRVCB Bereavement Pymt - Energy Supp Part B
BRVFB Bereavement Pymt - FTB Part A Supplement
BRVFT Bereavement Pymt - FTB Part B
BRVLF Bereavement Pymt - Large Family Suppl
BRVLS Bereavement Lump Sum Payment
BRVMU Bereavement Pymt - Multiple Birth Allow
BRVNB Bereavement Pymt - FTB New Born Supplement
BRVRA Bereavement Pymt - Rent Assistance
BRVSI Bereavement Pymt - Single Income Family Suppl
BRVSU Bereavement Pymt - FTB Part B Supplement
BSB Back to School Bonus
BSWAT BSWAT Payment
BULDO Building Expenses (ERP) - Oneoff
BULDP Building Expenses (ERP) - Regular
BUSNP Business Expenses (ERP) - Regular
CARPO Carer Adjustment Payment
CCQ Quarterly Child Care Tax Rebate
CCR Child Care Tax Rebate
CDE CDEP Supplement
CDPTO CDEP Trans Arrears Payment (ERP) - Oneoff
CDPTP CDEP Trans Arrears Payment (ERP) - Regular
CEA Clean Energy Advance
CES Energy Supplement
CESA Energy Supplement Part A
CESB Energy Supplement Part B
CESO Energy Supplement - One Time Payment
CET Clean Energy Top-Up
CHILD Child
CHLDO Child Expenses (ERP) - Oneoff
CHLDP Child Expenses (ERP) - Regular
CJBRV Bereavement Allowance
CLP Cost of Living – One Time Payment
Version: 7.18
Page 83 of 102
CLS Low Income Supplement
CONT Flexible Parental Leave Pay
CPR CPS Retrospective Payment
CPS CDEP Participant Supplement
CRI Crisis Payment
CSA Carer Allowance Adul
CSB Carer Allowance Both
CSC Carer Allowance Child
CSD Carer Allowance DVA
CSP Carer Supplement
CVS Coronavirus Supplement
DAP Dad and Partner Pay
DCA Dependent Child Allowance
DPADO Dependent Adult Expenses (ERP) - Oneoff
DPADP Dependent Adult Expenses (ERP) - Regular
DRF Approved Program of Work Supplement
DVA DVA Income Management Payment Amount
DVACA DVA Annual Carer Supplement Payment
DVACP DVA Carer Bonus
DVACS DVA Carer Supplement
EAB Additional Boarding Allowance
EABO Additional Boarding Allowance / Term
EAP Energy Assistance Payment
EBB Basic Boarding Allowance
EBBO Basic Boarding Allowance / Term
EDA Dislocation Allowance
EDE Distance Education Allowance
EDEP Education Entry Payment
EDEPN Education Entry Supplement
EDSO AIC Distance Education Allowance Supplement
EEP Employment Entry Payment
EMEP Essential Medical Equipment Payment
EM0 Emergency Payment Zero
Version: 7.18
Page 84 of 102
EM1 Emergency Payment One
EM2 Emergency Payment Two
EM3 Emergency Payment Three
EM4 Emergency Payment Four
EM5 Emergency Payment Five
EM6 Emergency Payment Six
EM7 Emergency Payment Seven
EM8 Emergency Payment Eight
EM9 Emergency Payment Nine
EPA ABSTUDY Pensioner Education Supplement
EPE AIC Pensioner Education Supplement
EPEO AIC Pensioner Education Supplement / Term
EPF FACS Pensioner Education Supplement
ESA Economic Security Strategy for CDA/ADULT payment
ESB Economic Security Strategy for CDA/BOTH payment
ESC Economic Security Strategy for CDA/CHILD payment
ESH Second Home Allowance
ESS Economic Scrty Pymt
ETP ETR Payment
EXG Ex-Gratia Payment
EXO Crisis Payment – Other Extreme Circumstances Oneoff
EXP Expenses cmpnt for Financial Case Management
EXV Crisis Payment – Extreme Circumstances - Oneoff
FAA Fares Allowance
FARMO Farm Expenses (ERP) - Oneoff
FBSUP FTB(A) Supplement
FEE Refund of Recovery Fee
FHB Farmer Hardship Payment
FNRLO Burial Assistance Payment (ERP) - Oneoff
FSUP Family Supplement
FTBA Family Tax Benefit Part A
FTBB Family Tax Benefit Part B
FUELO Fuel Expenses (ERP) - Oneoff
Version: 7.18
Page 85 of 102
FUELP Fuel Expenses (ERP) - Regular
FUNLO Funeral Expenses (ERP) - Oneoff
FYR Debt Amount by Financial Year
GA Guardian Allowance
GCB Grant Parents Child Care Benefit
GCP Approved Program of Work Supplement
GIC Refund of Interest Charge
GNA Approved Program of Work Supplement
GST GST Component
HBMA Home Based Maintenance Allowance
HEC HECS or Course Fees
HOMEO Home Modification (ERP) - Oneoff
HSPLO Hospital Expenses (ERP) - Oneoff
HSPLP Hospital Expenses (ERP) - Regular
HUM Crisis Payment - Humanitarian Entrants
IALL Incentive Allowance
IMGOO Irrigation Management Grant (ERP) - Oneoff
INC Incidentals Allowance
INSRO Insurance Expenses (ERP) - Oneoff
ISB Income Support Bonus
JFA JET Child Care Fee Assistance
LAFHA Living Away From Home Allowance
LAW Lawful Custody
LFS Large Family Supplement
LLN Language Literacy & Numeracy Supplement
LON Home Equity Access Loan
LONA HEAS Advance Payment
LPGCO LPG Conversion Expenses (ERP) - Oneoff
LPGDO LPG Dedicated Vehicle Expenses (ERP) - Oneoff
MEA Meal Allowance
MEDLO Medical Expenses (ERP) - Oneoff
MEDLP Medical Expenses (ERP) - Regular
MIA Maternity Immunisation Allowance (paid w/MAT)
Version: 7.18
Page 86 of 102
MSP Matched Savings Scheme Payment
MSPNT NT Matched Savings Scheme Payment
MSPPB PB Matched Savings Scheme Payment
MSPWA WA Matched Savings Scheme Payment
MUL Multiple Birth Allowance
MVA Motor Vehicle Allowance
NBS Newborn Supplement
NBU Newborn Upfront Payment
NGJ National Green Jobs Corps Supplement
NHE Crisis Payment - National Health Emergency
NWE Approved Program of Work Supplement
OOPKO Out Of Pocket Expenses (ERP) - Oneoff
ONN01 ERP Payment Code
ONR01 ERP Payment Code
ONR02 ERP Payment Code
OSEAS Overseas Add-on Payment (for Child)
OT1 One Time Payment 1
OTN01 ERP Payment Code
OTN02 ERP Payment Code
OTR01 ERP Payment Code
OTR02 ERP Payment Code
PBB Pension Bonus Bereavement Payment
PBP Pension Bonus Scheme Payment
PBS Pension Bonus Scheme Payment
PBT Pension Bonus Top-Up Payment
PHA Pharmaceutical Allowance
PHABP Pharmaceutical Allowance / Board Provider
Version: 7.18
Page 87 of 102
PHABS Pharmaceutical Allowance/Term/School Boarder
PHALS Pharmaceutical Allowance Lump Sum
PII PaTH Internship Incentive
PNINC Govt Housing Authority Concessional amt
PNSUP Pension Supplement
PSBAS Basic Pension Supplement
PSMIN Minimum Pension Supplement
PSREM Remaining Pension Supplement
RA Rent Assistance
RAA Remote Area Allowance
RAABP Remote Area Allowance / Board Provider
RAABS Remote Area Allowance / Term / School Boarder
RABP Rent Assistance / Board Provider
RABS Rent Assistance / One-off / School Boarder
RCCLK Reconciliation Special Adjustment
RCP Residential Costs
REL Relocation Allowance
REPTO Repatriation Expenses (ERP) - Oneoff
RJC Approved Program of Work Supplement
RRG FFR Re-establishment Grant : Oneoff Payment
RSC Relocation Scholarship
SBP Stillborn Baby Payment
SBRBA Substitute Bereavement Pymt - FTB Part A
SBRCA Substitute Bereavement Pymt - CESA
SBRCB Substitute Bereavement Pymt - CESB
SBRFB Substitute Bereavement Pymt - FTB(A) Suppl
SBRFT Substitute Bereavement Pymt - FTB Part B
SBRLF Substitute Bereavement Pymt - Large Fam Suppl
SBRMU Substitute Bereavement Pymt - Mult Birth Allw
SBRRA Substitute Bereavement Pymt - Rent Assistance
SBRSI Substitute Bereavement Pymt - SIFS
SBRSU Substitute Bereavement Pymt - FTB(A) Suppl
SCA Seniors Concession Allowance
Version: 7.18
Page 88 of 102
SCAT Flexible Parental Leave Pay
SFA1 School Fees Allowance Group 1
SFA2 School Fees Allowance Group 2 / Fees
SFA2B School Fees Allowance Group 2 / Board
SFA2T School Fees Allowance Group 2 Boarding
SIB Single Income Family Bonus
SIFS Single Income Family Supplement
SKB Schoolkids Bonus
SPS Single Parent Supplement
SS Seniors Supplement Payment
SSL Student Start-up Loan
SSP Special Child Care Benefit
SSS Student Start-up Scholarship
STA School Term Allowance
SUPB FTB part B supplement
SUPDA Dislocation Allowance
SUPPL Pension Basic Supplement
TA Telephone Allowance
TAP Tertiary Access Payment
THE Thesis Allowance
TILA Trans to Indep Living
TLB Training & Learning Bonus
TPA Family Tax Payment A (Pre 2000 PYMTS)
TPB Family Tax Payment B (Pre 2000 PYMTS)
TRA Training Component
TRINC Govt Housing Authority Concessional amt
TRMIN Transitional quarterly pension
TRNTX Non Taxable Transition Component
TRS Training Supplement
TRSUP Notional Pension Supplement
TRVLO Travel Expenses (ERP) - Oneoff
UAS Utilities Allowance
VAPTO Visa and Passport Expenses (ERP) - Oneoff
Version: 7.18
Page 89 of 102
VEHLO Vehicle Expenses (ERP) - Oneoff
VIP Voluntary Income Management Incentive Payment
VIPNT NT Voluntary Income Management Incentive Pymt
VIPPB PB Voluntary Income Management Incentive Pymt
VIPWA WA Voluntary Income Management Incentive Pymt
WFD Approved Program of Work Supplement
WORKO Workplace Modification (ERP) - Oneoff
YDS Youth Disability Supplement
YDSO Youth Disability Supplement - Oneoff
Z500 Job Commitment Bonus Payment 1
Z501 Job Commitment Bonus Payment 2
Z600 AGDRP Adult
Z601 AGDRP Child
Z602 Ex-Gr NZCZENS Adult
Z603 Ex-Gr NZCZENS Child
Z604 Ex-Gr NZCZENS DEPADULT
Version: 7.18
Page 90 of 102
11. Appendix D – Frequency Code Descriptions

The following table lists the codes returned for <frequencyCode> elements in the
retrieveIncomeDetailsResults.
Frequency
Description
Code
ANN ANNUALLY
DAY Daily
DLY DAILY
HMT 2 PAYS PER MTH
IOP Income for One Period
MTE Monthly
MTH MONTHLY
ONE ONE-OFF
QTR Quarterly
1WE WEEKLY
2WE FORTNIGHTLY
4WE 4-WEEKLY
6WE 6 Weekly
8WE 8 weekly
12W TWELVE WEEKLY
2MT BI-MONTHLY
3MT QUARTERLY
6MT HALF YEARLY
14P 14 payments per annum
Version: 7.18
Page 91 of 102
12. Appendix E – Deduction Type Code Descriptions

The following table list the codes returned for <deductionTypeCode> elements in the
retrieveIncomeDetailsResults
Deduction
Description
Code
CDP CDEP Deduction
CEP Centrelink Education Payment Deduction
CMP Compensation Deduction
CSA Child Support Deduction
DDF Centrepay Deductions
EIS NEIS/AEIS Deduction
FCM Financial Case Management Deduction
FPD Foreign Pension Deduction
FSL Financial Supplement Loan Trade-in
IPI Immediate Payment Deduction
OTH Other Direct Deductions
PBI Penalty Repayment
PPL Paid Parental Leave
PLSUP Paid parental leave Supplement
PQN Income Management
RCS Employment Advance Repayment
RCV Lump Sum Advance Repayment
RCY Debt Repayment
RDS Rent Deduction Scheme Deduction
TAX Taxation Deduction
UA Utilities Allowance
WH Debt Repayment
Version: 7.18
Page 92 of 102
13. Appendix F – Income Type Codes

The following table lists the codes returned for <incomeTypeCode> elements in the
retrieveIncomeDetailsResults
Income
Description
Type Code
BSI Business Income
CEA Casual Earnings
COM Compensation
DPI Deprived Income
DVA DVA Payments
EAN Earned Income
FIN Financial Investment Income – includes

Managed Investments and Shares
FOR Foreign Income
FPN Foreign Pension
ISA Income Stream/Annuities
MNT Maintenance Income
OGV Other Government Income
OTH Other Income – includes Exempt Income
REB Real Estate/Business Income
SHI Former Home Sale Proceeds Deemed Income
SUP Superannuation Income
TCP Trust and Companies Income
Version: 7.18
Page 93 of 102
14. Appendix G – Asset Type Codes

The following table list the codes returned for <assetTypeCode> elements in the
retrieveIncomeDetailsResults.
Asset
Description
Type Code
BUS Business
CIS Cash/Investments/Savings
DEF Deeming Exempt Financial Investments
EXA Exempt Assets
FBU Foreign Business
FOT Foreign Other
FRE Foreign Real Estate
FSP Foreign Superannuation
GBU Gifted Business
GCL Gifted Cash/Loans
GMV Gifted Motor Vehicle
GOT Gifted Other
GRE Gifted Real Estate
GTC Gifted Trust and Companies
HPE Household and Personal Effects
ISA Income Stream/Annuity
LIF Life Insurance
MBC Motor Vehicle, Boat and Caravan
MIV Managed Investments
OTH Other Assets
REB Real Estate
SHA Exempt Former Home Sale Proceeds
SHR Shares
SUP Superannuation
TAC Trusts and Companies
Version: 7.18
Page 94 of 102
15. Appendix H – Foreign Income Component Codes
Component Description
Code
ACC Accommodation Supplement
ACT NZ Actual Rate
ARP Restitution Payment - Assessable
ASR NZ Assumed Rate
ASS Assets
BAS Basic
CHB Child Benefit
CHI Family Allowance - Child
CRC Child Rearing
DIS Disability Allowance
DOM Domestic Purposes
EME Emergency Benefit
ERP Restitution Payment - Exempt
HOL Holiday Allowance
INC Income - Non Pension
INT Integration
LAA Living Alone Allowance
NAB National Assistance Benefit
NCC Non-contributory supplement
NCH Non-contributory supplement
NOT NZ Notional Rate
OTH Other
PHO Partner Holiday Allowance
POM Chilean pensions of mercy
PTR Partner supplement
QAA Qualified Adult Amount
SCS Spouse/Child Supplement
SOC Social Allowance
VET Veteran Allowance
WEL Social Welfare
WID Widows Benefit
Version: 7.18
Page 95 of 102
16. Appendix I – Currency Codes
ISO 4217 Currency Codes

Currency Code Description
AED United Arab Emirates Dirham
AFN Afghanistan Afghani
ALL Albania Lek
AMD Armenia Dram
ANG Netherlands Antilles Guilder
AOA Angola Kwanza
ARS Argentina Peso
AUD Australia Dollar
AWG Aruba Guilder
AZN Azerbaijan New Manat
BAM Bosnia and Herzegovina Convertible Marka
BBD Barbados Dollar
BDT Bangladesh Taka
BGN Bulgaria Lev
BHD Bahrain Dinar
BIF Burundi Franc
BMD Bermuda Dollar
BND Brunei Darussalam Dollar
BOB Bolivia Boliviano
BRL Brazil Real
BSD Bahamas Dollar
BTN Bhutan Ngultrum
BWP Botswana Pula
BYR Belarus Ruble
BZD Belize Dollar
CAD Canada Dollar
CDF Congo/Kinshasa Franc
CHF Switzerland Franc
CLP Chile Peso
CNY China Yuan Renminbi
COP Colombia Peso
CRC Costa Rica Colon
CUC Cuba Convertible Peso
Version: 7.18
Page 96 of 102

CUP Cuba Peso
CVE Cape Verde Escudo
CZK Czech Republic Koruna
DJF Djibouti Franc
DKK Denmark Krone
DOP Dominican Republic Peso
DZD Algeria Dinar
EGP Egypt Pound
ERN Eritrea Nakfa
ETB Ethiopia Birr
EUR Euro Member Countries
FJD Fiji Dollar
FKP Falkland Islands (Malvinas) Pound
GBP United Kingdom Pound
GEL Georgia Lari
GGP Guernsey Pound
GHS Ghana Cedi
GIP Gibraltar Pound
GMD Gambia Dalasi
GNF Guinea Franc
GTQ Guatemala Quetzal
GYD Guyana Dollar
HKD Hong Kong Dollar
HNL Honduras Lempira
HRK Croatia Kuna
HTG Haiti Gourde
HUF Hungary Forint
IDR Indonesia Rupiah
ILS Israel Shekel
IMP Isle of Man Pound
INR India Rupee
IQD Iraq Dinar
IRR Iran Rial
ISK Iceland Krona
JEP Jersey Pound
JMD Jamaica Dollar
Version: 7.18
Page 97 of 102

JOD Jordan Dinar
JPY Japan Yen
KES Kenya Shilling
KGS Kyrgyzstan Som
KHR Cambodia Riel
KMF Comoros Franc
KPW Korea (North) Won
KRW Korea (South) Won
KWD Kuwait Dinar
KYD Cayman Islands Dollar
KZT Kazakhstan Tenge
LAK Laos Kip
LBP Lebanon Pound
LKR Sri Lanka Rupee
LRD Liberia Dollar
LSL Lesotho Loti
LYD Libya Dinar
MAD Morocco Dirham
MDL Moldova Leu
MGA Madagascar Ariary
MKD Macedonia Denar
MMK Myanmar (Burma) Kyat
MNT Mongolia Tughrik
MOP Macau Pataca
MRO Mauritania Ouguiya
MUR Mauritius Rupee
MVR Maldives (Maldive Islands) Rufiyaa
MWK Malawi Kwacha
MXN Mexico Peso
MYR Malaysia Ringgit
MZN Mozambique Metical
NAD Namibia Dollar
NGN Nigeria Naira
NIO Nicaragua Cordoba
NOK Norway Krone
NPR Nepal Rupee
Version: 7.18
Page 98 of 102

NZD New Zealand Dollar
OMR Oman Rial
PAB Panama Balboa
PEN Peru Nuevo Sol
PGK Papua New Guinea Kina
PHP Philippines Peso
PKR Pakistan Rupee
PLN Poland Zloty
PYG Paraguay Guarani
QAR Qatar Riyal
RON Romania New Leu
RSD Serbia Dinar
RUB Russia Ruble
RWF Rwanda Franc
SAR Saudi Arabia Riyal
SBD Solomon Islands Dollar
SCR Seychelles Rupee
SDG Sudan Pound
SEK Sweden Krona
SGD Singapore Dollar
SHP Saint Helena Pound
SLL Sierra Leone Leone
SOS Somalia Shilling
SPL Seborga Luigino
SRD Suriname Dollar
STD São Tomé and Príncipe Dobra
SVC El Salvador Colon
SYP Syria Pound
SZL Swaziland Lilangeni
THB Thailand Baht
TJS Tajikistan Somoni
TMT Turkmenistan Manat
TND Tunisia Dinar
TOP Tonga Pa'anga
TRY Turkey Lira
TTD Trinidad and Tobago Dollar
Version: 7.18
Page 99 of 102

TVD Tuvalu Dollar
TWD Taiwan New Dollar
TZS Tanzania Shilling
UAH Ukraine Hryvnia
UGX Uganda Shilling
USD United States Dollar
UYU Uruguay Peso
UZS Uzbekistan Som
VEF Venezuela Bolivar
VND Viet Nam Dong
VUV Vanuatu Vatu
WST Samoa Tala
XAF Communauté Financière Africaine (BEAC) CFA Franc BEAC
XCD East Caribbean Dollar
XDR International Monetary Fund (IMF) Special Drawing Rights
XOF Communauté Financière Africaine (BCEAO) Franc
XPF Comptoirs Français du Pacifique (CFP) Franc
YER Yemen Rial
ZAR South Africa Rand
ZMW Zambia Kwacha
ZWD Zimbabwe Dollar
Version: 7.18
Page 100 of 102
17. Appendix J – Payment Group and Applicable Components

This table is not to be used in isolation. This is a guide only and does not contain all components.
Listed within the table are the common payments and components.
BASIC, BRV, CEA, CES, CET, CLP,CPS, DRF, EAP, ESS, IALL, LON, LONA, OSEAS, PHA, RA,
AGE
RAA, SUPPL, PNSUP, TRSUP,NHE,EXO,EXV
ADD, BABP, BASIC, CEA, CES, CET, CLP,EM1, PHA, PHABP, RA, RAA, RAABP, RABP, GST,
ABY
SSL, SSS, RSC, AEP, ETP, SKB,CVS,NHE,EXO,EXV
BASIC, CEA, CES, CET, CLP,CPS, ESS, GST, PHA, RA, RAA, PNSUP, SSL,
AUS
SSS,CVS,NHE,EXO,EXV
BVA BASIC, CEA, CES, CET, CPS, ESS, OSEAS, PHA, RA, RAA, SUPPL, LON, PNSUP, TRSUP
CAR ACSP, BASIC, CEA, CES, CET,CLP, CPS, CSP, DVACA, DVACP, DVACS, ESS, OSEAS, PHA, RA,
RAA, SUPPL, LON, LONA, BRV, PNSUP, TRSUP, AEP, SKB,NHE,EXO,EXV
CDA ACSP, ADULT, CHILD, CLP,CSD, CSP, DVACA, DVACP, DVACS, ESA, ESB, ESC
CLS CLS
DAP DAP
DOP BASIC, BRV,CLP
BASIC, BRV, CDE, CEA, CES, CET,CLP, CPS, DRF, EAP, ESS, GCP, GST, IALL, LLN, LON,
DSP LONA OSEAS, PHA, RA, RAA, SUPPL, YDS, WFD, PNSUP, TRSUP, AEP, SKB, RJC,
NWE,NHE,EXO,EXV
ECP BASIC, CEA, CES, CET, PHA, RA, RAA
EMG BASIC
EPA EPA, AEP, ETP
EPE EPE
EPF EPF, AEP, ETP
ONN01, ONN02, ONN03, ONN04, ONN05, ONR01, ONR02, OTN01, OTN02, OTR01,
ERP
OTR02, ACCMP, ADLTP, BUSNP, CHLDP, FUELP, HSPLP, MEDLP
FFR BASIC
FHS BASIC, PHA, RA, RAA
FTB BASIC, BRV, FTBA, FTBB, FBSUP, SUPB, LFS, MUL, RA, AEP, ETP, SKB, CESA, CESB, FSUP,
SIFS, NBS, SPS
FSP BASIC, ADD01
INM MSPNT, MSPPB, MSPWA, VIPNT, VIPPB, VIPWA
BASIC, BRVLS, CES,CLP, CRI, EDEP, LLN, NWE, PBV, PHA, PII, RA, RAA, SUPPL, TA, TPNSP,
JSP
WFD, CVS, NHE, EXO, EXV
MEP EMEP
MOB BASIC
NMA BASIC, CPS, GST, PHA, RA, RAA
NSA BASIC, BRV, CDE, CEA, CES, CET, CPS, DRF, GCP, GST, LLN, PHA, RA, RAA, SUPPL, WFD,
TRS, NGJ, AEP, RJC, NWE, PII
PPL BASIC,CONT,SCAT
PPP ADDNL, BASIC, BEN, BRV, CDE, CEA, CES, CET, CLP,CPS, DRF, ESS, GCP, GST, PHA, RA,
RAA, WFD, EEP, EDEP, LLN, PNSUP, TRS, AEP, SKB, RJC, CVS, NHE, EXO, EXV
Version: 7.18
Page 101 of 102
PPS BASIC, CDE, CEA, CES, CET,CLP, CPS, DRF, EAP, ESS, GCP, OSEAS, PHA, RA, RAA, SUPPL,
YDS, WFD, CRI, EDEP, LLN, PNSUP, TRS, AEP, SKB, RJC, NWE, PII, CVS, NHE, EXO, EXV
BASIC, CEA, CET, CES, CPS, ESS, GST, PHA, RA, RAA, WFD, BRV, PNSUP, CVS NHE, EXO,
PTA
EXV
SKA BASIC, CEA, CES, CET, CPS, GST, PHA, RA, RAA, BRV, WFD, CVS NHE, EXO, EXV
SPL BASIC, BRV, CEA, CES, CET, CLP,CPS, DRF, ESS, GCP, GST, PHA, RA, RAA, WFD, PNSUP,
AEP, SKB, NWE, PII
TLA TILA
TAP TAP
BASIC, CEA, CES, CET, CPS, EM1, ESS, GST, PHA, RA, RAA, LLN, PNSUP, CVS NHE, EXO,
WDA
EXV
BASIC, CEA, CES, CET, CPS, CSD, CSP, DVACP, DVACS, ESS, OSEAS, PHA, RA, RAA, SUPPL,
WFA
BRV, PNSUP, TRSUP
BASIC, CEA, CES, CET, CPS, CSD, CSP, DVACP, DVACS, ESS, OSEAS, PHA, RA, RAA, SUPPL,
WFD
BRV, PNSUP, TRSUP
WID BASIC, CEA, CES, CET, CPS, ESS, OSEAS, PHA, RA, RAA, SUPPL, BRV, PNSUP, TRSUP
BASIC, CDE, CEA, CES, CET, CLP,CPS, DRF, GCP, GST, LLN, PHA, RA, RAA, TLB, WFD,
YAL (TRA), YDS, SSL, SSS, RSC, NGJ (only for YAL-JSK), AEP, ETP, SKB, RJC, NWE, PII, PBV, CVS,
NHE, EXO, EXV
Note: Customers who have shared care arrangements may not be receiving FTB due to shared
care percentage limit.
Version: 7.18
Page 102 of 102

CCeS Webservice Interface Spec V7.18

Uploaded by

Copyright:

Available Formats

You might also like

CCeS Webservice Interface Spec V7.18

Uploaded by

Document Information

Original Description:

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

CCeS Webservice Interface Spec V7.18

Uploaded by

Copyright:

Available Formats

Data Automation and Engineering Branch

Digital Business Solutions

Centrelink Confirmation eService

Version Number: 7.18

Path\File Name R:\NAT\DATAONLINE\ONLINESYS\Digital_Business_Solutions\CONF-Customer

For earlier Versions please refer to Word Pro spec

7.10 16/2/2021 Ed Craig Update tables at Appendix A, Appendix C and Appendix

4.4.6 Example Format .............................................................................................................. 40

1.1 Purpose of the document

1.2 Definitions, acronyms and abbreviations

ACF Access Control Facility

Business A user of the system outlined in this document

CCwS Centrelink Confirmation Web Service

CRN Centrelink Reference Number

DVA Department of Veterans’ Affairs

DSD Defence Signals Directorate

HTTPS Hyper Text Transport Protocol, Secure

SOAP Simple Object Access Protocol

SSL Secure Sockets Layer

WSDL Web Service Definition Language

2.1 CCwS Requirements, Objectives and Scope

2.2 System Availability

3.1 Design Overview

3.1.1 Successful Execution

Figure 1 Design Overview of CCwS Web Service

SOAP Request via HTTPS

SOAP Response via HTTPS

3.1.2 Failed Execution

Figure 2 Design Overview of CCwS Web Service

SOAP REQUEST via HTTPS

SOAP Standard Fault

Business Partner CCwS

3.2 Overall Security Solution

3.2.1 High Level Overview

Lightwe ight Se c urity

Figure 3 CCwS Web Services Security Architecture Overview

3.2.2 Key Elements

The key elements of this security solution are:

The key attributes of a Lightweight Security Token are:

3.2.3 Obtaining Security

3.3 Communication Protocol

2RC4 128bit with SHA

Operations are to be sent using an action of POST.

The URL for Web Service end Point is:

Request SOAP Action Standard. The request will be formatted as follows:

Response Standard. The response will be formatted as follows:

4. CCwS Operations Descriptions

4.1 Special XML Characters

Character Entity Replacement Characters

4.2 Verify Name Address

Verify Name Address Operation

Verify Name Address Request

Verify Name Address Response

Figure 4 Verify Name Address Operation Overview

4.2.3 Verify Name Address Request Structure

<inputRefId> Business partner's reference Up to 50 alphanumeric Optional

<crn> A valid CRN issued to a customer 9 consecutive numeric Mandatory