usrAuth (V6)

Description

The usrAuth request will be used in order to authenticate user credentials.

URL: https://secure1.sandbox.directpay.online/API/v6/

Response

The method will response with the result of your request


Variables to send:

Parameter

Data type

Description


 Request

 Text

 usrAuth

Mandatory

Username

Text

Username

Mandatory

Password

Text

Password

Mandatory

CompanyCode

Text

User company code

Mandatory

Request example:


request example
<?xml version="1.0" encoding="utf-8" ?>
<API3G>
   <Request>usrAuth</Request>
   <Username>DPOTEST</Username>
   <Password>a123456</Password>
   <CompanyCode>TestMerchant</CompanyCode>
</API3G>


Respond:

The server will respond for the usrAuth request according to the following results:

Parameter

Data type

Description

UsrToken

Token

User unique token

CompanyToken

Token

Merchant unique token

CompanyEmailTextMerchant main email address
UsrAllowCashBooleanDefine id user can operate cash

Respond example:


response example
<?xml version="1.0" encoding="utf-8"?>
<API3G>
    <UsrToken>0945D11C-2661-4144-ACC2-656E936DFSAE</UsrToken>
    <CompanyToken>4E003B15-6E43-4682-B46B-B41F6B7MAJTO</CompanyToken>
    <CompanyEmail>support@directpay.online</CompanyEmail>
    <UsrAllowCash>1</UsrAllowCash>
</API3G>