1. Home
  2. Corporate Node
  3. SOAP requests
  4. startRegister

startRegister

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:

parametertypedescription
billonUserNamestringloginname of registered user, note it must have more than 3 characters
merchantDatamerchantDatamerchant data (if we want to register user as merchant), if user does not have to be merchant, field should left empty
recoveryEmailstringemail address for password recovery
userARchoicestringchosen AR (clearing agent ‘PLUS_BANK_PRODUCTION’)
billonUserPasswordstringuser password, it must have more than 3 characters
userIPEchoicestringchosen IPE (issuing bank ‘PLUS_BANK_PRODUCTION’)

 

Response parameters:

nametypedescription
taskIdstringid of created task
requestStatusstringresult of request
requestStatusDescriptionstringstatus description

 

Possible errors:

errordescription
ERR_USERNAME_ALREADY_EXISTSuser with such login already exists
ERR_INVALID_IPE_SPECIFIEDinvalid IPE (issuing bank)
ERR_INVALID_AR_SPECIFIEDinvalid AR (clearing agent)
ERR_INVALID_USERNAMEinvalid username
ERR_INVALID_PASSWORDinvalid password
ERR_NO_PERMISSIONaccess denied
ERR_USER_LOGGED_INuser is already logged in
ERR_VUI_LOGGING_IN_OR_REGISTERINGWUI is logging or registering user, please wait
ERR_REGISTERINGWUI is registring user, please wait
Was this article helpful to you? Yes No

How can we help?