v1

latestOpenAPI 3.0.0ISC2026-07-249501.1 MB
Retail

Create simple login

Simple Login allows trusted users to proceed directly to the retail/MOTO iframe without entering a Nexio username and password. This option is useful for cases in which multiple users will be using a single Nexio account. It can also save time for internal users by eliminating the need to enter a username and password upon each use.

Use the key value from the response as a query parameter in the request to load Nexio's retail iframe. For additional information about using this endpoint, see the Using simple login for authentication tutorial.

<!-- theme: warning -->

⚠️ Try It

To use the Try It feature for this endpoint, you must use the credentials for your Sandbox API user that you want to use for transactions and other tasks with the retail iframe.

<div style="display:none;">

Response parameters

  • exp
  • jwt
  • key
  • refreshToken
  • username
</div>
post/auth/v3/createSimpleLogin

Response

Success

usernamestring

The simple login username.

expinteger

The date and time at which the Simple Login will expire, presented an a UNIX date (an integer representing seconds).

keystring

The simple login key. A key can only be used once and expires after one hour.

jwtstring

The JSON Web Token

refreshTokenstring

The refresh token

Example response

{
  "username": "api_user",
  "exp": 1704406645,
  "key": "4f211fde-d135-4c91-afbc-bcdb73c0c504",
  "jwt": "t3jraWQiOiI3V2JrOFdSVVliMVljR2p3Mlhwd2swR3lIRWt6THcwVDRqckVhNVVVTjBnPSIsImFsZyI6IlJTMjU2In0.eyJzdWIiOiI4YWYzZTQwZC02Y2I0LTQ0ZWQtOWRlZS0yN2Y3NmNmNDc0YmMiLCJlbWFpbF92ZXJpZ",
  "refreshToken": "t3jjdHkiOiJKV1QiLCJlbmMiOiJBMjU2R0NNIiwiYWxnIjoiUlNBLU9BRVAifQ.CejuLZHvZcrISuiwE7N4xg7EYq6ArivbyNwDVE2X7eTdr7CTO4l5udgc9ZUV1byTe1r3eLN_szbte1nlaimbQj5ZcJpim1zmW5pkk7aFVF"
}