POST
/
User
/
auth
/
{provider}
curl --request POST \
  --url https://api-sandbox.payabli.com/api/User/auth/{provider} \
  --header 'Content-Type: application/json' \
  --header 'requestToken: <api-key>' \
  --data '{
  "userTokenId": "<string>",
  "userId": 123,
  "email": "example@email.com",
  "psw": "<string>",
  "entry": "test",
  "entryType": 2
}'
{
  "responseText": "Success",
  "isSuccess": true,
  "responseData": "g**.com",
  "mfa": false,
  "mfaMode": "email",
  "mfaValidationCode": "50-2E-4A-16-93-0E-41-41-07-EE-22-B6-00-99-00-99"
}

Authorizations

requestToken
string
header
required

Most endpoints require an organization token. Some endpoints require an application token, and those endpoints are noted.

Path Parameters

provider
string
required

Auth provider. Optional By default is null for the built-in provider

Body

Input data to validate user
userTokenId
string | null
userId
integer | null
email
string | null

Email address.

Maximum length: 320
Example:

"example@email.com"

psw
string | null
entry
string | null

Identifier for entry point originating the request (used by front-end apps)

Example:

"test"

entryType
integer | null

Type of entry identifier: 0 - partner, 2 - paypoint
used by front-end apps, required if an Entry is indicated.

Example:

2

Response

200 - application/json
Success
responseText
string | null

Response text for operation: 'Success' or 'Declined'.

Example:

"Success"

isSuccess
boolean

Boolean indicating whether the operation was successful. A true value indicates success. A false value indicates failure.

Example:

true

responseData
string

Data returned by the response, masked for security.

Example:

"g**.com"

mfa
boolean | null

When true, multi-factor authentication (MFA) is enabled.

Example:

false

mfaMode
string

The mode of multi-factor authentication used.

Example:

"email"

mfaValidationCode
string

The validation code for multi-factor authentication, typically a hash or similar encrypted format.

Example:

"50-2E-4A-16-93-0E-41-41-07-EE-22-B6-00-99-00-99"