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

Versapay Authentication API

Visit your account settings in `UAT` (https://uat.versapay.com/account) or `Production` (https://secure.versapay.com/account) to setup API credentials needed for authentication as well as webhooks to receive relevant callbacks from Versapay transaction processing.You can generate/disable your API credentials as often as necessary for security reasons.If you do not have an account, please contact Versapay Support for support & setup of AR invoicing integration, hosted checkout and/or payment acceptance for partner and/or API credential setup.## API Token and API KeyAPI requests are authenticated using `API Token & Key` via [HTTPS Basic Access Authentication](https://en.wikipedia.org/wiki/Basic_access_authentication). Security Scheme Type HTTPS HTTPS Authorization Scheme basic Simply provide the `API Token & Key` values as the `user` and `password` parameters, using cURL for instance:`curl -u "Nvax...:UN0I..." -X POST https://secure.versapay.com/api/...`## JWT TokenAlternatively, API requests can also be authenticated using `JWT Token` via [HTTPS Bearer Authentication](https://en.wikipedia.org/wiki/JSON_Web_Token). Security Scheme Type HTTPS HTTP Authorization Scheme bearer JWT `JWT Tokens`, automatically generated alongside `API Token & Key`, are displayed along with expiration in account settings as well as via authenticated `/api/whoami`, see `Authentication` _Echo identity and account profile settings_Simply provide the `JWT Token` in the authorization header, using cURL for instance:`curl -H "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ0b2tlbiI6Im54eDFaSjgzeXRNNmhtb3NGVExCIiwiZXhwIjoxNzEyOTU5NDA5fQ.adV6U1vW69Ypskt61uPL8hZ-4muvtM4FLM48QN6iCc4" -X POST https://secure.versapay.com/api/...`

Versapay Authentication API is one of 22 APIs that Versapay publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Authentication. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 1 operation across 1 path, and defines 7 schemas. It is described by OpenAPI 3.2.0, at version 1.3.35.

Requests are made against 2 base URLs: https://secure.versapay.com, https://uat.versapay.com.

1 operations 1 paths 7 schemas 1 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.3.35
Base URL
https://secure.versapay.com
License
Copyright 2022 Versapay. All Rights Reserved.
Terms of Service
Resource Areas
1

Paths & Operations 1

Across 1 path, the API surfaces 1 operation — 1 GET. Each is listed below with its method, path, parameters, and response codes.

Authentication 1

Visit your account settings in UAT (https://uat.versapay.com/account) or Production (https://secure.versapay.com/account) to setup API credentials needed for authentication as wel…

GET
/api/whoami
Echo identity and account profile settings
whoami 1 param → 200401

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are Whoami (28 properties), MerchantAccount (15 properties), BankProcessor (14 properties), GiftCardProcessor (11 properties). Each schema is shown below with its type and property counts.

BankProcessor
object
14 properties
TerminalProcessor
object
11 properties
Divisions
object
10 properties
DepositAccount
object
A deposit account
5 properties
Whoami
object
28 properties
MerchantAccount
object
15 properties
GiftCardProcessor
object
11 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

versapay-authentication-api-openapi.yml Raw ↑

Other APIs Versapay publishes across the network.

Versapay Agreements API
Versapay Autopay API
Versapay Card Present EMV API
Versapay Collaboration API
Versapay Customers API
Versapay Developers API
Versapay Divisions API
Versapay File Imports API
Versapay Fund Sources API
Versapay Gift Cards API
Versapay Internal API
Versapay Invoices API
Where this information came from

This is an independent, third-party profile of Versapay Authentication 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.