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 API Reference

The core Versapay platform REST API (v1.3.35, OpenAPI 3.0.0, 86 documented paths) covering the Collaborative AR and payment-acceptance surface: onboarding applications, wallets, orders and order transactions, gift cards, card-present EMV, reference data, settlement reporting, autopay, customers, invoices and invoicing payments, divisions, notifications, collaboration, file imports, and webhooks. Authenticated with HTTPS Basic access authentication (API Token and Key) against a UAT sandbox and production.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

Tagged areas include Accounts Receivable, Payment Acceptance, Invoicing, Card Present, and Webhook. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 93 operations across 86 paths, organized into 20 resource areas, and defines 137 schemas. It is described by OpenAPI 3.0.0, at version 1.3.35.

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

93 operations 86 paths 137 schemas 2 DELETE50 GET2 PATCH38 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1.3.35
Base URL
https://secure.versapay.com
Contact
Versapay Support
License
Copyright 2022 Versapay. All Rights Reserved.
Terms of Service
View terms
Resource Areas
20

Paths & Operations 93

Across 86 paths, the API surfaces 93 operations — 2 DELETE, 50 GET, 2 PATCH, 38 POST, 1 PUT. They span 20 resource areas, including Authentication, Onboarding, Orders, Reference Data, Wallets, Order Transactions, Card Present EMV, Gift Cards, and 12 more. 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
Onboarding 5

Onboarding supports the automated process of applying for merchant services. Contact support@versapay.com for support & setup of supplier onboarding partner credentials.

GET
/api/onboarding/v1/terms
Retrieves rates and terms for merchant services
getTerms 1 param → 200400
POST
/api/onboarding/v1/applications
Create a new application
addApplication body → 201400409
GET
/api/onboarding/v1/applications/{id}
Get application status
getApplicationStatus 1 param → 200404
GET
/api/onboarding/v1/applications/search/{id}
Find the application token of an existing application
getApplicationToken 1 param → 200404
POST
/api/onboarding/v1/application_steps
Record a Completed Step of a Merchant Application
addApplicationSteps body → 201400401
Orders 5

The Order entity represents the sales document in the ERP system. The fields in the ERP system should be aligned as closely as possible with the fields in the order entity, as the…

POST
/api/imports/order
Create an order
createOrder body → 201401412
PATCH
/api/imports/order
Update an order
updateOrder body → 201401412
GET
/api/exports/orders
Export Orders
2 params → 200401
GET
/api/exports/orders/published
Export Orders Published
3 params → 200401
GET
/api/exports/order/{identifier}
Export/View an Order
1 param → 200401
Reference Data 4

For convenience purposes only, Versapay can supply third party reference data to its partners and users. This data can be used to implement client-side tooling (e.g., fraud mitiga…

GET
/api/reference_data/v1/response_codes
Retrieve list of supported error response codes
→ 200
GET
/api/reference_data/v1/country_codes
Retrieve list of countries and mapped provinces
→ 200
GET
/api/reference_data/v1/bin
Get Bank Identification Number (BIN) reference data
→ 200401
GET
/api/reference_data/v1/bin/{bin}
Get Bank Identification Number (BIN) reference data
1 param → 200401
Wallets 8

The Wallet entity holds vaulted & secured payment methods owned by a customer (buyer/payor) that can be used to make payments via Collaborative AR (online Portals, AutoPay, Pay No…

GET
/api/gateway/v1/wallets/search
Search Accessible Wallets
2 params → 200401
POST
/api/gateway/v1/wallets
Create Wallet Empty/Payment Method
body → 200412
GET
/api/gateway/v1/wallets/{wallet_token}
View Wallet
1 param → 200412
POST
/api/gateway/v1/wallets/{wallet_token}/methods
Add Payment Methods to Known Wallet
1 param body → 200412
PATCH
/api/gateway/v1/wallets/{wallet_token}/methods/{fund_token}
Update Payment Method in Wallet
2 params body → 200412
DELETE
/api/gateway/v1/wallets/{wallet_token}/methods/{fund_token}
Remove Payment Method From Wallet
2 params → 200412
GET
/api/exports/wallets
Export Wallets
2 params → 200401
GET
/api/exports/wallets/recent
Export Wallets Recently Updated
2 params → 200
Order Transactions 8

Order-based card/ACH and card present EMV payment transactions include verify, authorize, capture, sale, void, return refund, and return credit transaction types. If participating…

POST
/api/gateway/v1/orders/verify
Verify transaction
body → 200500
POST
/api/gateway/v1/orders/sale
Sale/Purchase transaction
body → 200500
POST
/api/gateway/v1/orders/credit
Return Credit transaction (unlinked return/refund)
body → 200500
POST
/api/gateway/v1/orders/auth
Authorization transaction
body → 200500
POST
/api/gateway/v1/orders/capture
Capture transaction
body → 200500
POST
/api/gateway/v1/orders/refund
Return refund transaction (linked return/refund)
body → 200500
POST
/api/gateway/v1/orders/void
Void transaction (linked return/refund)
body → 200500
GET
/api/exports/transaction/{token_or_reference}
Export/View a Transaction
1 param → 200401404
Card Present EMV 1

Card Present EMV payment transactions require a Versapay certified point-of-sale terminal. Contact support@versapay.com for support & setup for POS/CP EMV enablement.

POST
/api/gateway/v1/terminal
Issue a direct command to a POS terminal e.g. DeviceSetup, RequestSignature, Cancel, DeviceStatus
body → 200500
Gift Cards 2

Provisioned gift cards can be activated/enabled (or deactivated/disabled) as well as have their balances loaded/re-loaded with an amount. Contact support@versapay.com for support…

POST
/api/gateway/v1/gift_card
Activate and/or load a gift card balance
body → 200500
POST
/api/gateway/v1/gift_card/read
Read a gift card balance
body → 200500
Fund Sources 2
GET
/api/funds
View Your Fund Sources
→ 200401
POST
/api/vault/bank
Vault a Bank Account
body → 201401412
Transactions 5
POST
/api/transactions
Create Transactions
body → 201401412
GET
/api/transactions
View Transactions
1 param → 200401
GET
/api/transactions/{token_or_unique_reference}
View a Transaction
1 param → 200401
POST
/api/transactions/{token}/approve
Approve a Transaction
1 param body → 200401412
POST
/api/transactions/{token}/cancel
Cancel a Transaction
1 param → 200412
Agreements 7
POST
/api/debit_agreements
Create an Agreement
body → 201401412
GET
/api/debit_agreements/sent
View Sent Agreements
1 param → 200401
GET
/api/debit_agreements/received
View Received Agreements
1 param → 200401
POST
/api/debit_agreements/{token}/approve
Approve an Agreement
1 param body → 201401412
POST
/api/debit_agreements/{token}/cancel
Cancel an Agreement
1 param → 200401
POST
/api/debit_agreements/{token}/reject
Reject an Agreement
1 param → 200401
POST
/api/debit_agreements/{token}/revoke
Revoke an Agreement
revokeAgreement 1 param → 200
Autopay 4

Autopays are a digital analog to paper pre-authorized debit agreements that businesses could use, for instance, for monthly billing.

POST
/api/autopay
Create an Autopay
body → 201401412
PUT
/api/autopay
Updates an Autopay
body → 201401412
GET
/api/autopay
Retrieves Autopays
body → 201401412
POST
/api/autopay/revoke
Revoke an Autopay
revokeAutopay body → 200
Customers 8

As a supplier your customers are the entities that are invoiced. Webhooks When using Webhooks, your application will be notified when key events are triggered for a customer.

POST
/api/imports/customer
Create and Update Customer
body → 201401412
GET
/api/exports/customer/{identifier}
Export/View a Customer
1 param → 200401404
GET
/api/exports/customers
Export Customers
2 params → 200401
GET
/api/exports/customers/recent
Export Customers Recently Updated
2 params → 200401
GET
/api/exports/customer/{identifier}/open_invoices
Export Open Invoices for a Customer
3 params → 200401404412
POST
/api/invitations
Issue an invitation
body → 200400401403404
DELETE
/api/invitations
Cancel an invitation
body → 200400401403404
POST
/api/imports/customers/{identifier}/update_identifier
Update Customer Identifier
1 param body → 200412
Invoices 5

As a supplier invoices are your receivables. Webhooks When using Webhooks, your application will be notified when key events are triggered for an invoice.

POST
/api/imports/invoice
Create and Update Invoice
body → 201401412
POST
/api/imports/invoice/{invoice_number}/attachment
Add Invoice Attachment
1 param body → 200401404
GET
/api/exports/invoice/{number_or_id}
Export/View an Invoice
3 params → 200401404
GET
/api/exports/invoices/recent
Export Invoices Recently Updated
3 params → 200401
GET
/api/exports/open_invoices
Export Open Invoices
3 params → 200401
Notifications 3

As a supplier you can notify customers about their invoices.

POST
/api/notifications/remind/{number_or_id}
Single Invoice Reminder
1 param → 200401
POST
/api/notifications/remind
Bulk Invoice Reminder
body → 200401
POST
/api/notifications/direct_message
Direct Message
body → 200400401404
Invoicing Payments 5

As a supplier a payments are made by customers for invoices issued to them. Webhooks When using Webhooks, your application will be notified when key events are triggered for a pay…

POST
/api/imports/payment
Create a Payment
body → 201401412
GET
/api/exports/payment/{reference_or_token}
Export/View a Payment
3 params → 200401404
GET
/api/exports/payment_amounts
Export Payment Allocations
3 params → 200401
GET
/api/exports/payments
Export Payments
4 params → 200401
GET
/api/exports/payments/recent
Export Payments Recently Updated
4 params → 200401
Divisions 1

As a supplier divisions are used to group your invoices.

POST
/api/imports/division
Create and Update Division
body → 201401412
Collaboration 3

As a supplier your customers collaborate with you through comments about invoices and/or payments.

POST
/api/invoices/{invoice_number}/disputes/close
Close a Dispute
1 param body → 201401412
GET
/api/exports/disputes
Export Open and Closed Disputes
2 params → 200401
GET
/api/exports/comments
Export Customer and Invoice Comments
2 params → 200401
File Imports 9

As a supplier you can upload customer, invoice, and payment data in CSV file formats.

POST
/api/imports
Import a CSV File
body → 201401
GET
/api/imports
View In-Progress & Completed Batches
1 param → 200401
GET
/api/imports/processing
View In-Progress Batches
viewInProgressBatches 1 param → 200401
GET
/api/imports/completed
View Completed Batches
viewCompletedBatches 1 param → 200401
GET
/api/imports/{id}
View Batch Details
viewBatchDetail 1 param → 200401
GET
/api/imports/{id}/echo
View Tokenized Results of File Imported Payment Methods
viewEchoResults 1 param → 200401
GET
/api/imports/{id}/errors
View Batch Errors
viewBatchError 1 param → 200401
GET
/api/exports/invoice_recon/{batch_file_id}
Export/View Invoice Reconciliation Results
3 params → 200401
GET
/api/exports/payment_recon/{batch_file_id}
Export/View Payment Reconciliation Results
3 params → 200401
Settlement Reporting 7

Settlement Reporting includes retrieval of monthly statements, daily deposit amounts (including fee information), transaction exceptions (ACH reject/return & CC chargeback), and t…

GET
/api/gateway/v1/settlement/statements
Retrieve Monthly Statements
6 params → 200401
GET
/api/gateway/v1/settlement/statements/{statement_identifier}.{format}
View Monthly Statement PDF
2 params → 200401
GET
/api/gateway/v1/settlement/batches
Retrieve Daily Batch Deposits
1 param → 200401
GET
/api/gateway/v1/settlement/exceptions
Retrieve Daily Transaction Exceptions
1 param → 200401
GET
/api/gateway/v1/transactions/{token}
View Transaction Detail
1 param → 200401
GET
/api/gateway/v1/orders/{token}
View Order Detail
1 param → 200401
GET
/api/gateway/v1/payments/{token}
View Invoicing Payment Detail
1 param → 200401404

Schemas 137

The contract defines 137 schemas that model the data the API accepts and returns. The most detailed are CustomerResponse (61 properties), PaymentAmount (60 properties), Invoice (54 properties), CustomersResponse (49 properties). Each schema is shown below with its type and property counts.

DepositAccount
object
A deposit account
5 properties
MerchantAccount
object
15 properties
BankProcessor
object
14 properties
TerminalProcessor
object
11 properties
GiftCardProcessor
object
11 properties
Divisions
object
10 properties
Whoami
object
28 properties
Locale
string
Currency
string
AccountFees
object
1 property 1 required
PaymentMethodFees
object
4 properties 4 required
Rate
object
5 properties 5 required
URL
string
ProhibitedProduct
string
ProhibitedProducts
object
2 properties
TermsAndConditionsText
string
TermsAndConditions
object
2 properties
Range
object
2 properties
AmountRanges
object
4 properties
ApplicationParameters
object
4 properties 3 required
BusinessName
string
TIN
string
OverrideValidation
boolean
BusinessTaxIdentifier
object
2 properties 1 required
Address
object
7 properties 4 required
OwnershipType
string
StockTickerSymbol
string
required only if ownershiptype = "Public Corporation", must be <= 10 characters
BusinessType
string
NAICSCode
string
Phone
string
cannot begin with 1 or 0
Email
string
Date
string
RangeAnualDirectDebitVolume
object
2 properties
RangeAverageTicketAmount
object
2 properties
RangeHightTicketAmount
object
2 properties
OverSEMinimum
boolean
SENumber
string
must be <= 10 characters
ServiceEstablishment
object
2 properties 1 required
Person
object
4 properties 3 required
ITIN
string
IndividualTaxIdentifier
object
2 properties 1 required
BirthDate
string
BusinessOwner
object
7 properties 7 required
NonBusinessOwnerControlProng
object
This is a required object when the controlprong is set to Non-Owner
6 properties 6 required
ApplicationContact
object
3 properties 3 required
ControlProng
string
RoutingNumber
string
Must be a valid US Bank ABA Number
DemandDepositAccountNumber
string
DDA
object
2 properties 2 required
ReferenceToken
string
Specify a unique GUID as a client reference to the application
Boolean
boolean
Document
object
3 properties 2 required
ExternalLink
string
An external reference provided by the the ERP/partner originating the merchant application associated with this supplier
LinkToExisting
string
Must match the value of an existing application entry that has previously been submitted
Application
object
31 properties 24 required
ApplicationToken
string
ApplicationCreatedResponse
object
1 property 1 required
ErrorMessage
string
ApplicationAddressError
object
3 properties 2 required
ApplicationTaxIDError
object
2 properties 2 required
ApplicationError
object
2 properties 2 required
ApplicationErrorResponse
object
3 properties
ApplicationStatus
string
APIToken
string
APIKey
string
APICredentials
object
2 properties 2 required
ApplicationStatusResponse
object
2 properties 1 required
Watermark
integer
OrderItem
object
15 properties
SummaryOrderReference
object
Summary reference of known order
3 properties
SummaryPaymentReference
object
Summary reference of known invoicing payment
3 properties
OrderTransaction
object
41 properties
Order
object
36 properties
ResponseCode
object
2 properties
ResponseCountryCodes
object
2 properties
BankIdentificationNumber
string
BankCardType
string
CountryAlpha3Code
string
The uppercase 3-character ISO country code
BankCardCategory
string
BankCardBrand
string
BankName
string
BIN
object
8 properties
CreditCard
object
19 properties
BankAccount
object
14 properties
ContactReference
object
1 property
CustomerReference
object
2 properties
Wallet
object
4 properties
WalletCustomer
object
Invoicing customer reference
2 properties 1 required
WalletContact
object
Billing contact
3 properties 1 required
WalletCreditCard
object
Alternative to fundtoken, a credit card object or token reference to an existing credit card
10 properties 6 required
WalletBankAccount
object
Alternative to fundtoken, a bank account object or token reference to an existing credit card
15 properties 9 required
WalletRequest
object
4 properties
WalletResponse
object
3 properties
WalletPaymentMethodRequest
object
2 properties
WalletCreditCardPatch
object
Alternative to fundtoken, a credit card object or token reference to an existing credit card
9 properties
WalletBankAccountPatch
object
Alternative to fundtoken, a bank account object or token reference to an existing credit card
10 properties
WalletPaymentMethodPatch
object
2 properties
OrderTransactionRequest
object
11 properties
OrderTransactionResponse
object
8 properties
UnifiedResponse
object
TerminalRequest
object
2 properties
TerminalResponse
object
1 property
GiftCardRequest
object
6 properties
GiftCardResponse
object
1 property
GiftCardReadRequest
object
4 properties
GiftCardReadResponse
object
6 properties
FundSource
object
4 properties
VaultResponse
object
4 properties
TransactionResponse
object
19 properties
Transaction
object
8 properties 3 required
Agreement
object
10 properties
AutopayResponse
object
7 properties
AutopayCreated
object
1 property
Contact
object
7 properties 1 required
Customer
object
36 properties 2 required
CustomerResponse
object
61 properties
CustomersResponse
object
49 properties
LineItem
object
13 properties
Invoice
object
54 properties 2 required
PaymentUrls
object
A map of payment URLs mapped to customer email addressed.
LineItemResponse
object
13 properties
InvoiceResponse
object
40 properties
SingleReminderResponse
object
11 properties
BulkReminderResponse
object
11 properties
PaymentImport
object
18 properties 1 required
PaymentAmount
object
60 properties
PaymentResponse
object
25 properties
Dispute
object
18 properties
Comment
object
11 properties
FileImport
object
9 properties
InvoiceReconResponse
object
11 properties
PaymentReconResponse
object
15 properties
MonthlyStatementResponse
object
7 properties
SummaryBatchTransaction
object
Summary reference of known transaction
14 properties
SummaryExceptionTransaction
object
Summary reference of known transaction
6 properties
SettlementExceptionResponse
object
6 properties
SettlementBatchResponse
object
17 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

versapay-api-reference.json Raw ↑

Other APIs Versapay publishes across the network.

Versapay Ecommerce API
AE Profile APIs.io
#Accounts Receivable#Payment Acceptance#Invoicing#Card Present#Webhook
← Back to V APIs
API Details
ID
versapay:versapay-api-reference
Base URL
https://secure.versapay.com
Docs
https://developers.versapay.com/
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-api-reference&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/versapay-api-reference"

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 API Reference, 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.