Card Transaction
curl --request POST \
--url https://dev-api.auxvault.net/api/v1/public/transaction \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"Amount": 10.5,
"BillingCountry": "USA",
"BillingCountryCode": "+1",
"BillingCustomerName": "John Doe",
"BillingEmail": "john.doe@example.com",
"BillingPhoneNumber": "555-123-4567",
"BillingPostalCode": "12345",
"CardNumber": "4111111111111111",
"Cvv": "123",
"ExpiryDate": "1225",
"SuggestedMode": "Card",
"ConvenienceFeeActive": true,
"IpAddress": "192.168.1.1",
"BillingAddress": "123 Main St",
"BillingCity": "Anytown",
"BillingState": "CA",
"ShippingSameAsBilling": true,
"ShippingCustomerName": "<string>",
"ShippingEmail": "<string>",
"ShippingPhoneNumber": "<string>",
"ShippingAddress": "<string>",
"ShippingCountry": "<string>",
"ShippingCity": "<string>",
"ShippingState": "<string>",
"ShippingPostalCode": "<string>",
"TransactionType": "<string>",
"PaymentTokenization": true
}
'import requests
url = "https://dev-api.auxvault.net/api/v1/public/transaction"
payload = {
"Amount": 10.5,
"BillingCountry": "USA",
"BillingCountryCode": "+1",
"BillingCustomerName": "John Doe",
"BillingEmail": "john.doe@example.com",
"BillingPhoneNumber": "555-123-4567",
"BillingPostalCode": "12345",
"CardNumber": "4111111111111111",
"Cvv": "123",
"ExpiryDate": "1225",
"SuggestedMode": "Card",
"ConvenienceFeeActive": True,
"IpAddress": "192.168.1.1",
"BillingAddress": "123 Main St",
"BillingCity": "Anytown",
"BillingState": "CA",
"ShippingSameAsBilling": True,
"ShippingCustomerName": "<string>",
"ShippingEmail": "<string>",
"ShippingPhoneNumber": "<string>",
"ShippingAddress": "<string>",
"ShippingCountry": "<string>",
"ShippingCity": "<string>",
"ShippingState": "<string>",
"ShippingPostalCode": "<string>",
"TransactionType": "<string>",
"PaymentTokenization": True
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
Amount: 10.5,
BillingCountry: 'USA',
BillingCountryCode: '+1',
BillingCustomerName: 'John Doe',
BillingEmail: 'john.doe@example.com',
BillingPhoneNumber: '555-123-4567',
BillingPostalCode: '12345',
CardNumber: '4111111111111111',
Cvv: '123',
ExpiryDate: '1225',
SuggestedMode: 'Card',
ConvenienceFeeActive: true,
IpAddress: '192.168.1.1',
BillingAddress: '123 Main St',
BillingCity: 'Anytown',
BillingState: 'CA',
ShippingSameAsBilling: true,
ShippingCustomerName: '<string>',
ShippingEmail: '<string>',
ShippingPhoneNumber: '<string>',
ShippingAddress: '<string>',
ShippingCountry: '<string>',
ShippingCity: '<string>',
ShippingState: '<string>',
ShippingPostalCode: '<string>',
TransactionType: '<string>',
PaymentTokenization: true
})
};
fetch('https://dev-api.auxvault.net/api/v1/public/transaction', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://dev-api.auxvault.net/api/v1/public/transaction",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'Amount' => 10.5,
'BillingCountry' => 'USA',
'BillingCountryCode' => '+1',
'BillingCustomerName' => 'John Doe',
'BillingEmail' => 'john.doe@example.com',
'BillingPhoneNumber' => '555-123-4567',
'BillingPostalCode' => '12345',
'CardNumber' => '4111111111111111',
'Cvv' => '123',
'ExpiryDate' => '1225',
'SuggestedMode' => 'Card',
'ConvenienceFeeActive' => true,
'IpAddress' => '192.168.1.1',
'BillingAddress' => '123 Main St',
'BillingCity' => 'Anytown',
'BillingState' => 'CA',
'ShippingSameAsBilling' => true,
'ShippingCustomerName' => '<string>',
'ShippingEmail' => '<string>',
'ShippingPhoneNumber' => '<string>',
'ShippingAddress' => '<string>',
'ShippingCountry' => '<string>',
'ShippingCity' => '<string>',
'ShippingState' => '<string>',
'ShippingPostalCode' => '<string>',
'TransactionType' => '<string>',
'PaymentTokenization' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://dev-api.auxvault.net/api/v1/public/transaction"
payload := strings.NewReader("{\n \"Amount\": 10.5,\n \"BillingCountry\": \"USA\",\n \"BillingCountryCode\": \"+1\",\n \"BillingCustomerName\": \"John Doe\",\n \"BillingEmail\": \"john.doe@example.com\",\n \"BillingPhoneNumber\": \"555-123-4567\",\n \"BillingPostalCode\": \"12345\",\n \"CardNumber\": \"4111111111111111\",\n \"Cvv\": \"123\",\n \"ExpiryDate\": \"1225\",\n \"SuggestedMode\": \"Card\",\n \"ConvenienceFeeActive\": true,\n \"IpAddress\": \"192.168.1.1\",\n \"BillingAddress\": \"123 Main St\",\n \"BillingCity\": \"Anytown\",\n \"BillingState\": \"CA\",\n \"ShippingSameAsBilling\": true,\n \"ShippingCustomerName\": \"<string>\",\n \"ShippingEmail\": \"<string>\",\n \"ShippingPhoneNumber\": \"<string>\",\n \"ShippingAddress\": \"<string>\",\n \"ShippingCountry\": \"<string>\",\n \"ShippingCity\": \"<string>\",\n \"ShippingState\": \"<string>\",\n \"ShippingPostalCode\": \"<string>\",\n \"TransactionType\": \"<string>\",\n \"PaymentTokenization\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://dev-api.auxvault.net/api/v1/public/transaction")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"Amount\": 10.5,\n \"BillingCountry\": \"USA\",\n \"BillingCountryCode\": \"+1\",\n \"BillingCustomerName\": \"John Doe\",\n \"BillingEmail\": \"john.doe@example.com\",\n \"BillingPhoneNumber\": \"555-123-4567\",\n \"BillingPostalCode\": \"12345\",\n \"CardNumber\": \"4111111111111111\",\n \"Cvv\": \"123\",\n \"ExpiryDate\": \"1225\",\n \"SuggestedMode\": \"Card\",\n \"ConvenienceFeeActive\": true,\n \"IpAddress\": \"192.168.1.1\",\n \"BillingAddress\": \"123 Main St\",\n \"BillingCity\": \"Anytown\",\n \"BillingState\": \"CA\",\n \"ShippingSameAsBilling\": true,\n \"ShippingCustomerName\": \"<string>\",\n \"ShippingEmail\": \"<string>\",\n \"ShippingPhoneNumber\": \"<string>\",\n \"ShippingAddress\": \"<string>\",\n \"ShippingCountry\": \"<string>\",\n \"ShippingCity\": \"<string>\",\n \"ShippingState\": \"<string>\",\n \"ShippingPostalCode\": \"<string>\",\n \"TransactionType\": \"<string>\",\n \"PaymentTokenization\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://dev-api.auxvault.net/api/v1/public/transaction")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"Amount\": 10.5,\n \"BillingCountry\": \"USA\",\n \"BillingCountryCode\": \"+1\",\n \"BillingCustomerName\": \"John Doe\",\n \"BillingEmail\": \"john.doe@example.com\",\n \"BillingPhoneNumber\": \"555-123-4567\",\n \"BillingPostalCode\": \"12345\",\n \"CardNumber\": \"4111111111111111\",\n \"Cvv\": \"123\",\n \"ExpiryDate\": \"1225\",\n \"SuggestedMode\": \"Card\",\n \"ConvenienceFeeActive\": true,\n \"IpAddress\": \"192.168.1.1\",\n \"BillingAddress\": \"123 Main St\",\n \"BillingCity\": \"Anytown\",\n \"BillingState\": \"CA\",\n \"ShippingSameAsBilling\": true,\n \"ShippingCustomerName\": \"<string>\",\n \"ShippingEmail\": \"<string>\",\n \"ShippingPhoneNumber\": \"<string>\",\n \"ShippingAddress\": \"<string>\",\n \"ShippingCountry\": \"<string>\",\n \"ShippingCity\": \"<string>\",\n \"ShippingState\": \"<string>\",\n \"ShippingPostalCode\": \"<string>\",\n \"TransactionType\": \"<string>\",\n \"PaymentTokenization\": true\n}"
response = http.request(request)
puts response.read_body{
"status": "success",
"status_code": 100,
"message": "Transaction Processed Successfully",
"data": {
"TransactionId": "d0snjfv0i479rlkc66v0",
"BaseAmount": 10,
"Amount": 10,
"CardNumber": "1111",
"BillingEmail": "federico@gmail.com",
"BillingCustomerName": "Federico",
"BillingAddress": "",
"BillingCity": "",
"BillingState": null,
"BillingPostalCode": "",
"BillingCountry": 1,
"BillingCountryCode": "+1",
"BillingPhoneNumber": "876543200",
"TransactionType": 1,
"Status": "1"
}
}{
"status": "failed",
"status_code": 400,
"msg": "bad request error: invalid Postal Code"
}{
"status": "failed",
"status_code": 401,
"msg": "Unauthorized: Invalid API Key"
}API Reference
Card Transaction
Process a credit card or ACH payment.
POST
/
transaction
Card Transaction
curl --request POST \
--url https://dev-api.auxvault.net/api/v1/public/transaction \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"Amount": 10.5,
"BillingCountry": "USA",
"BillingCountryCode": "+1",
"BillingCustomerName": "John Doe",
"BillingEmail": "john.doe@example.com",
"BillingPhoneNumber": "555-123-4567",
"BillingPostalCode": "12345",
"CardNumber": "4111111111111111",
"Cvv": "123",
"ExpiryDate": "1225",
"SuggestedMode": "Card",
"ConvenienceFeeActive": true,
"IpAddress": "192.168.1.1",
"BillingAddress": "123 Main St",
"BillingCity": "Anytown",
"BillingState": "CA",
"ShippingSameAsBilling": true,
"ShippingCustomerName": "<string>",
"ShippingEmail": "<string>",
"ShippingPhoneNumber": "<string>",
"ShippingAddress": "<string>",
"ShippingCountry": "<string>",
"ShippingCity": "<string>",
"ShippingState": "<string>",
"ShippingPostalCode": "<string>",
"TransactionType": "<string>",
"PaymentTokenization": true
}
'import requests
url = "https://dev-api.auxvault.net/api/v1/public/transaction"
payload = {
"Amount": 10.5,
"BillingCountry": "USA",
"BillingCountryCode": "+1",
"BillingCustomerName": "John Doe",
"BillingEmail": "john.doe@example.com",
"BillingPhoneNumber": "555-123-4567",
"BillingPostalCode": "12345",
"CardNumber": "4111111111111111",
"Cvv": "123",
"ExpiryDate": "1225",
"SuggestedMode": "Card",
"ConvenienceFeeActive": True,
"IpAddress": "192.168.1.1",
"BillingAddress": "123 Main St",
"BillingCity": "Anytown",
"BillingState": "CA",
"ShippingSameAsBilling": True,
"ShippingCustomerName": "<string>",
"ShippingEmail": "<string>",
"ShippingPhoneNumber": "<string>",
"ShippingAddress": "<string>",
"ShippingCountry": "<string>",
"ShippingCity": "<string>",
"ShippingState": "<string>",
"ShippingPostalCode": "<string>",
"TransactionType": "<string>",
"PaymentTokenization": True
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
Amount: 10.5,
BillingCountry: 'USA',
BillingCountryCode: '+1',
BillingCustomerName: 'John Doe',
BillingEmail: 'john.doe@example.com',
BillingPhoneNumber: '555-123-4567',
BillingPostalCode: '12345',
CardNumber: '4111111111111111',
Cvv: '123',
ExpiryDate: '1225',
SuggestedMode: 'Card',
ConvenienceFeeActive: true,
IpAddress: '192.168.1.1',
BillingAddress: '123 Main St',
BillingCity: 'Anytown',
BillingState: 'CA',
ShippingSameAsBilling: true,
ShippingCustomerName: '<string>',
ShippingEmail: '<string>',
ShippingPhoneNumber: '<string>',
ShippingAddress: '<string>',
ShippingCountry: '<string>',
ShippingCity: '<string>',
ShippingState: '<string>',
ShippingPostalCode: '<string>',
TransactionType: '<string>',
PaymentTokenization: true
})
};
fetch('https://dev-api.auxvault.net/api/v1/public/transaction', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://dev-api.auxvault.net/api/v1/public/transaction",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'Amount' => 10.5,
'BillingCountry' => 'USA',
'BillingCountryCode' => '+1',
'BillingCustomerName' => 'John Doe',
'BillingEmail' => 'john.doe@example.com',
'BillingPhoneNumber' => '555-123-4567',
'BillingPostalCode' => '12345',
'CardNumber' => '4111111111111111',
'Cvv' => '123',
'ExpiryDate' => '1225',
'SuggestedMode' => 'Card',
'ConvenienceFeeActive' => true,
'IpAddress' => '192.168.1.1',
'BillingAddress' => '123 Main St',
'BillingCity' => 'Anytown',
'BillingState' => 'CA',
'ShippingSameAsBilling' => true,
'ShippingCustomerName' => '<string>',
'ShippingEmail' => '<string>',
'ShippingPhoneNumber' => '<string>',
'ShippingAddress' => '<string>',
'ShippingCountry' => '<string>',
'ShippingCity' => '<string>',
'ShippingState' => '<string>',
'ShippingPostalCode' => '<string>',
'TransactionType' => '<string>',
'PaymentTokenization' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://dev-api.auxvault.net/api/v1/public/transaction"
payload := strings.NewReader("{\n \"Amount\": 10.5,\n \"BillingCountry\": \"USA\",\n \"BillingCountryCode\": \"+1\",\n \"BillingCustomerName\": \"John Doe\",\n \"BillingEmail\": \"john.doe@example.com\",\n \"BillingPhoneNumber\": \"555-123-4567\",\n \"BillingPostalCode\": \"12345\",\n \"CardNumber\": \"4111111111111111\",\n \"Cvv\": \"123\",\n \"ExpiryDate\": \"1225\",\n \"SuggestedMode\": \"Card\",\n \"ConvenienceFeeActive\": true,\n \"IpAddress\": \"192.168.1.1\",\n \"BillingAddress\": \"123 Main St\",\n \"BillingCity\": \"Anytown\",\n \"BillingState\": \"CA\",\n \"ShippingSameAsBilling\": true,\n \"ShippingCustomerName\": \"<string>\",\n \"ShippingEmail\": \"<string>\",\n \"ShippingPhoneNumber\": \"<string>\",\n \"ShippingAddress\": \"<string>\",\n \"ShippingCountry\": \"<string>\",\n \"ShippingCity\": \"<string>\",\n \"ShippingState\": \"<string>\",\n \"ShippingPostalCode\": \"<string>\",\n \"TransactionType\": \"<string>\",\n \"PaymentTokenization\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://dev-api.auxvault.net/api/v1/public/transaction")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"Amount\": 10.5,\n \"BillingCountry\": \"USA\",\n \"BillingCountryCode\": \"+1\",\n \"BillingCustomerName\": \"John Doe\",\n \"BillingEmail\": \"john.doe@example.com\",\n \"BillingPhoneNumber\": \"555-123-4567\",\n \"BillingPostalCode\": \"12345\",\n \"CardNumber\": \"4111111111111111\",\n \"Cvv\": \"123\",\n \"ExpiryDate\": \"1225\",\n \"SuggestedMode\": \"Card\",\n \"ConvenienceFeeActive\": true,\n \"IpAddress\": \"192.168.1.1\",\n \"BillingAddress\": \"123 Main St\",\n \"BillingCity\": \"Anytown\",\n \"BillingState\": \"CA\",\n \"ShippingSameAsBilling\": true,\n \"ShippingCustomerName\": \"<string>\",\n \"ShippingEmail\": \"<string>\",\n \"ShippingPhoneNumber\": \"<string>\",\n \"ShippingAddress\": \"<string>\",\n \"ShippingCountry\": \"<string>\",\n \"ShippingCity\": \"<string>\",\n \"ShippingState\": \"<string>\",\n \"ShippingPostalCode\": \"<string>\",\n \"TransactionType\": \"<string>\",\n \"PaymentTokenization\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://dev-api.auxvault.net/api/v1/public/transaction")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"Amount\": 10.5,\n \"BillingCountry\": \"USA\",\n \"BillingCountryCode\": \"+1\",\n \"BillingCustomerName\": \"John Doe\",\n \"BillingEmail\": \"john.doe@example.com\",\n \"BillingPhoneNumber\": \"555-123-4567\",\n \"BillingPostalCode\": \"12345\",\n \"CardNumber\": \"4111111111111111\",\n \"Cvv\": \"123\",\n \"ExpiryDate\": \"1225\",\n \"SuggestedMode\": \"Card\",\n \"ConvenienceFeeActive\": true,\n \"IpAddress\": \"192.168.1.1\",\n \"BillingAddress\": \"123 Main St\",\n \"BillingCity\": \"Anytown\",\n \"BillingState\": \"CA\",\n \"ShippingSameAsBilling\": true,\n \"ShippingCustomerName\": \"<string>\",\n \"ShippingEmail\": \"<string>\",\n \"ShippingPhoneNumber\": \"<string>\",\n \"ShippingAddress\": \"<string>\",\n \"ShippingCountry\": \"<string>\",\n \"ShippingCity\": \"<string>\",\n \"ShippingState\": \"<string>\",\n \"ShippingPostalCode\": \"<string>\",\n \"TransactionType\": \"<string>\",\n \"PaymentTokenization\": true\n}"
response = http.request(request)
puts response.read_body{
"status": "success",
"status_code": 100,
"message": "Transaction Processed Successfully",
"data": {
"TransactionId": "d0snjfv0i479rlkc66v0",
"BaseAmount": 10,
"Amount": 10,
"CardNumber": "1111",
"BillingEmail": "federico@gmail.com",
"BillingCustomerName": "Federico",
"BillingAddress": "",
"BillingCity": "",
"BillingState": null,
"BillingPostalCode": "",
"BillingCountry": 1,
"BillingCountryCode": "+1",
"BillingPhoneNumber": "876543200",
"TransactionType": 1,
"Status": "1"
}
}{
"status": "failed",
"status_code": 400,
"msg": "bad request error: invalid Postal Code"
}{
"status": "failed",
"status_code": 401,
"msg": "Unauthorized: Invalid API Key"
}Authorizations
Body
application/json
Example:
10.5
Example:
"USA"
Example:
"+1"
Example:
"John Doe"
Example:
"john.doe@example.com"
Example:
"555-123-4567"
Example:
"12345"
Example:
"4111111111111111"
Example:
"123"
Example:
"1225"
Example:
"Card"
Example:
"192.168.1.1"
Example:
"123 Main St"
Example:
"Anytown"
Example:
"CA"
1 for Sale, 2 for Auth
Response
Successful Response
