For AI agents: visit https://valorapi.readme.io/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI. Append .md to any documentation page URL to get its markdown version.
Jump to Content
API Reference
v1.0
Log In
API Reference
Log In
v1.0
API Reference
ACH Transactions
JUMP TO
Merchant API
MERCHANT API
Documentation
Merchant API Sample Responses
Direct Sale / Auth
post
Direct Sale Token
post
Direct Sale API (L2/L3)
post
Direct Sale Token (L2/L3)
post
Hosted Page Sale
post
Hosted Page Sale - Update and Resend
post
Hosted Page Sale(L2 & L3)
post
Hosted Page Sale(L2 & L3) - Update and Resend
post
Hosted Page Sale - Cancel
post
Merchant Hosted Page Sale
post
Incremental Auth
post
Refund Offset Sale
post
Transaction List API
post
Transaction List with Date Range API
post
Void API
post
Settlement API
post
Capture/Ticket API
post
Open Batch API
post
Closed Batch API
post
TIP Adjust API
post
E-Receipt Fetch API
post
Fetch E-Invoice API
post
BIN LookUp
post
Device Info
post
E-Receipt API
post
QR Code API
post
Product Inventory
Get Modifier
post
Delete Modifier
post
Update Modifier
post
Create Modifier
post
Delete Discount
post
Update Discount
post
Get Discount
post
Create Discount
post
Update Product
post
Delete Product
post
Create Product
post
Get Product
post
Subscription API
Add Subscription
post
Update Subscription
post
View Subscription
get
Delete Subscription
post
De-Activate Subscription
post
Activate Subscription
post
Valor ACH
Documentation
ACH Sale API
post
Void API
post
ACH Recurring Sale
post
ACH Recurring Update
post
ACH Recurring Activate
post
ACH Recurring De-Activate
post
ACH Recurring Skip Next Payment
post
ACH Recurring Postpone Payment
post
ACH TxnFetch
post
ACH Recurring List
post
ACH Recurring Delete
post
ACH Authorization
post
Gift API
Sale API
post
Check Balance
post
Activate
post
Add Balance
post
Encryption Fetch API
post
Direct Refund API
post
MERCHANT APIs – v1
Payment APIs
Direct Sale
post
Direct Sale Token
post
Direct Sale API (L2 & L3)
post
Direct Sale Token (L2 & L3)
post
Direct Auth
post
Incremental Auth
post
Capture / Ticket
post
Tip Adjust
put
Void
post
Refund
post
QR Code
post
Hosted Payment APIs
Hosted Page Sale
post
Hosted Page Sale (L2 & L3)
post
Merchant Hosted Page Sale
post
Hosted Page Sale - Update and Resend
post
Hosted Page Sale (L2 & L3) - Update and Resend
post
Hosted Page Sale - Cancel
post
ACH Payment APIs
ACH Transactions
Sale
post
Auth
post
Void
post
Transaction Fetch
get
ACH Recurring
Recurring Sale
post
Recurring List
get
Recurring Update
put
Recurring Activate
put
Recurring Deactivate
put
Recurring Skip Next Payment
put
Recurring Postpone Payment
put
Recurring Delete
del
Gift Card APIs
Activate
post
Add Balance
post
Check Balance
post
Sale
post
Subscription APIs
Add Subscription
post
Update Subscription
put
Activate Subscription
put
Deactivate Subscription
put
Delete Subscription
del
Batch & Settlement APIs
Open Batch
get
Settlement
post
Closed Batch
get
Transaction Reporting APIs
Transaction List
get
Transaction List with Date Range
get
Receipt & Invoice APIs
E-Receipt
post
E-Receipt Fetch
get
Fetch E-Invoice
get
Product Catalog APIs
Products
Create Product
post
Get Product
get
Update Product
put
Delete Product
del
Modifiers
Create Modifier
post
Get Modifier
get
Update Modifier
put
Delete Modifier
del
Discounts
Create Discount
post
Get Discount
get
Update Discount
put
Delete Discount
del
Device & BIN Lookup APIs
BIN Lookup
post
Device Info
get
Valor API
VALOR API
Add Customer Profile
post
Edit Customer Profile
post
View Customer Profile
get
Get Customer List
get
Delete Customer Address
del
Delete Customer Profile
del
Add Payment Profile
post
Add Payment Profile Using Token
post
Update Payment Profile
post
Map Transaction to Customer Profile
post
Edit Payment Profile
patch
Get Payment Profile
get
Delete Payment Profile
del
Add ACH Profile
post
Update ACH Profile
post
Get ACH Profile
get
Delete ACH Profile
del
Fetch Transaction With Date Range
post
Merchant CRM API
Online Portal
Documentation
Merchant Boarding API Sample Responses (Online Portal)
Merchant - Create Bearer Token
post
Merchant Add - Surcharge (Tsys)
post
Merchant Add - Traditional (Tsys)
post
Merchant Add - Surcharge (FD)
post
Merchant Add - Traditional (FD)
post
Merchant Update
post
Merchant Add - FD Cardnet
post
Merchant Add - FD Bypass
post
Merchant Add - FD Nashville
post
Merchant Add - Priority Payment
post
Merchant Update - Priority Payment
post
Merchant Add - EPX
post
Merchant Add - Postilion
post
Merchant Add - Elavonpay
post
Merchant Add - Payroc
post
Merchant Add - Worldpay
post
Merchant Delete
post
Merchant Get Details
post
Merchant Operator - Create
post
Sub-ISO Operator - Create
post
Merchant Status
post
Merchant View
post
Merchant List
post
Copy Parameter API
post
Create Ticket
post
Update Ticket - ISO
post
View Ticket
post
Store Add
post
Store Sync
Store Sync
post
Store Sync (Virtual Terminal Device)
post
Store Sync (RCKT Device)
post
Store Sync (Hardware Device)
post
Store Delete
post
EPI Add
post
EPI Activate
post
EPI Delete
post
EPI Detail
post
EPI View
post
Assign App - EPI
post
Fetch E-Receipt
post
Transaction List
post
EPI Last Txn
post
EPI Update
post
Check EPI
post
Sub-ISO - Create
post
Device Parameter API
Device Parameter For Virtual Terminal Device
post
Device Parameter For RCKT Device
post
Device Parameter For Hardware Device
post
EPI Status
post
EPI Deactivate
post
Check Profile
post
Generating API Keys - via API
post
Generate APP Key
post
EPI Status Update
post
Fetch APP ID & APP Keys
post
Update Ticket - Merchant
post
EPI - Generate API Keys
post
ISO Billing Statement
post
ISO Operator -Create
post
Differential Setting Bulk Update
post
Multi Merchant API
Merchant Add Multi-MID
post
Merchant Info Update
post
Multi Mid - Store Update
post
Multi Mid - Child Epi Update
post
Multi Mid - Parent EPI Update
post
Multi Mid - Module Update
post
Device Parameter Fetch
post
POS Menu Configuration - Get
get
POS Menu Configuration - Update
post
ISO Billing Report
post
Virtual Terminal
VIRTUAL TERMINAL
Documentation
Virtual Terminal API Sample Responses
Sale API
post
Capture API
post
Settlement API
post
Void API
post
2FA Request
post
Refund API
post
List Subscription API
post
USER GUIDE
Portal User Guide
Webhook User Guide
QuickBooks User Guide
Utilizing Quickbooks Templating for eInvoicing
Valor Connect via Virtual Terminal User Guide
User Guide to Add a Device to an Existing Merchant
Managing ISV Associations and Access Levels
Authentication
Online Portal
Merchant - Create Bearer Token
post
Generating API Keys - via API
post
API Keys - ISO Level
API Keys - ISV Level
API Keys - Merchant Level
ECOMMERCE INTEGRATION
ECOMMERCE INTEGRATION
WooCommerce User Guide
Magento User Guide
ValorPay BigCommerce App Private Distribution Setup
OsCommerce User Guide
OpenCart User Guide
Passage.js
Documentation (v1.0)
Documentation (v2.0)
Passage.js API Sample Responses
Create Page Token
post
Create Card Token
post
Sale API
post
POS INTEGRATION
POS INTEGRATION
Semi Integration Device Compatibility Matrix
Valor Connect
Enable Valor Connect as a Merchant
Enable Valor Connect for a Merchant (ISO)
Processing Transactions on Valor Connect
MQTT Valor Connect Integration Guide
Start Your Certification Process
MQTT Requirements / Best Practices
Sandbox
Code for Integration
Certifications
Go Live !
Wrapper API Valor Connect Integration Guide
Start Your Certification Process
Wrapper API Requirements / Best Practice
Publish API
post
Status API
post
Cancel API
post
Certifications
Go Live !
POS SEMI Integration
Cash Drawer Integration with VP800
POS Response Description
Valor Connect API Sample Responses
Valor Connect Device Status
get
Valor Connect Device Status - Multi-MID
get
VL300 Setup & Valor Connect Integration Guide
Semi Integration Support via USB
Semi Integration Support via USB – VP Android Terminals User Guide
test cards
TEST CARDS
Test Card Credentials
Error Code & Description
Postman Collection
Valor SDK
SDK Guides
VP Series - API Guide
VL Series - API Guide
APK Upload Requirements
SDK Go Live Procedure
SDK API Sample Data
TROUBLESHOOTING
Troubleshooting Q&A
Powered by
ACH Transactions
Copy Page
Updated about 1 hour ago
Did this page help you?
Yes
No
Updated about 1 hour ago
Did this page help you?
Yes
No
