API Status Support Dashboard

API Endpoints Reference

Complete reference for all AuxVault API endpoints.

Required Headers

Every request must include both of these headers:

x-api-key: YOUR_API_KEY
X-Tenant-ID: YOUR_TENANT_ID

Endpoints that also accept a JWT token (dashboard/admin operations) use:

Authorization: Bearer YOUR_JWT_TOKEN
X-Tenant-ID: YOUR_TENANT_ID

Base URLs

Environment Base URL
Development https://dev.auxcore.net
Production https://api.auxvault.com (confirm before go-live)

All paths below are appended to the base URL. For example:
POST /api/v1/public/transaction → POST https://dev.auxcore.net/api/v1/public/transaction

API Surfaces

AuxVault exposes three API surfaces depending on your use case:

Surface Prefix Auth Use Case
Public API /api/v1/public/ x-api-key + X-Tenant-ID ERP, plugins, server integration
Admin API /api/v1/ Authorization: Bearer JWT + X-Tenant-ID Dashboard, admin operations
AuxVault SDK /api/v1/auxvault/ API key via Authorization: Bearer auxVault.js SDK, PascalCase fields

Public API Endpoints (/api/v1/public/*)

These are the primary endpoints for ERP and server-to-server integrations.
All require x-api-key + X-Tenant-ID headers.

Connection

Method Endpoint Description
POST /api/v1/public/testConnection Verify API key and connection
GET /api/v1/public/sdk-info Get SDK version and hosted fields URL

Authentication (Public API)

Method Endpoint Description Auth Required
POST /api/v1/public/accesstoken Login — get JWT token None (credentials in body)
POST /api/v1/public/refreshToken Refresh an expired JWT None (refresh token in body)
POST /api/v1/public/client-token Generate SDK client token x-api-key
POST /api/v1/public/validate-client-token Validate a client token None

Transactions (Public API)

Method Endpoint Description Body Key Fields
POST /api/v1/public/transaction Process sale or ACH payment Amount, SuggestedMode, CardNumber
POST /api/v1/public/void Void a transaction transactionId
POST /api/v1/public/refund Full or partial refund transactionId, amount?
POST /api/v1/public/rerun Retry a declined transaction transactionId
POST /api/v1/public/token-transaction Charge a stored card token token, amount
GET /api/v1/public/transaction/:id Get transaction by ID —
GET /api/v1/public/transaction-list List transactions (paginated) —
GET /api/v1/public/merchant-transactions List merchant transactions —

Tokenization (Public API)

Method Endpoint Description Body Key Fields
POST /api/v1/public/tokenize-card Tokenize a card cardNumber, expiryMonth, expiryYear
POST /api/v1/public/decrypt-token Get masked card details from token token

Customers (Public API)

Method Endpoint Description Body Key Fields
GET /api/v1/public/customers List customers —
POST /api/v1/public/customer Create a customer firstName, lastName, email
GET /api/v1/public/customer/:id Get customer by ID —
PUT /api/v1/public/customer/:id Update customer Any customer fields
DELETE /api/v1/public/customer/:id Delete customer —
POST /api/v1/public/customer/:id/payment-method Add payment method to customer cardNumber, expiryMonth, expiryYear
GET /api/v1/public/customer/:id/payment-methods List customer payment methods —
DELETE /api/v1/public/customer/:id/payment-method/:pmId Remove a stored payment method —

Recurring (Public API)

Method Endpoint Description Body Key Fields
POST /api/v1/public/recurring Create a recurring plan customerId, amount, period

Merchants (Public API)

Method Endpoint Description
POST /api/v1/public/merchants/provision Provision a new merchant (tenant-level key required)
GET /api/v1/public/merchants Get merchant details for current API key
GET /api/v1/public/merchant Get merchant by ID (pass ?id=merchantId)
GET /api/v1/public/getConfig Get merchant runtime configuration
GET /api/v1/public/getFee Get merchant fee schedule

OTP (Public API)

Method Endpoint Description Body Key Fields
POST /api/v1/public/otp/generate Generate and send OTP via SMS or email type, destination
POST /api/v1/public/otp/verify Verify a customer-entered OTP otpId, code
POST /api/v1/public/otp/resend Resend an OTP otpId

Invoicing / Payment Links (Public API)

Method Endpoint Description Body Key Fields
POST /api/v1/public/generate-url Create a payment link (invoice) amount
POST /api/v1/public/shorten-url Shorten a payment URL url
POST /api/v1/public/shorten-url-sms Create short URL and send SMS url, phone
POST /api/v1/public/shorten-url-payment-sms Create short URL and send payment SMS url, phone

Integrations (Public API)

Method Endpoint Description
POST /api/v1/public/shopifyTransaction Process a Shopify transaction

AuxVault SDK Routes (/api/v1/auxvault/*)

PascalCase field format. Authenticate with your API key in Authorization: Bearer YOUR_API_KEY.
X-Tenant-ID is resolved automatically from the API key (not required as a separate header).

Method Endpoint Description Required Body Fields
POST /api/v1/auxvault/transaction Sale or auth (TransactionType: "0" = auth only) Amount
POST /api/v1/auxvault/void Void a transaction TransactionId
POST /api/v1/auxvault/refund Full or partial refund TransactionId
POST /api/v1/auxvault/capture Capture an authorization TransactionId
POST /api/v1/auxvault/cancel-capture Reverse a capture TransactionId
POST /api/v1/auxvault/credit Issue an unlinked credit TransactionId, Amount
POST /api/v1/auxvault/tokenize Tokenize a card CardNumber, ExpiryDate
GET /api/v1/auxvault/query/:transactionId Get transaction by ID —

SDK Field Reference

SDK Field Type Description
Amount string Transaction amount (e.g., "100.00")
TransactionType string "0" = Auth Only; omit for Sale
CardNumber string Card number
ExpiryDate string MMYY format (e.g., "1227")
Cvv string Card security code
BillingCustomerName string Cardholder name
BillingEmail string Customer email
BillingAddress string Street address
BillingCity string City
BillingState string State
BillingPostalCode string ZIP/postal code
TransactionId string Required for void, refund, capture, cancel-capture, credit

Admin API Routes (/api/v1/*)

Dashboard and admin operations. Require Authorization: Bearer JWT + X-Tenant-ID.
Obtain a JWT from POST /api/v1/public/accesstoken.

Authentication

Method Endpoint Description
POST /api/v1/auth/login Login (returns JWT)
POST /api/v1/auth/token Login alias
POST /api/v1/auth/logout Logout and invalidate token
POST /api/v1/auth/refresh Refresh JWT
GET /api/v1/auth/me Get current user info
POST /api/v1/auth/verify-otp Verify 2FA OTP
POST /api/v1/auth/resend-otp Resend 2FA OTP
POST /api/v1/auth/forgot-password Send password reset email
POST /api/v1/auth/reset-password Reset password

API Keys

Method Endpoint Description
POST /api/v1/api-keys Create API key
GET /api/v1/api-keys List API keys
GET /api/v1/api-keys/:id Get API key details
PUT /api/v1/api-keys/:id Update API key
DELETE /api/v1/api-keys/:id Revoke API key

Transactions (Admin)

Method Endpoint Description
POST /api/v1/transactions Process sale or auth
GET /api/v1/transactions List transactions
GET /api/v1/transactions/:id Get transaction details
POST /api/v1/transactions/:id/capture Capture authorization
POST /api/v1/transactions/:id/cancel-capture Cancel a capture
POST /api/v1/transactions/:id/void Void transaction
POST /api/v1/transactions/:id/refund Full refund
POST /api/v1/transactions/:id/refund/partial Partial refund
POST /api/v1/transactions/:id/credit Issue unlinked credit
POST /api/v1/transactions/:id/rerun Retry transaction

Recurring (Admin)

Method Endpoint Description
POST /api/v1/recurring Create recurring plan
GET /api/v1/recurring List recurring plans
GET /api/v1/recurring/:id Get plan details
PUT /api/v1/recurring/:id Update plan
DELETE /api/v1/recurring/:id Delete plan
POST /api/v1/recurring/:id/pause Pause plan
POST /api/v1/recurring/:id/resume Resume plan
POST /api/v1/recurring/:id/skip-next Skip next payment
POST /api/v1/recurring/:id/cancel Cancel plan
GET /api/v1/recurring/:id/payments Get payment history
POST /api/v1/recurring/process-auto-retry Trigger auto-retry for failed payments

Customers (Admin)

Method Endpoint Description
POST /api/v1/customers Create customer
GET /api/v1/customers List customers
GET /api/v1/customers/:id Get customer
PUT /api/v1/customers/:id Update customer
DELETE /api/v1/customers/:id Delete customer
GET /api/v1/customers/:id/transactions Customer transaction history
GET /api/v1/customers/:id/payment-methods List payment methods
PUT /api/v1/customers/:id/payment-methods/:pmId/set-default Set default payment method

Merchants (Admin)

Method Endpoint Description
POST /api/v1/merchants Create merchant
GET /api/v1/merchants List merchants
GET /api/v1/merchants/:id Get merchant details
PUT /api/v1/merchants/:id Update merchant
DELETE /api/v1/merchants/:id Delete merchant
GET /api/v1/merchants/:id/settings Get merchant settings
PUT /api/v1/merchants/:id/settings Update merchant settings
GET /api/v1/merchants/:id/fraud-settings Get fraud settings
PUT /api/v1/merchants/:id/fraud-settings Update fraud settings
GET /api/v1/merchants/:id/vt-settings Get virtual terminal settings
PUT /api/v1/merchants/:id/vt-settings Update virtual terminal settings
GET /api/v1/merchants/:id/branding Get branding
PUT /api/v1/merchants/:id/branding Update branding
GET /api/v1/merchants/:id/permissions Get permissions
PUT /api/v1/merchants/:id/permissions Update permissions
GET /api/v1/merchants/:id/dunning-settings Get dunning config
PUT /api/v1/merchants/:id/dunning-settings Update dunning config
GET /api/v1/merchants/:id/gateway-routing Get gateway routing rules
PUT /api/v1/merchants/:id/gateway-routing Update gateway routing
GET /api/v1/merchants/:id/gateways List merchant gateways
POST /api/v1/merchants/:id/gateways Add gateway
PUT /api/v1/merchants/:id/gateways/:gwId Update gateway
DELETE /api/v1/merchants/:id/gateways/:gwId Remove gateway
POST /api/v1/merchants/provision Provision merchant (API)

Invoicing (Admin)

Method Endpoint Description
POST /api/v1/invoices Create invoice
GET /api/v1/invoices List invoices
GET /api/v1/invoices/:id Get invoice
PUT /api/v1/invoices/:id Update invoice (draft only)
POST /api/v1/invoices/:id/send Send invoice (email/SMS)
POST /api/v1/invoices/:id/payment Record payment
POST /api/v1/invoices/:id/cancel Cancel invoice
GET /api/v1/invoices/:id/qr-code Get QR code
GET /api/v1/invoices/:id/pdf Download PDF

Webhooks

Method Endpoint Description
POST /api/v1/webhooks/endpoints Create webhook endpoint
GET /api/v1/webhooks/endpoints List webhook endpoints
GET /api/v1/webhooks/endpoints/:id Get endpoint details
PUT /api/v1/webhooks/endpoints/:id Update endpoint
DELETE /api/v1/webhooks/endpoints/:id Delete endpoint
POST /api/v1/webhooks/endpoints/:id/test Test endpoint

Notifications / Receipts

Method Endpoint Description
POST /api/v1/notifications/receipt/email Send email receipt
POST /api/v1/notifications/receipt/sms Send SMS receipt
GET /api/v1/notifications/receipts/:transactionId/pdf Download PDF receipt
POST /api/v1/notifications/receipt/print Get printable receipt

Settlement & Funding

Method Endpoint Description
GET /api/v1/settlement/schedule/:merchantId Get settlement schedule
PUT /api/v1/settlement/schedule/:merchantId Update settlement schedule
GET /api/v1/settlement/history/:merchantId Get settlement history
GET /api/v1/settlement/funding-report Get funding report
POST /api/v1/settlement/funding-report/export/csv Export funding report as CSV
POST /api/v1/settlement/funding-report/email Email funding report
POST /api/v1/settlement/payout Initiate a payout

Reporting

Method Endpoint Description
GET /api/v1/reporting/transactions Transaction report
GET /api/v1/reporting/batches Batch report
GET /api/v1/reporting/daily-summary Daily summary
GET /api/v1/reporting/export/transactions Export transactions (CSV)
GET /api/v1/analytics/transactions Transaction analytics
GET /api/v1/analytics/revenue Revenue analytics
GET /api/v1/analytics/refunds Refund analytics

Audit & Compliance

Method Endpoint Description
GET /api/v1/audit-logs Get audit log entries
GET /api/v1/user-sessions Get active user sessions

Roles & Permissions

Method Endpoint Description
GET /api/v1/roles List roles
POST /api/v1/roles Create role
GET /api/v1/roles/:id Get role details
PUT /api/v1/roles/:id Update role
DELETE /api/v1/roles/:id Delete role
GET /api/v1/users/:id/permissions Get user permissions
POST /api/v1/users/:id/permissions Update user permissions

Standard Response Format

All endpoints return a consistent JSON envelope:

Success

{
  "success": true,
  "data": { ... }
}

Error

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Amount is required"
  }
}

Paginated List

{
  "success": true,
  "data": [ ... ],
  "pagination": {
    "page": 1,
    "limit": 50,
    "total": 1234,
    "pages": 25
  }
}

HTTP Status Codes

Code Meaning
200 Request succeeded
201 Resource created
400 Bad request / validation error
401 Authentication required or failed
403 Permission denied
404 Resource not found
422 Unprocessable entity
429 Rate limit exceeded
500 Internal server error

Pagination

List endpoints support pagination via query parameters:

GET /api/v1/public/transaction-list?page=2&limit=50
Parameter Type Default Maximum
page integer 1 —
limit integer 50 200

Common Filters

Most list endpoints accept date and status filters:

GET /api/v1/public/transaction-list?startDate=2026-02-01&endDate=2026-02-28&status=approved
Parameter Description
startDate Start date (ISO 8601, e.g., 2026-02-01)
endDate End date (ISO 8601, e.g., 2026-02-28)
status Filter by status
page Page number
limit Items per page

Next Steps

Need help? Contact support@auxvault.com