MiPaymentChoice API: Authentication

General

The MiPaymentChoice ReST API authenticates Gateway user accounts that have the "API User" claim in their permission profile.

Routes

Route	Description
GET /authenticate?UserName={Username}&Password={Password}	Authenticate with username password as a GET.
POST /authenticate	Authenticate with username password as a POST.

Request Headers

Header	Value
Content-Type	application/json

Request Body

Used when using POST

{
  "Username": "string",
  "Password": "string",
}

Parameter Details

Property	Required	Data	Additional Information
Username	Yes	String
Password	Yes	String

Response Body

The BearerToken property will contain the JWT token that is used to authenticate further requests.

{
  "UserId": "string",
  "SessionId": "string",
  "UserName": "string",
  "DisplayName": "string",
  "ReferrerUrl": "string",
  "BearerToken": "string",
  "RefreshToken": "string",
  "ResponseStatus": {
    "ErrorCode": "string",
    "Message": "string",
    "StackTrace": "string",
    "Errors": [
      {
        "ErrorCode": "string",
        "FieldName": "string",
        "Message": "string",
        "Meta": {}
      }
    ]
  }
}

Notes

• By default, authentication tokens expire in 14 days
• User must be configured as an API User to successfully authenticate