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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Versapay

Versapay Ecommerce API

The Versapay Ecommerce server-side API (v2.0.0, OpenAPI 3.0.0, 11 documented paths) that configures payment sessions, manages customer wallets (credit cards and bank accounts), creates and captures order sales and payments, checks gift-card balances, and validates Apple Pay merchants. It pairs with a client-side JavaScript SDK and a Versapay-hosted iframe so sensitive payment data never transits the merchant application, reducing PCI scope. Served from https://{subdomain}.versapay.com/api/v2.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

Tagged areas include E-Commerce, Payment Sessions, Wallets, and Hosted Checkout. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 13 operations across 11 paths, organized into 2 resource areas, and defines 66 schemas. It is described by OpenAPI 3.0.0, at version 2.0.0.

Requests are made against a single base URL, https://{subdomain}.versapay.com/api/v2.

13 operations 11 paths 66 schemas 2 DELETE2 GET3 PATCH6 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
2.0.0
Base URL
https://secure.versapay.com/api/v2
Contact
Versapay
Resource Areas
2

Paths & Operations 13

Across 11 paths, the API surfaces 13 operations — 2 DELETE, 2 GET, 3 PATCH, 6 POST. They span 2 resource areas: developers, internal. Each is listed below with its method, path, parameters, and response codes.

developers 7

Operations available to developers

POST
/sessions
create a session
createSession body → 201401
POST
/wallets
create a wallet for a known user
createWallet body → 201400
POST
/sessions/{id}/sales
process a sale
createSale 1 param body → 201400401402404
PATCH
/sessions/{id}/sales/{saleid}
update a sale
finalizeSale 2 params body → 202400404
POST
/sessions/{id}/sales/{saleid}/payments
process a payment
createPayment 2 params body → 201400401402404
GET
/sessions/{id}/balance/{giftcardid}
check the balance of a payment method fund token
getGiftCardBalance 2 params → 200404
POST
/sessions/{id}/applepay-validatemerchant
Validate Apple Pay merchant
1 param body → 200400404
internal 6

Operations intended only to the iframe front end

GET
/sessions/{id}
get a session
getSessionById 1 param → 200404
POST
/sessions/{id}/tokens
get a token
getToken 1 param body → 201400403404412500
PATCH
/sessions/{id}/wallet/{walletid}/creditcards/{creditcardid}
update a credit card wallet entry
updateWalletCreditCard 3 params body → 202400403404
DELETE
/sessions/{id}/wallet/{walletid}/creditcards/{creditcardid}
remove a credit card wallet entry
deleteWalletCreditCard 3 params → 202400403404
PATCH
/sessions/{id}/wallet/{walletid}/bankaccounts/{bankaccountid}
update a bank account wallet entry
updateWalletBankAccount 3 params body → 202400403404
DELETE
/sessions/{id}/wallet/{walletid}/bankaccounts/{bankaccountid}
remove a bank account wallet entry
deleteWalletBankAccount 3 params → 202400403404

Schemas 66

The contract defines 66 schemas that model the data the API accepts and returns. The most detailed are Sale (25 properties), SaleLine (12 properties), Address (11 properties), ApplePayMerchantValidationResponse (11 properties). Each schema is shown below with its type and property counts.

Error
object
Error
2 properties
PaymentError
object
Error
2 properties
SessionID
string
The session ID returned by a POST to /sessions
WalletID
string
The wallet ID returned by a POST to /wallets
OrderID
string
The order ID returned by a POST to /sessions/{id}/sales
SettlementToken
string
The token associated with the MID to use for settlement in Collaborative AR
FundToken
string
The token associated with a funding source
PaymentMethod
string
The payment type
AccountHolder
string
The name of the cardholder
CardAccountNumber
string
The card account number
CardExpirationMonth
integer
The expiration month, expressed as an integer from 1 (January) to 12 (December)
CardExpirationYear
integer
The expiration year, expressed as a 4-digit year
CardVerificationValue
string
The card verification value
PIN
string
The PIN
CardBrand
string
The card brand
BankAccountNumber
string
The demand deposit account number
BankRoutingNumber
string
The routing number of the financial institution
CheckType
string
The type of account (business or personal)
BankAccountType
string
The type of account (checking or savings)
AccountNumberLastFour
string
The last four digits of the account number
Currency
string
The uppercase 3-letter ISO currency code
RejectAddressMismatch
boolean
Set custom avs protection rule to reject or allow credit card transactions with an address mismatch
RejectPostCodeMismatch
boolean
Set custom avs protection rule to reject or allow credit card transactions with a postal code mismatch
RejectAVSUnknown
boolean
Set custom avs protection rule to reject or allow credit card transactions with a avs unknown
Sale
object
Order details
25 properties 6 required
SaleLine
object
A line item for an order
12 properties 4 required
Address
object
An Address
11 properties
Payments
array
The collection of payments
Payment
object
A Payment
5 properties 4 required
ApplePayPayment
object
Apple Pay payment details
2 properties 2 required
GatewayAuthorization
UnifiedAuthorization
object
Versapay authentication credentials
2 properties 2 required
SessionRequest
object
A new session request
2 properties 2 required
SimpleRequest
object
A simple request
1 property 1 required
SessionResponse
object
1 property 1 required
TokenResponse
object
A response containing a token
1 property 1 required
SaleResponse
object
A response containing order identification information
3 properties 2 required
WalletResponse
object
A response containing wallet information
1 property 1 required
PaymentResponse
object
A response containing payment details
8 properties 3 required
ApplePayMerchantValidationRequest
object
2 properties 2 required
ApplePayMerchantValidationResponse
object
11 properties 11 required
SessionOptionBase
object
An option for a specific session
3 properties
SessionOptionPost
SessionOptionGet
WalletOptionsBase
object
Options for wallet behavior
7 properties
WalletOptionsGet
PaymentTypes
array
CreditCardPaymentType
object
A credit card payment type definition
1 property
ACHPaymentType
object
A credit card payment type definition
1 property
GiftCardPaymentType
object
A credit card payment type definition
1 property
ApplePayPaymentType
object
A credit card payment type definition
1 property
PaymentType
object
A payment type or method
4 properties 2 required
ACH
object
Account information for an ACH transaction
6 properties 6 required
CreditCard
object
Account information for a credit card transaction
5 properties 3 required
GiftCard
object
Account information for a gift card transaction
4 properties 3 required
TokenRequest
object
A request for a new token for the provided payment method
3 properties 1 required
CreditCardTokens
array
A collection of credit card tokens
CreditCardToken
object
Token information for a credit card
7 properties 1 required
CreditCardTokenUpdate
object
Information for updating an existing credit card token
4 properties
BankAccountTokens
array
BankAccountToken
object
Token information for a bank acocunt
6 properties 1 required
BankAccountTokenUpdate
object
Information for updating an existing bank account token
1 property
FieldOptions
array
A collection of field options
FieldOption
object
Options for a single field
6 properties 2 required
AVSOption
object
Merchant defined AVS fraud protection settings
3 properties
Balance
object
Balance of payment method
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

versapay-ecommerce-api.json Raw ↑

Other APIs Versapay publishes across the network.

Versapay API Reference
AE Profile APIs.io
#E-Commerce#Payment Sessions#Wallets#Hosted Checkout
← Back to V APIs
API Details
ID
versapay:versapay-ecommerce-api
Base URL
https://secure.versapay.com/api/v2
Docs
https://developers.versapay.com/ecommerce/
Provider
Versapay
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=versapay-ecommerce-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/versapay-ecommerce-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

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