Organizer Authentication
Organizers are authenticated using this method. A successful call will return a token, which will need to be added to the header for subsequent calls.
Method Info
Url | https://www.payit2.com/api/v1/organizer/authenticate |
---|---|
Verb | POST |
Headers | X-PayItSquare-AppKey |
Input
Property | Data Type | Validation Info |
---|---|---|
UserName | String | Required |
Password | String | Required |
Output
Property | Data Type | Other Info |
---|---|---|
Token | String | This value is used as the X-PayItSquare-Token in subsequent calls |
IsSuccess | Boolean | Indicates if the call was successful or not. |
Messages | String Array | Will contain a list of error messages if IsSuccess is false |
Sample Input
{ "UserName": "MyUser", "Password": "MyPassword" }
Sample Success Response
{ "Token": "MyAuthToken", "IsSuccess": true, "Messages": [] }
Sample Error Response
{ "Token": null, "IsSuccess": false, "Messages": [ "Error Message 1", "Error Message 2" ] }