⚠️ Payment Processing Temporarily Unavailable
Sections
⚠️ Payment Processing Temporarily Unavailable
API Overview
User Guide
Integration Guide
About Your Credentials
Authentication
Gateway Hierarchy
Transition from UAT to Production
Test Information
Test Amount Range
Test Account Information
Gateway References
Gateway Response Error Codes
Gateway Response Codes
AVS/CVV Responses
Terminal Devices
Device Troubleshooting
Terminal UUID (Location ID)
PAX POSLink Errors
Troubleshooting
PAX Terminals
Disable Auto Clear Database
Out of Paper Error
PAX Terminal Not Printing Receipts
Workflows
TokenPay.js Workflow
Wallet API Workflow
Surcharge Workflow
Flowchart
Card-Present (PayGuardian Cloud) Surcharge
Card-Not-Present (TokenPay.js) Surcharge
Card-on-File (Wallet API)
Transaction API
Card Not Present
Authorization/Sale
POST
Credit Card Authorization
POST
Credit Card Sale with Token
POST
Credit Card Sale with Wallet (customerWalletId)
POST
Credit Card Sale with Wallet (walletPaymentMethodId)
POST
Credit Card Partial Approval
Cash/Check (Info only)
POST
Cash Sale
POST
Check Sale
Custom Fields
POST
Credit Card Sale with Custom Fields
Surcharge
POST
Credit Card Sale with Surcharge
Dynamic Descriptor
POST
Dynamic Descriptor
Healthcare
POST
Healthcare
Level II & III
POST
Level II & III
Void/Refund
POST
Void
POST
Refund (Referenced)
POST
Refund (Unreferenced)
Functions
Account Verification
POST
Card Verification Credit/Debit
Capture
POST
Capture Authorization
Find Transaction
GET
Find Transaction (TransactionID)
GET
Find Transaction (Invoice Number)
Get Merchant Info
GET
Get Merchant Information
Settlement
POST
Settlement
Card Not Present - TokenPay.js
POST
TokenPay Credit Card Sale
POST
TokenPay ACH Sale
POST
TokenPay Credit Card Sale w/ Custom Fields
POST
TokenPay Credit Card Sale w/ Surcharge
POST
TokenPay Card Verification
POST
TokenPay PaymentMethodToken
Card Present - PayGuardian Cloud
CREDIT
POST
Sale
POST
Sale w/ Custom Fields
POST
Auth
POST
Account Verification
Surcharge
POST
Surcharge
FUNCTION
Pairing
GET
Get Pairing Code
GET
Get UUID (Terminal ID)
POST
Ping
WalletAPI
WalletView Model
POST
GetWalletViewByWalletId
POST
GetWalletViewByPaymentMethodId
POST
GetWalletViewByCustomerId
WalletView Management
POST
CreateWalletView
POST
UpdateWalletView
POST
ActivateWalletView
POST
DeactivateWalletView
POST
GetWalletViews
Reporting API
POST
Full Filter List
POST
Get Transactions by Batch ID
POST
Get Transactions by Merchant Account Code
POST
Get Transactions by Merchant Code
POST
Get Transactions by Organization ID
POST
Get Transaction by Transaction ID
POST
Get Transactions by Username
POST
Get Transactions by Invoice Number
Credentials Management API
User Management
POST
CreateUser
POST
UpdateUser
POST
GetUsers
POST
GetUser
POST
ChangePassword
POST
ActivateUser
POST
DeactivateUser
TokenPay Credentials Management
POST
CreateTokenPayAuthentication
POST
UpdateTokenPayAuthentication
POST
GetTokenPayAuthentications
POST
GetTokenPayAuthentication
POST
ActivateTokenPayAuthentication
POST
DeactivateTokenPayAuthentication
Recurring Payments API
api
auth
POST
Refresh Token
POST
Get Token
v1
users
{user_uuid}
GET
Get An Existing User
GET
Get Existing Users
services
{service_uuid}
GET
Get An Existing Service
PUT
Update An Existing Service
DELETE
Delete An Existing Service
PATCH
Patch An Existing Service
GET
Get Existing Services
POST
Create A New Service
schedules
{schedule_uuid}
payment_plans
GET
Get An Existing Schedule With Plans
GET
Get An Existing Schedule
PUT
Update An Existing Schedule
DELETE
Delete An Existing Schedule
PATCH
Patch An Existing Schedule
GET
Get Existing Schedules
POST
Create A Monthly Schedule with Specific Day
POST
Create A Monthly Schedule with Week and Day
POST
Create A Weekly Schedule
payment_plans
{payment_plan_uuid}
pause
PATCH
Pause Payment Plan
unpause
PATCH
Unpause Payment Plan
transactions
GET
Get Transactions For An Existing Payment Plan
everything
GET
Get An Existing Plan With Everything
GET
Get An Existing Plan
PUT
Update An Existing Plan
DELETE
Delete An Existing Plan
PATCH
Patch An Existing Plan
GET
Get Existing Plans
POST
Create A New Plan
merchants
{merchant_uuid}
everything
GET
Get An Existing Merchant With Everything
GET
Get An Existing Merchant
PUT
Update An Existing Merchant
DELETE
Delete An Existing Merchant
PATCH
Patch An Existing Merchant Patch
by_group_uuid
{merchant_group_uuid}
GET
Get Existing Merchants By Merchant Group Uuid
by_group_account
{merchant_group_account}
{merchant_account}
GET
Get An Existing Merchant By Merchant Group Account Number And Account Number
GET
Get Existing Merchants By Merchant Group Account Number
GET
Get Existing Merchants
POST
Create A New Merchant
merchant_groups
{merchant_group_uuid}
everything
GET
Get An Existing Merchant Group With Everything
GET
Get An Existing Merchant Group
PUT
Update An Existing Merchant Group
DELETE
Delete An Existing Merchant Group
PATCH
Patch An Existing Merchant Group
by_account
{merchant_group_account}
GET
Get An Existing Merchant Group By Account Number
GET
Get Merchant Groups
POST
Create A New Merchant Group
Product Release Notes
API Release Notes
v2.0.4 - Released September 24, 2025
v2.0.3 - Released September 04, 2025
v2.0.2 - Released July 25, 2025
v2.0.1 - Released July 11, 2025
v2.0.0 - Released April 17, 2025
Authentication / Authorization Release Notes
Security Release Notes
Search or ask...
Search
v2
Open menu
API explorer
Changelog
v2
API explorer
Changelog
Theme switcher