Authentication

Methods related to authentication

Authenticate

POST /ICardProcess/Authenticate

Authenticates the user. The method returns a session key that is used on subsequent method calls, the account details, and a list of merchants associated with the account.

You will need to reauthenticate when one of the following two errors occur:

• 5030: Expired Session Key (session key has expired after 25 hours)

• 5050: Unauthorized Session Key (your IP has changed since you last authenticated)

The system will lock your IP out if you send 6 unsuccessful authentication attempts in a row. Always abort unsuccessful authentication attempts instead of retrying and notify the user. Only the Number support team can remove the lock from a merchant.

Request body

AccountCode string

The AccountCode is a unique key which represents a Number account. This code will never change throughout the life of your account. Each AccountCode is 2 letters and 7 numbers. You can also use this code when communicating with Number support team.

Example: EP911XXXX

---

Token string

The Token is a 32-characater hexadecimal string generated from the Client Admin Portal which acts as a password when authenticating to our APIs. A newly generated Token will be good for 2 years. Keep your tokens stored safely and securely, and do not email them without extra layers of security.

Example: 2148B239CF6846BDA5D141BF4A4CFBE8

Response body

FunctionOk boolean

Indicates if the function executed correctly.

---

RespMsg string

Friendly response message for the user.

---

ErrMsg string

Error message. Empty or null if no error.

---

ErrCode int

Error code. 0 indicates success.

---

SessKey string

A unique session key used for authentication in API calls. This key is generated upon successful authentication and must be included in all subsequent requests.

Example: B9F24903C3BA4770AE303032303541303032353437

---

ThisUser api_AuthUser (object)

An object describing the user account.

Fields: ID< AccountCode, AcctID, APILocationID, ExpirationDate, DateCreated, DateModified, CreatedBy, IsExpired, IsLockedOut, Alias, Description, TokenDescription

---

MerchantList List<api_MerchantInfo> (array<object>)

An array with basic information about all of the merchants visible to the logged-in user.

Fields: ID, Descrip, TermID, Location, Address

Sample response

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
                  xmlns:ns="http://example.com/soapapi">
   <soapenv:Header/>
   <soapenv:Body>
      <ns:api_AuthResponse>
         <ns:FunctionOk>true</ns:FunctionOk>
         <ns:AuthSuccess>true</ns:AuthSuccess>
         <ns:RespMsg>SessKey Expires|4/18/2019 7:29:47 AM</ns:RespMsg>
         <ns:ErrMsg></ns:ErrMsg>
         <ns:ErrCode>0</ns:ErrCode>
         <ns:SessKey>B9F24903C3BA4770AE303032303541303032353437</ns:SessKey>
         <ns:ThisUser>
            <ns:ID>2547</ns:ID>
            <ns:AccountCode>EP9116875</ns:AccountCode>
            <ns:AcctID>205</ns:AcctID>
            <ns:APILocationID>2210</ns:APILocationID>
            <ns:ExpirationDate>2019-09-11T16:12:00-04:00</ns:ExpirationDate>
            <ns:DateCreated>2019-03-11T12:32:00-04:00</ns:DateCreated>
            <ns:DateModified>2019-03-11T12:32:00-04:00</ns:DateModified>
            <ns:CreatedBy>ADMIN : vidya Venkatraman</ns:CreatedBy>
            <ns:IsExpired>false</ns:IsExpired>
            <ns:IsLockedOut>false</ns:IsLockedOut>
            <ns:Alias>vidya_Venkatraman</ns:Alias>
            <ns:Description>EP DEV ACCT</ns:Description>
            <ns:TokenDescription>EP DEV ACCT</ns:TokenDescription>
         </ns:ThisUser>
         <ns:MerchantList>
            <ns:MerchantInfo>
               <ns:ID>1</ns:ID>
               <ns:Descrip>Test Merchant 1</ns:Descrip>
               <ns:TermID>006</ns:TermID>
               <ns:Location>Test Merchant 1</ns:Location>
               <ns:Address>45 spring street portland Maine 04101</ns:Address>
            </ns:MerchantInfo>
            <ns:MerchantInfo>
               <ns:ID>2</ns:ID>
               <ns:Descrip>Lodging Merch</ns:Descrip>
               <ns:TermID>033</ns:TermID>
               <ns:Location>Lodging Merch</ns:Location>
               <ns:Address>78 spring street portland Maine 04101</ns:Address>
            </ns:MerchantInfo>
         </ns:MerchantList>
      </ns:api_AuthResponse>
   </soapenv:Body>
</soapenv:Envelope>