Quick Start Guide#

// quickstart.mjs — Node.js 18+ (built-in fetch)
const BASE_URL = process.env.BASE_URL ?? 'https://uat.auxcore.net/api/v1/public';

async function auxcore(method, path, body) {
  const res = await fetch(`${BASE_URL}${path}`, {
    method,
    headers: { 'x-api-key': process.env.API_KEY, 'Content-Type': 'application/json' },
    body: body ? JSON.stringify(body) : undefined,
  });
  return { status: res.status, body: await res.json() };
}

# quickstart.py — Python 3.8+, pip install requests
import os
import requests

BASE_URL = os.environ.get("BASE_URL", "https://uat.auxcore.net/api/v1/public")
session = requests.Session()
session.headers.update({"x-api-key": os.environ["API_KEY"]})

<?php
// quickstart.php — PHP 7.4+ with the curl extension
define('BASE_URL', getenv('BASE_URL') ?: 'https://uat.auxcore.net/api/v1/public');

function auxcore(string $method, string $path, ?array $body = null): array
{
    $ch = curl_init(BASE_URL . $path);
    curl_setopt_array($ch, [
        CURLOPT_CUSTOMREQUEST => $method,
        CURLOPT_RETURNTRANSFER => true,
        CURLOPT_HTTPHEADER => ['x-api-key: ' . getenv('API_KEY'), 'Content-Type: application/json'],
    ]);
    if ($method !== 'GET') {
        curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($body ?? new stdClass()));
    }
    $response = json_decode(curl_exec($ch), true);
    $status = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);
    curl_close($ch);
    return [$status, $response];
}

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

const connection = await auxcore('POST', '/testConnection');
console.log(connection.status, connection.body.message);

connection = session.post(f"{BASE_URL}/testConnection")
print(connection.status_code, connection.json()["message"])

[$status, $connection] = auxcore('POST', '/testConnection');
echo $status, ' ', $connection['message'], PHP_EOL;

curl -X POST "$BASE_URL/tokenize-card" \
  -H "x-api-key: $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "cardNumber": "4111111111111111",
    "expiryMonth": "12",
    "expiryYear": "2030",
    "cvv": "123",
    "cardHolderName": "Test Customer"
  }'

# Copy data.pciToken from the response
export PCI_TOKEN="pci_tok_8f2c1a9b7e4d"

const tokenized = await auxcore('POST', '/tokenize-card', {
  cardNumber: '4111111111111111',
  expiryMonth: '12',
  expiryYear: '2030',
  cvv: '123',
  cardHolderName: 'Test Customer',
});
const pciToken = tokenized.body.data.pciToken;

tokenized = session.post(f"{BASE_URL}/tokenize-card", json={
    "cardNumber": "4111111111111111",
    "expiryMonth": "12",
    "expiryYear": "2030",
    "cvv": "123",
    "cardHolderName": "Test Customer",
})
pci_token = tokenized.json()["data"]["pciToken"]

[$status, $tokenized] = auxcore('POST', '/tokenize-card', [
    'cardNumber' => '4111111111111111',
    'expiryMonth' => '12',
    'expiryYear' => '2030',
    'cvv' => '123',
    'cardHolderName' => 'Test Customer',
]);
$pciToken = $tokenized['data']['pciToken'];

curl -X POST "$BASE_URL/transaction" \
  -H "x-api-key: $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "Amount": 10.00,
    "SuggestedMode": "Card",
    "pciToken": "'"$PCI_TOKEN"'",
    "BillingCustomerName": "Test Customer",
    "BillingEmail": "test@example.com",
    "BillingPostalCode": "78701"
  }'

# Copy data.TransactionId from the response
export TRANSACTION_ID="550e8400-e29b-41d4-a716-446655440020"

const sale = await auxcore('POST', '/transaction', {
  Amount: 10.0,
  SuggestedMode: 'Card',
  pciToken,
  BillingCustomerName: 'Test Customer',
  BillingEmail: 'test@example.com',
  BillingPostalCode: '78701',
});
const transactionId = sale.body.data.TransactionId;
console.log(sale.status, sale.body.data.Status); // 200 "1" = approved

sale = session.post(f"{BASE_URL}/transaction", json={
    "Amount": 10.00,
    "SuggestedMode": "Card",
    "pciToken": pci_token,
    "BillingCustomerName": "Test Customer",
    "BillingEmail": "test@example.com",
    "BillingPostalCode": "78701",
})
transaction_id = sale.json()["data"]["TransactionId"]
print(sale.status_code, sale.json()["data"]["Status"])  # 200 "1" = approved

[$status, $sale] = auxcore('POST', '/transaction', [
    'Amount' => 10.00,
    'SuggestedMode' => 'Card',
    'pciToken' => $pciToken,
    'BillingCustomerName' => 'Test Customer',
    'BillingEmail' => 'test@example.com',
    'BillingPostalCode' => '78701',
]);
$transactionId = $sale['data']['TransactionId'];
echo $status, ' ', $sale['data']['Status'], PHP_EOL; // 200 "1" = approved

curl "$BASE_URL/transaction/$TRANSACTION_ID" \
  -H "x-api-key: $API_KEY"

const lookup = await auxcore('GET', `/transaction/${transactionId}`);
console.log(lookup.body.data);

lookup = session.get(f"{BASE_URL}/transaction/{transaction_id}")
print(lookup.json()["data"])

[$status, $lookup] = auxcore('GET', '/transaction/' . $transactionId);
print_r($lookup['data']);

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

const refund = await auxcore('POST', '/refund', { transactionId });
console.log(refund.status, refund.body.message);

refund = session.post(f"{BASE_URL}/refund", json={"transactionId": transaction_id})
print(refund.status_code, refund.json()["message"])

[$status, $refund] = auxcore('POST', '/refund', ['transactionId' => $transactionId]);
echo $status, ' ', $refund['message'], PHP_EOL;