v1

latestOpenAPI 3.1.02026-07-24170121.2 MB

Login

Used to retrieve authorization information. All parameters can be found in the Payarc portal at https://dashboard.payarc.net/

post/Login

Headers

Acceptstring required

Indicates which content types, expressed as MIME types, the client is able to understand.

Content-Typestring required

Indicates the media type of the resource sent in the HTTP message body. <br /><br /><b>Possible Values:</b><br /> application/json<br />application/x-www-form-urlencoded

Request body

Emailstring required

Email used to sign into PayArc portal.<br><table style='width: 100%; border-collapse: collapse;'><tr><td style='text-align: center;'><b>Type</b></td><td style='text-align: center;'><b>Format</b></td></tr><tr><td>String</td><td>Alphanumeric</td></tr></table>

MIDstring required

Merchant ID, can be found in the Merchant Profile section.<br><table style='width: 100%; border-collapse: collapse;'><tr><td style='text-align: center;'><b>Type</b></td><td style='text-align: center;'><b>Format</b></td></tr><tr><td>Numeric</td><td>Numeric</td></tr></table>

ClientSecretstring required

Found in the API section.<br><table style='width: 100%; border-collapse: collapse;'><tr><td style='text-align: center;'><b>Type</b></td><td style='text-align: center;'><b>Format</b></td></tr><tr><td>String</td><td>Alphanumeric</td></tr></table>

SecretKeystring required

Found in the API section.<br><table style='width: 100%; border-collapse: collapse;'><tr><td style='text-align: center;'><b>Type</b></td><td style='text-align: center;'><b>Format</b></td></tr><tr><td>String</td><td>Alphanumeric</td></tr></table>

Response

200

ErrorCodeinteger
ErrorMessagestring

Example response

{
  "ErrorMessage": "string",
  "Terminals": [
    {
      "Object": "string",
      "Id": "string",
      "Terminal": "string",
      "Type": "string",
      "Code": "string",
      "Is_enabled": true,
      "Device_id": "string",
      "Pos_identifier": "string",
      "Created_at": "2024-01-18T14:14:27.571Z",
      "Updated_at": "2024-01-18T14:14:27.571Z"
    }
  ],
  "BearerTokenInfo": {
    "TokenType": "string",
    "AccessToken": "string",
    "RefreshToken": "string"
  }
}