Operation startRegister starts registering of new user.
Example SOAP request:
<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/" xmlns:ns1="ns1">
<soapenv:Header/>
<soapenv:Body>
<ns1:startRegister soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
<billonUserName xsi:type="xsd:string">login</billonUserName>
<billonUserPassword xsi:type="xsd:string">haslo</billonUserPassword>
<userIPEchoice xsi:type="xsd:string">PLUS_BANK_PRODUCTION</userIPEchoice>
<userARchoice xsi:type="xsd:string">PLUS_BANK_PRODUCTION</userARchoice>
<recoveryEmail1 xsi:type="xsd:string">recovery_mail@billon.info</recoveryEmail1>
<recoveryEmail2 xsi:type="xsd:string">recovery_mail@billon.info</recoveryEmail2>
</ns1:startRegister>
</soapenv:Body>
</soapenv:Envelope>
Example SOAP response:
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:ns1="ns1">
<SOAP-ENV:Header/>
<SOAP-ENV:Body SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
<ns1:startRegisterResponse>
<return xsi:type="ns1:vuiSoapTaskIdResponse">
<requestStatus>SUCCESS</requestStatus>
<requestStatusDescription>Request succeeded.</requestStatusDescription>
<taskId>7W3A0N1N9I2E8N1TKLS56A9PTR</taskId>
</return>
</ns1:startRegisterResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
Request parameters:
| parameter | type | description |
|---|---|---|
| billonUserName | string | loginname of registered user, note it must have more than 3 characters |
| merchantData | merchantData | merchant data (if we want to register user as merchant), if user does not have to be merchant, field should left empty |
| recoveryEmail | string | email address for password recovery |
| userARchoice | string | chosen AR (clearing agent ‘PLUS_BANK_PRODUCTION’) |
| billonUserPassword | string | user password, it must have more than 3 characters |
| userIPEchoice | string | chosen IPE (issuing bank ‘PLUS_BANK_PRODUCTION’) |
Response parameters:
| name | type | description |
|---|---|---|
| taskId | string | id of created task |
| requestStatus | string | result of request |
| requestStatusDescription | string | status description |
Possible errors:
| error | description |
|---|---|
| ERR_USERNAME_ALREADY_EXISTS | |
| ERR_INVALID_IPE_SPECIFIED | |
| ERR_INVALID_AR_SPECIFIED | |
| ERR_INVALID_USERNAME | |
| ERR_INVALID_PASSWORD | |
| ERR_NO_PERMISSION | |
| ERR_USER_LOGGED_IN | |
| ERR_VUI_LOGGING_IN_OR_REGISTERING | |
| ERR_REGISTERING |