How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Payabli User API

The User API from Payabli — 10 operation(s) for user.

Payabli User API is one of 33 APIs that Payabli publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include User. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 12 operations across 10 paths, and defines 40 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.

Requests are made against 2 base URLs: https://api-sandbox.payabli.com/api, https://api.payabli.com/api.

12 operations 10 paths 40 schemas 1 DELETE2 GET6 POST3 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Base URL
https://api.payabli.com/api
Authentication
HTTP Bearer, API Key
Resource Areas
1

Authentication & Security 2

Payabli User API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (BearerAuth). An API key is passed in the header as requestToken (APIKeyAuth).

  • BearerAuth — OAuth2 Bearer access token from the client-credentials flow. See [OAuth authentication](/developers/oauth-authentication).
  • APIKeyAuth — Long-lived API token sent in the requestToken header. See [API token authentication](/developers/api-tokens).

Paths & Operations 12

Across 10 paths, the API surfaces 12 operations — 1 DELETE, 2 GET, 6 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

User 12
POST
/User
Add User to an Organization
AddUser 1 param body → 200400401500503
GET
/User/{userId}
Get User in an Organization
GetUser 4 params → 200400401500503
PUT
/User/{userId}
Modify User in an Organization
EditUser 2 params body → 200400401500503
DELETE
/User/{userId}
Delete User in an Organization
DeleteUser 2 params → 200400401500503
PUT
/User/mfa/{userId}
Enable/disable MFA for user in an organization
EditMfaUser 2 params body → 200400401500503
POST
/User/auth/{provider}
Authenticate User
AuthUser 2 params body → 200400401500503
POST
/User/authrefresh
Refresh token for User
AuthRefreshUser 1 param → 200400401500503
GET
/User/authlogout
Logout User
LogoutUser 1 param → 200400401500503
PUT
/User/authpsw
Update password for User
ChangePswUser 1 param body → 200400401500503
POST
/User/authreset
Reset password for User
AuthResetUser 1 param body → 200400401500503
POST
/User/mfa
Validate MFA for User in an Organization
ValidateMfaUser 1 param body → 200
POST
/User/resendmfa/{usrname}/{Entry}/{EntryType}
Resend MFA code
ResendMFACode 4 params → 200400401500503

Schemas 40

The contract defines 40 schemas that model the data the API accepts and returns. The most detailed are UserQueryRecord (17 properties), UserData (11 properties), UserAuthRequest (6 properties), PayabliApiResponseMfaBasic (6 properties). Each schema is shown below with its type and property counts.

UserAuthRequest
object
6 properties
Orgid
integer
Organization ID. Unique identifier assigned to an org by Payabli.
NameUser
string
LogoutUserResponse
object
2 properties 1 required
ChangePswUserResponse
object
2 properties 1 required
UserAuthPswResetRequest
object
1 property
PayabliApiResponseMfaBasic
object
6 properties 1 required
OrgScope
object
2 properties
Language
string
The language code.
AdditionalData
object
Custom dictionary of key:value pairs. You can use this field to store any data related to the object or for your system. If you are using [custom identifiers](…
AddUserResponse
object
3 properties 1 required
AuthResetUserResponse
object
2 properties 1 required
ResponseText
string
Response text for operation: 'Success' or 'Declined'.
PayabliErrorBody
object
Shape returned by every Payabli API error response. The responseData object carries human-readable error context.
4 properties 2 required
PayabliApiResponse
object
3 properties 1 required
MfaMode
integer
PayabliErrorBodyResponseData
object
Object with detailed error context.
2 properties
MfaValidationData
object
2 properties
Email
string
Email address.
PhoneNumber
string
Phone number.
DeleteUserResponse
object
1 property 1 required
UserQueryRecord
object
17 properties
PayabliApiResponseUserMfa
object
5 properties 1 required
AdditionalDataString
string
Custom dictionary of key:value pairs. You can use this field to store any data related to the object or for your system. Example usage: json { "additionalData"…
EditMfaUserResponse
object
2 properties 1 required
Responsedatanonobject
The response data.
UserData
object
11 properties
Timezone
integer
Timezone, in UTC offset. For example, -5 is Eastern time.
UsrAccess
object
2 properties
Orgentryname
string
The entryname for the org, in string format. If you leave this blank, Payabli uses the DBA name.
IsSuccess
boolean
Boolean indicating whether the operation was successful. A true value indicates success. A false value indicates failure.
Mfa
boolean
When true, multi-factor authentication (MFA) is enabled.
MfaValidationCode
string
The validation code for multi-factor authentication, typically a hash or similar encrypted format.
UserAuthResetRequest
object
3 properties
Orgtype
integer
The organization type. Currently, this must be 0.
MfaData
object
2 properties
Responsedata
object
The object containing the response data.
OrgXScope
object
3 properties
CreatedAt
string
Timestamp of when record was created, in UTC.
UsrStatus
integer
The user's status: - Inactive: 0 - Active: 1 - Deleted: -99 - Locked: 85

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

payabli-user-api-openapi.yml Raw ↑

Other APIs Payabli publishes across the network.

Payabli Bill API
Payabli Boarding API
Payabli chargeBacks API
Payabli checkCapture API
Payabli Cloud API
Payabli Customer API
Payabli Export API
Payabli Funding API
Payabli ghostCard API
Payabli hostedPaymentPages API
Payabli Import API
Payabli Invoice API
Where this information came from

This is an independent, third-party profile of Payabli User API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.