POST api/OTPAuthentication/CreateOTP

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
NotificationType	string	None.
EmailAddress	string	None.
EmailAddressId	string	None.
MobileNumber	string	None.
MobileNumberId	string	None.
OTPLength	integer	None.
OTPTimeLimit	integer	None.
AttemptThreshold	integer	None.
MerchantNumber	integer	None.
AccountNumber	string	None.
ApplicationId	integer	None.
CardNumber	integer	None.
MerchantReferenceNumber	string	None.
RequestAgentType	string	None.
RequestAgent	string	None.
Username	string	None.
Password	string	None.

Request Formats

application/json, text/json

Sample:

{
  "NotificationType": "sample string 1",
  "EmailAddress": "sample string 2",
  "EmailAddressId": "sample string 3",
  "MobileNumber": "sample string 4",
  "MobileNumberId": "sample string 5",
  "OTPLength": 1,
  "OTPTimeLimit": 1,
  "AttemptThreshold": 1,
  "MerchantNumber": 6,
  "AccountNumber": "sample string 7",
  "ApplicationId": 1,
  "CardNumber": 1,
  "MerchantReferenceNumber": "sample string 8",
  "RequestAgentType": "sample string 9",
  "RequestAgent": "sample string 10",
  "Username": "sample string 11",
  "Password": "sample string 12"
}

application/xml, text/xml

Sample:

<CreateOTPRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ApproveMeWebApi.Models.OTPModels">
  <MerchantNumber xmlns="http://schemas.datacontract.org/2004/07/ApproveMeWebApi.Models">0</MerchantNumber>
  <Password xmlns="http://schemas.datacontract.org/2004/07/ApproveMeWebApi.Models">sample string 12</Password>
  <RequestAgent xmlns="http://schemas.datacontract.org/2004/07/ApproveMeWebApi.Models">sample string 10</RequestAgent>
  <RequestAgentType xmlns="http://schemas.datacontract.org/2004/07/ApproveMeWebApi.Models">sample string 9</RequestAgentType>
  <Username xmlns="http://schemas.datacontract.org/2004/07/ApproveMeWebApi.Models">sample string 11</Username>
  <AccountNumber xmlns="http://schemas.datacontract.org/2004/07/ApproveMeWebApi.Models">sample string 7</AccountNumber>
  <ApplicationId xmlns="http://schemas.datacontract.org/2004/07/ApproveMeWebApi.Models">1</ApplicationId>
  <CardNumber xmlns="http://schemas.datacontract.org/2004/07/ApproveMeWebApi.Models">1</CardNumber>
  <MerchantNumber xmlns="http://schemas.datacontract.org/2004/07/ApproveMeWebApi.Models">6</MerchantNumber>
  <MerchantReferenceNumber xmlns="http://schemas.datacontract.org/2004/07/ApproveMeWebApi.Models">sample string 8</MerchantReferenceNumber>
  <AttemptThreshold>1</AttemptThreshold>
  <EmailAddress>sample string 2</EmailAddress>
  <EmailAddressId>sample string 3</EmailAddressId>
  <MobileNumber>sample string 4</MobileNumber>
  <MobileNumberId>sample string 5</MobileNumberId>
  <NotificationType>sample string 1</NotificationType>
  <OTPLength>1</OTPLength>
  <OTPTimeLimit>1</OTPTimeLimit>
</CreateOTPRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

CreateOTPResponse

Name	Type	Additional information
AccountNumber	string	None.
ApplicationId	integer	None.
CardNumber	integer	None.
MerchantReferenceNumber	string	None.
Status	string	None.
OTPGUIDReference	string	None.
Messages	Collection of string	None.

Response Formats

application/json, text/json

Sample:

{
  "AccountNumber": "sample string 1",
  "ApplicationId": 1,
  "CardNumber": 1,
  "MerchantReferenceNumber": "sample string 2",
  "Status": "sample string 3",
  "OTPGUIDReference": "sample string 4",
  "Messages": [
    "sample string 1",
    "sample string 2"
  ]
}

application/xml, text/xml

Sample:

<CreateOTPResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ApproveMeWebApi.Models.OTPModels">
  <AccountNumber>sample string 1</AccountNumber>
  <ApplicationId>1</ApplicationId>
  <CardNumber>1</CardNumber>
  <MerchantReferenceNumber>sample string 2</MerchantReferenceNumber>
  <Messages xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Messages>
  <OTPGUIDReference>sample string 4</OTPGUIDReference>
  <Status>sample string 3</Status>
</CreateOTPResponse>