mohdnazrul / laravel-ctos-kyc
Library to pull reports from CTOS KYC System
Installs: 5 677
Dependents: 0
Suggesters: 0
Security: 0
Stars: 0
Watchers: 3
Forks: 0
Open Issues: 0
Requires
- guzzlehttp/guzzle: ^6.3
Requires (Dev)
- illuminate/support: 5.4.*
- phpunit/phpunit: ^7.0.2
README
This Library allows to query the CTOS - B2B API for registered users.
You need the access details that were provided to you to make any calls to the API. For exact parameters in the data array/XML, refer to your offline documentation.
If you do not know what all this is about, then you probably do not need or want this library.
Configuration
.env file
Configuration via the .env file currently allows the following variables to be set:
- CTOS_KYC_URL='http://api.endpoint/url/'
- CTOS_KYC_USERNAME=demouser
- CTOS_KYC_PASSWORD=demoPassword
Available functions
CTOSV2::generateXMLFromArray($data, $XMLEscape = true);
This function takes an array of options for the CTOS API and generates the XML code that can be submitted via the API Call. XMLEscape auto set true because data return generete XML must be in html special chars in 'UTF-8'. Example:
// This is for Company Format [ 'company_code' => 'XXXXXX', // Required 'account_no' => 'AAAAAA', // Required 'user_id' => 'AAAAAA', // Required 'records' => [ 'type' => 'C', // Required and type is C for Company 'name' => 'COMPANY_NAME', 'ic_lc' => 'COMPANY_REGISTRATION_NO', // Conditional if type is individual (old IC), if type is Company is registration no 'nic_br' => '', // Conditional if type is individual 'country>' => 'MALAYSIA' // Required ], ] // This is for Individual Format [ 'company_code' => 'XXXXXX', // Required 'account_no' => 'AAAAAA', // Required 'user_id' => 'AAAAAA', // Required 'records' => [ 'type' => 'I', // Required and type is I for Individual 'name' => 'INDIVIDUAL NAME', 'ic_lc' => '', // Conditional if type is individual (old IC), if type is Company is registration no 'nic_br' => 'PASSPORT NO/NICR', // Conditional if type is individual 'country>' => 'MALAYSIA' // Required ], ] // This is for Business Format [ 'company_code' => 'XXXXXX', // Required 'account_no' => 'AAAAAA', // Required 'user_id' => 'AAAAAA', // Required 'records' => [ 'type' => 'B', // Required and type is B for Individual 'name' => 'BUSINESS NAME', 'ic_lc' => 'BUSINESS_REGISTRATION_NO', // Conditional if type is individual (old IC), if type is business is business no 'nic_br' => '', // Conditional if type is individual 'country>' => 'MALAYSIA' // Required ], ]
will generate // This is for Company Format
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ws="http://ws.proxy.xml.ctos.com.my/"> <soapenv:Header/> <soapenv:Body> <ws:request> <!--Optional:--> <input> <batch output="0" no="1234" xmlns="http://ws.cmctos.com.my/ctosnet/kyc"> <company_code>XXXXXX</company_code> <account_no>AAAAAA</account_no> <user_id>AAAAAA</user_id> <records> <type>C</type> <name>COMPANY_NAME</name> <ic_lc>COMPANY_REGISTRATION_NO</ic_lc> <nic_br/> <country/> </records> </batch> </input> </ws:request> </soapenv:Body> </soapenv:Envelope>
// This is for Individual Format
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ws="http://ws.proxy.xml.ctos.com.my/"> <soapenv:Header/> <soapenv:Body> <ws:request> <!--Optional:--> <input> <batch output="0" no="1234" xmlns="http://ws.cmctos.com.my/ctosnet/kyc"> <company_code>XXXXXX</company_code> <account_no>AAAAAA</account_no> <user_id>AAAAAA</user_id> <records> <type>C</type> <name>INDIVIDUAL NAME</name> <ic_lc/> <nic_br>NRIC</nic_br> <country/> </records> </batch> </input> </ws:request> </soapenv:Body> </soapenv:Envelope>
// This is for Business Format
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ws="http://ws.proxy.xml.ctos.com.my/"> <soapenv:Header/> <soapenv:Body> <ws:request> <!--Optional:--> <input> <batch output="0" no="1234" xmlns="http://ws.cmctos.com.my/ctosnet/kyc"> <company_code>XXXXXX</company_code> <account_no>AAAAAA</account_no> <user_id>AAAAAA</user_id> <records> <type>C</type> <name>BUSINESS NAME</name> <ic_lc>BUSINESS REGISTRATION NO</ic_lc> <nic_br/> <country/> </records> </batch> </input> </ws:request> </soapenv:Body> </soapenv:Envelope>
FOR LARAVEL SETUP CONFIGURATION:-
- Do composer require mohdnazrul/laravel-ctos-kyc
composer require mohdnazrul/laravel-ctos-kyc
- Add this syntax inside config/app.php
.... 'providers'=> [ . MohdNazrul\CTOSKYCLaravel\CTOSKYCServiceProvider::class, . ], 'aliases' => [ . 'CTOSKYC' => MohdNazrul\CTOSKYCLaravel\CTOSKYCApiFacade::class, ' ],
- Do publish as below
php artisan vendor:publish --tag=ctoskyc
- You can edit the default configuration CTOS KYC inside config/ctoskyc.php based your account as below
return [ 'serviceUrl' => env('CTOS_KYC_URL','http://localhost'), 'username' => env('CTOS_KYC_USERNAME','username'), 'password' => env('CTOS_KYC_PASSWORD','password') ];