Quick Start Guide

Process your first payment in 5 minutes with AuxVault.

What You'll Build

By the end of this guide, you'll be able to:

• Authenticate with your API key
• Test the connection
• Process a payment
• View transaction details
• Issue a refund

Time: 5 minutes
Level: Beginner

Prerequisites

• API Key — obtain from the AuxVault dashboard → Settings → API Keys
• Tenant ID — provided by your account manager
• Merchant ID — visible in the dashboard after merchant setup
• A terminal with curl installed (or any HTTP client)

Base URL (Development)

All API calls in this guide target the development environment:

https://dev.auxcore.net/api/v1/public

For production, replace with https://api.auxvault.com/api/v1/public (confirm URL before go-live).

Step 1: Set Up Environment Variables (30 seconds)

export API_KEY="YOUR_API_KEY"
export TENANT_ID="YOUR_TENANT_ID"
export BASE_URL="https://dev.auxcore.net/api/v1/public"

Step 2: Test Your Connection (30 seconds)

Verify your credentials are working:

curl -X POST "$BASE_URL/testConnection" \
  -H "x-api-key: $API_KEY" \
  -H "X-Tenant-ID: $TENANT_ID"

Success response:

{
  "success": true,
  "message": "Connection successful",
  "data": {
    "platform": "AuxVault",
    "version": "2.0.0",
    "tenantId": "acme-payments",
    "merchantId": "merchant-456"
  }
}

If you see "success": true — you're ready to process payments!

Step 3: Process Your First Payment (2 minutes)

Process a test sale:

curl -X POST "$BASE_URL/transaction" \
  -H "x-api-key: $API_KEY" \
  -H "X-Tenant-ID: $TENANT_ID" \
  -H "Content-Type: application/json" \
  -d '{
    "Amount": 10.00,
    "SuggestedMode": "Card",
    "CardNumber": "4111111111111111",
    "ExpiryMonth": "12",
    "ExpiryYear": "2027",
    "CVV": "123",
    "BillingCustomerName": "Test Customer",
    "BillingEmail": "test@example.com",
    "BillingAddress": "123 Main St",
    "BillingCity": "New York",
    "BillingState": "NY",
    "BillingPostalCode": "10001"
  }'

Success response:

{
  "status": "success",
  "status_code": 200,
  "message": "Transaction processed successfully",
  "data": {
    "TransactionId": "txn_1234567890abcdef",
    "Status": "1",
    "Amount": 10.00,
    "AuthCode": "123456",
    "ResponseCode": "100",
    "ResponseMessage": "Approved",
    "AvsResult": "Y",
    "CvvResult": "M"
  }
}

A Status of "1" means Approved.

Save the TransactionId — you'll need it for the next steps.

export TRANSACTION_ID="txn_1234567890abcdef"

Step 4: View Transaction Details (30 seconds)

Retrieve the full details of your transaction:

curl "$BASE_URL/transaction/$TRANSACTION_ID" \
  -H "x-api-key: $API_KEY" \
  -H "X-Tenant-ID: $TENANT_ID"

Step 5: Issue a Refund (1 minute)

Refund the test transaction:

curl -X POST "$BASE_URL/refund" \
  -H "x-api-key: $API_KEY" \
  -H "X-Tenant-ID: $TENANT_ID" \
  -H "Content-Type: application/json" \
  -d '{
    "transactionId": "'$TRANSACTION_ID'",
    "reason": "Test refund"
  }'

Response:

{
  "success": true,
  "data": {
    "transactionId": "txn_1234567890abcdef",
    "status": "refunded"
  }
}

What You Just Learned

In 5 minutes, you:

• Authenticated with your API key
• Tested the connection
• Processed a $10 test payment (Status 1 = Approved)
• Retrieved transaction details
• Issued a full refund

Test Card Numbers

Use these in the development environment only:

Use any future expiry date (e.g., 12/2027) and any 3-4 digit CVV.

Next Steps

1. Process ACH Payments → — Set SuggestedMode: "ACH"
2. Recurring Billing → — Create subscription plans
3. Customer Vault → — Store customers and payment methods
4. Webhooks → — Receive real-time payment notifications
5. All Endpoints → — Full API reference

Troubleshooting

"API key required" (401)

Both headers are missing or wrong:

# Verify both headers are set
echo "API_KEY: $API_KEY"
echo "TENANT_ID: $TENANT_ID"

"Invalid API key" (401)

The key exists but is inactive or belongs to a different tenant. Check in the dashboard → Settings → API Keys.

Declined Transaction

A Status of "9" means declined. In development, use the test card numbers above. In production, ask the customer for a different payment method.

Questions? Contact support@auxvault.com