POST
/
auth
/
login
cURL
curl --request POST \
  --url https://api.myxspend.com/v1/auth/login \
  --header 'Content-Type: application/json' \
  --data '{
  "email": "<string>",
  "password": "<string>"
}'
{
  "email": "<string>",
  "accountId": "<string>",
  "roles": [
    "<string>"
  ],
  "token": "<string>",
  "redirectPath": "<string>"
}

Body

application/json

Get your details to use for future Process Payments. Note, your API Key (X-API-KEY) and Company Id (X-COMPANY-ID) are returned within the response headers

email
string
required

Email address used to login

password
string
required

Password used to login

Response

Successful response

email
string

Email address of logged in user

accountId
string

Account Id (not to be confused with Company Id)

roles
string[]

Array of roles assigned to the user

token
string

Bearer token

redirectPath
string

Path to redirect after login