Getting Started with AuxVault
Welcome to AuxVault! This guide will help you integrate our payment processing platform into your application.
What is AuxVault?
AuxVault is a comprehensive payment processing platform that provides:
- Full Payment Processing — Accept cards, ACH, and tokenized payments
- Recurring Billing — Automated subscription management
- Invoicing & Text-to-Pay — Create and send payment links via email or SMS
- Fraud Prevention — Advanced AVS/CVV filtering and risk management
- Multi-Gateway Support — Intelligent routing across multiple processors
- Customer Vault — Securely store customers and payment methods
- Comprehensive Reporting — Real-time transaction and settlement reports
Quick Start (5 minutes)
1. Get Your Credentials
Contact your AuxVault account manager to receive:
- Your Tenant ID (e.g.,
acme-payments) - Access to the dashboard to create an API Key
2. Test the Connection
curl -X POST https://dev.auxcore.net/api/v1/public/testConnection \
-H "x-api-key: YOUR_API_KEY" \
-H "X-Tenant-ID: YOUR_TENANT_ID"
Success:
{
"success": true,
"message": "Connection successful",
"data": {
"platform": "AuxVault",
"version": "2.0.0"
}
}
3. Process a Payment
curl -X POST https://dev.auxcore.net/api/v1/public/transaction \
-H "x-api-key: YOUR_API_KEY" \
-H "X-Tenant-ID: YOUR_TENANT_ID" \
-H "Content-Type: application/json" \
-d '{
"Amount": 100.00,
"SuggestedMode": "Card",
"CardNumber": "4111111111111111",
"ExpiryMonth": "12",
"ExpiryYear": "2027",
"CVV": "123",
"BillingCustomerName": "John Doe",
"BillingEmail": "john@example.com"
}'
Response:
{
"status": "success",
"data": {
"TransactionId": "txn_1234567890abcdef",
"Status": "1",
"Amount": 100.00,
"AuthCode": "123456"
}
}
Status: "1" = Approved.
Base URLs
| Environment | URL |
|---|---|
| Development | https://dev.auxcore.net/api/v1/public |
| Production | https://api.auxvault.com/api/v1/public (confirm before go-live) |
Required Headers
Every API request must include both of these headers:
x-api-key: YOUR_API_KEY
X-Tenant-ID: YOUR_TENANT_ID
Missing either header returns 401 Unauthorized.
Security Best Practices
- Never expose your API key in client-side code or version control
- Use HTTPS for all API requests (enforced by the server)
- Validate webhook signatures to ensure authenticity
- Store sensitive data securely — never log full card numbers
- Rotate API keys regularly (every 90 days)
Test Card Numbers
| Card | Number | Result |
|---|---|---|
| Visa | 4111111111111111 | Approved |
| Visa (decline) | 4000000000000002 | Declined |
| Mastercard | 5555555555554444 | Approved |
| Amex | 378282246310005 | Approved |
| Discover | 6011111111111117 | Approved |
Use any future expiry date and any 3-4 digit CVV.
Additional Resources
Need help? Contact support@auxvault.com