UpdateBearerExtended
Update the cardholder details.
This is an extended API to update additional details like address and employment details. Use UpdateBearer in case you only need to update details like name and contact details.
Request
Path parameters
string, 10 characters, required
The Paymentology issued terminal ID of the terminal requesting the transaction.
string, 1-20 characters, required
Profile number linked with this card.
string, 1-20 characters, required
The tracking number of the specified card.
string, 1-10 characters, required
The Title of the cardholder.
string, 1-15 characters, required
The Initials of the cardholder.
date, 1-20 characters, required
Birthday date of the cardholder, in the format yyyMMdd
string, 1-10 characters, required
The gender of the Cardholder
string, 1-20 characters, required
The card number, sequence number or tracking number of the specified card.
Permissible Values:
South African ID number – 1
Foreign ID number – 2
Foreign Passport number – 3
Enterprise Registration number – 4
Foreign Enterprise registration number – 5
ISIN number – 6
South African trust registration number – 7
Foreign trust registration number – 8
Internal identification number – 9
Temp Res Permit – 10
Temporary ID number – 11
RSA Passport – 12
Other – 13
Asylum Seeker Permit Number – 14
Work Permit Number – 15
Refugee Permit Number – 16
Birth Certificates – 17
Drivers License – 18
date, 1-20 characters, required
Date the ID was issued to the cardholder, in the format yyyyMMdd
date, 1-20 characters, required
Expiry date of the ID, in the format yyyyMMdd
string, 1-3 characters, required
The country the ID was issued in. The three digit country code as specified here.
integer, 2 digits, required
Indicator value for resident type of cardholder.
Permissible Values:
Resident – 01
Temporary Resident – 02
NON Resident – 03
integer, 2 digits, required
Numeric mapped value to indicate the type of employment of cardholder.
Permissible Values:
Not Employed – 01
Employed – 02
Self Employed – 03
Professional – 04
Retired – 05
Student – 07
Others – 08
Pensioned- 09
Temporary Employed – 10
Freelance – 11
integer, 2 digits, required
Numeric mapped value to indicate the home language of cardholder.
Permissible Values:
Afrikaans – 01
Ndebele – 02
North Sotho – 03
South Sotho – 04
Swazi – 05
Tsonga – 06
Tswana – 07
Venda – 08
Xhosa – 09
Zulu – 10
English – 11
Other – 12
Sepedi – 13
integer, 2 digits, required
The numeric value mapped against Estimated monthly turnover of the cardholder.
Permissible Values:
None – 01
Unknown – 02
R 0 to R 4,999 – 03
R 5,000 to R 9,999 – 04
R 10,000 to R 49,999 – 05
R 50,000 or more – 06
integer, 2 digits, required
The numeric value mapped against the expected source of funds of the cardholder.
Permissible Values:
Alimony – 01
Bonuses – 02
Child Support – 03
Commisions – 04
Dividend/Interest – 05
Pension – 06
Rental Income – 07
Salary – 08
Unknown – 09
Loan – 10
Donations – 11
None – 12
Business Activities – 13
Others – 14
integer, 2 digits, required
The numeric value mapped against the Estimated Cash transaction value of the cardholder.
Permissible Values:
None – 01
Unknown – 02
R 0 to R 4,999 – 03
R 5,000 to R 9,999 – 04
R 10,000 to R 49,999 – 05
R 50,000 or more – 06
integer, 2 digits, required
The numeric value mapped against the expected use of channel of the cardholder.
Permissible Values:
Suite – 01
ATM – 02
Cell Phone – 03
Internet/EFT – 04
Combination – 05
integer, 2 digits, required
The numeric value mapped against the expected foreign transaction value of the cardholder.
Permissible Values:
None – 01
Unknown – 02
R 0 to R 4,999 – 03
R 5,000 to R 9,999 – 04
R 10,000 to R 49,999 – 05
R 50,000 or more – 06
string, 1-10 characters, required
Nationality of the cardholder. The three digit country code as specified here.
integer, required
Numeric mapped value for the type of Industry the cardholder is employed in.
Industry IDs are present in the downloadable document below:
integer, 2 digits, required
The numeric value mapped against the high-level industry cardholder is involved in.
Permissible Values:
Agriculture, Hunting, Forestry and Fishing – 01
Mining and Quarrying – 02
Manufacturing – 03
Electricity, Gas and Water Supply – 04
Construction – 05
Wholesale and Retail Trade – 06
Transport, Storage and Communication – 07
Financial, Insurance, Real Estate and Business – 08
Community, Social and Personal – 09
Private Exterritorial Organisations – 10
string, 1-10 characters, required
Street number of the cardholder.
string, 1-100 characters, required
Street name of the cardholder.
string, 1-50 characters, required
City or Town name of the cardholder.
string, 1-20 characters, required
Province name of the cardholder.
string, 1-50 characters, required
Country name of the cardholder.
string, 1-9 characters, required
Postal code of the cardholder.
string, 1-50 characters, required
Suburb or Distriict name of the cardholder.
string, 1-255 characters, required
The numeric value mpped against residential status of the cardholder.
Permissible Values:
Owner – 01
Tenant – 02
Owned by spouse – 03
Living with parents – 04
string, 1-255 characters, required
Transaction ID number generated by the calling client.
date, required
Transaction date generated by the calling client.
string, required
HMAC-SHA1 hashed signature of the concatenated method name with all argument values using the terminal password as private key.
<?xml version="1.0"?>
<methodCall>
<methodName>UpdateBearerExtended</methodName>
<params>
<param>
<value>
<string>0988963840</string>
</value>
</param>
<param>
<value>
<string>5790094121</string>
</value>
</param>
<param>
<value>
<string>75163739087896</string>
</value>
</param>
<param>
<value>
<string>uTitle</string>
</value>
</param>
<param>
<value>
<string>uInitials</string>
</value>
</param>
<param>
<value>
<dateTime.iso8601>19991227T03:25:54</dateTime.iso8601>
</value>
</param>
<param>
<value>
<string>uGender</string>
</value>
</param>
<param>
<value>
<int>01</int>
</value>
</param>
<param>
<value>
<dateTime.iso8601>19991227T03:25:54</dateTime.iso8601>
</value>
</param>
<param>
<value>
<dateTime.iso8601>20351227T03:25:54</dateTime.iso8601>
</value>
</param>
<param>
<value>
<string>uty</string>
</value>
</param>
<param>
<value>
<int>22</int>
</value>
</param>
<param>
<value>
<int>00</int>
</value>
</param>
<param>
<value>
<int>01</int>
</value>
</param>
<param>
<value>
<int>02</int>
</value>
</param>
<param>
<value>
<int>03</int>
</value>
</param>
<param>
<value>
<int>04</int>
</value>
</param>
<param>
<value>
<int>05</int>
</value>
</param>
<param>
<value>
<int>06</int>
</value>
</param>
<param>
<value>
<string>uat</string>
</value>
</param>
<param>
<value>
<int>07</int>
</value>
</param>
<param>
<value>
<int>08</int>
</value>
</param>
<param>
<value>
<string>uStno</string>
</value>
</param>
<param>
<value>
<string>uStnam</string>
</value>
</param>
<param>
<value>
<string>uot</string>
</value>
</param>
<param>
<value>
<string>uProvince</string>
</value>
</param>
<param>
<value>
<string>uty</string>
</value>
</param>
<param>
<value>
<string>uCode</string>
</value>
</param>
<param>
<value>
<string>uSod</string>
</value>
</param>
<param>
<value>
<int>09</int>
</value>
</param>
<param>
<value>
<string>txnId</string>
</value>
</param>
<param>
<value>
<dateTime.iso8601>20240418T03:25:54</dateTime.iso8601>
</value>
</param>
<param>
<value>
<string>4A2EEAC72EC2BD539CADCA72E37044A899D16037AA91A9A12CCF315DBDB2DAE5</string>
</value>
</param>
</params>
</methodCall>
Response
STATUS200 OK
Schema
string
Echo of the incoming value.
(1-12 characters)
string
Echo of the incoming value.
(1-12 characters)
string
Echo of the incoming value.
(1-12 characters)
date
Transaction date generated by the calling client.
string
Transaction ID generated by Paymentology.
(1-255 characters)
integer
Status code indicating transaction result.
string
Text indicating transaction result.
<?xml version="1.0" encoding="UTF-8"?>
<methodResponse>
<params>
<param>
<value>
<struct>
<member>
<name>cardIdentifier</name>
<value>
<string>751622200000006</string>
</value>
</member>
<member>
<name>resultCode</name>
<value>
<int>1</int>
</value>
</member>
<member>
<name>terminalID</name>
<value>
<string>0058263840</string>
</value>
</member>
<member>
<name>profileNumber</name>
<value>
<string>5792074121</string>
</value>
</member>
<member>
<name>resultText</name>
<value>
<string>Approved</string>
</value>
</member>
<member>
<name>transactionDate</name>
<value>
<dateTime.iso8601>20240418T03:25:54</dateTime.iso8601>
</value>
</member>
<member>
<name>serverTransactionID</name>
<value>
<string>5792074121-4A2EEAC72EC2BD539CADCA72E37044A899D16037AA91A9A12CCF315DBDB2DAE5</string>
</value>
</member>
<member>
<name>transactionID</name>
<value>
<string>txnId</string>
</value>
</member>
</struct>
</value>
</param>
</params>
</methodResponse>