FroogalPay

API Calls

addCardToVaultGet

This query can be used in 2 different scenarios: 1. With an IDTech swiper : you will only need to pass the following parameters : `username`, `apikey`, `ksn`, `track1`. 2. Manual input : leave `ksn` and `track1` parameters empty.


/AddCardToVault

Usage and SDK Samples


curl -X get -H "apiKey: [[apiKey]]" -H "apiSecret: [[apiSecret]]" "https://www.froogalpay.com/JSON/Service.svc/AddCardToVault?username=&password=&apikey=&devicecode=&ksn=&track1=&name=&streetaddress=&city=&state=&zipcode=&cardnumber=&expdate=&cvv=&email="



import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import .DefaultApi;

import java.io.File;
import java.util.*;

public class DefaultApiExample {

    public static void main(String[] args) {
        
        DefaultApi apiInstance = new DefaultApi();
        String username = username_example; // String | Username
        String apikey = apikey_example; // String | API Key
        String password = password_example; // String | Password (for additional security)
        String devicecode = devicecode_example; // String | Device Code (if using multiple devices)
        String ksn = ksn_example; // String | KSN (provide when using swiper)
        String track1 = track1_example; // String | Track1 (provide when using swiper)
        String name = name_example; // String | Cardholder Name
        String streetaddress = streetaddress_example; // String | Street Adress
        String city = city_example; // String | City
        String state = state_example; // String | State
        String zipcode = zipcode_example; // String | Zip Code
        String cardnumber = cardnumber_example; // String | Card Number
        String expdate = expdate_example; // String | Expiration Date (MMYY)
        String cvv = cvv_example; // String | CVV Code
        String email = email_example; // String | Email
        try {
            CreditTransactionResponse result = apiInstance.addCardToVaultGet(username, apikey, password, devicecode, ksn, track1, name, streetaddress, city, state, zipcode, cardnumber, expdate, cvv, email);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#addCardToVaultGet");
            e.printStackTrace();
        }
    }
}

                                                  

import .DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String username = username_example; // String | Username
        String apikey = apikey_example; // String | API Key
        String password = password_example; // String | Password (for additional security)
        String devicecode = devicecode_example; // String | Device Code (if using multiple devices)
        String ksn = ksn_example; // String | KSN (provide when using swiper)
        String track1 = track1_example; // String | Track1 (provide when using swiper)
        String name = name_example; // String | Cardholder Name
        String streetaddress = streetaddress_example; // String | Street Adress
        String city = city_example; // String | City
        String state = state_example; // String | State
        String zipcode = zipcode_example; // String | Zip Code
        String cardnumber = cardnumber_example; // String | Card Number
        String expdate = expdate_example; // String | Expiration Date (MMYY)
        String cvv = cvv_example; // String | CVV Code
        String email = email_example; // String | Email
        try {
            CreditTransactionResponse result = apiInstance.addCardToVaultGet(username, apikey, password, devicecode, ksn, track1, name, streetaddress, city, state, zipcode, cardnumber, expdate, cvv, email);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#addCardToVaultGet");
            e.printStackTrace();
        }
    }
}

                                                  


String *username = username_example; // Username
String *apikey = apikey_example; // API Key
String *password = password_example; // Password (for additional security) (optional)
String *devicecode = devicecode_example; // Device Code (if using multiple devices) (optional)
String *ksn = ksn_example; // KSN (provide when using swiper) (optional)
String *track1 = track1_example; // Track1 (provide when using swiper) (optional)
String *name = name_example; // Cardholder Name (optional)
String *streetaddress = streetaddress_example; // Street Adress (optional)
String *city = city_example; // City (optional)
String *state = state_example; // State (optional)
String *zipcode = zipcode_example; // Zip Code (optional)
String *cardnumber = cardnumber_example; // Card Number (optional)
String *expdate = expdate_example; // Expiration Date (MMYY) (optional)
String *cvv = cvv_example; // CVV Code (optional)
String *email = email_example; // Email (optional)

DefaultApi *apiInstance = [[DefaultApi alloc] init];

// Adds the card to the card vault. Card can then be processed by calling /CardVaultTransaction 
[apiInstance addCardToVaultGetWith:username
    apikey:apikey
    password:password
    devicecode:devicecode
    ksn:ksn
    track1:track1
    name:name
    streetaddress:streetaddress
    city:city
    state:state
    zipcode:zipcode
    cardnumber:cardnumber
    expdate:expdate
    cvv:cvv
    email:email
              completionHandler: ^(CreditTransactionResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

                                                    

var  = require('');

var api = new .DefaultApi()

var username = username_example; // {String} Username

var apikey = apikey_example; // {String} API Key

var opts = { 
  'password': password_example, // {String} Password (for additional security)
  'devicecode': devicecode_example, // {String} Device Code (if using multiple devices)
  'ksn': ksn_example, // {String} KSN (provide when using swiper)
  'track1': track1_example, // {String} Track1 (provide when using swiper)
  'name': name_example, // {String} Cardholder Name
  'streetaddress': streetaddress_example, // {String} Street Adress
  'city': city_example, // {String} City
  'state': state_example, // {String} State
  'zipcode': zipcode_example, // {String} Zip Code
  'cardnumber': cardnumber_example, // {String} Card Number
  'expdate': expdate_example, // {String} Expiration Date (MMYY)
  'cvv': cvv_example, // {String} CVV Code
  'email': email_example // {String} Email
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.addCardToVaultGet(username, apikey, opts, callback);

                                                    

using System;
using System.Diagnostics;
using .Api;
using .Client;
using ;

namespace Example
{
    public class addCardToVaultGetExample
    {
        public void main()
        {
            
            var apiInstance = new DefaultApi();
            var username = username_example;  // String | Username
            var apikey = apikey_example;  // String | API Key
            var password = password_example;  // String | Password (for additional security) (optional) 
            var devicecode = devicecode_example;  // String | Device Code (if using multiple devices) (optional) 
            var ksn = ksn_example;  // String | KSN (provide when using swiper) (optional) 
            var track1 = track1_example;  // String | Track1 (provide when using swiper) (optional) 
            var name = name_example;  // String | Cardholder Name (optional) 
            var streetaddress = streetaddress_example;  // String | Street Adress (optional) 
            var city = city_example;  // String | City (optional) 
            var state = state_example;  // String | State (optional) 
            var zipcode = zipcode_example;  // String | Zip Code (optional) 
            var cardnumber = cardnumber_example;  // String | Card Number (optional) 
            var expdate = expdate_example;  // String | Expiration Date (MMYY) (optional) 
            var cvv = cvv_example;  // String | CVV Code (optional) 
            var email = email_example;  // String | Email (optional) 

            try
            {
                // Adds the card to the card vault. Card can then be processed by calling /CardVaultTransaction 
                CreditTransactionResponse result = apiInstance.addCardToVaultGet(username, apikey, password, devicecode, ksn, track1, name, streetaddress, city, state, zipcode, cardnumber, expdate, cvv, email);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.addCardToVaultGet: " + e.Message );
            }
        }
    }
}

                                                    

addCardToVaultGet($username, $apikey, $password, $devicecode, $ksn, $track1, $name, $streetaddress, $city, $state, $zipcode, $cardnumber, $expdate, $cvv, $email);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->addCardToVaultGet: ', $e->getMessage(), PHP_EOL;
}

                                                  

Parameters

Query parameters
Name Description
username*
password
apikey*
devicecode
ksn
track1
name
streetaddress
city
state
zipcode
cardnumber
expdate
cvv
email

Responses

Status: 200 - Successful response

Status: 400 - Error response


cardVaultTransactionGet


/CardVaultTransaction

Usage and SDK Samples


curl -X get -H "apiKey: [[apiKey]]" -H "apiSecret: [[apiSecret]]" "https://www.froogalpay.com/JSON/Service.svc/CardVaultTransaction?username=&password=&apikey=&devicecode=&amount=&transactionId=&invoice=&paymentType="



import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import .DefaultApi;

import java.io.File;
import java.util.*;

public class DefaultApiExample {

    public static void main(String[] args) {
        
        DefaultApi apiInstance = new DefaultApi();
        String username = username_example; // String | Username
        String apikey = apikey_example; // String | API Key
        Double amount = 1.2; // Double | Transaction amount
        Long transactionId = 789; // Long | /AddToCardVault transaction Id
        String password = password_example; // String | Password (for additional security)
        String devicecode = devicecode_example; // String | Device Code (if using multiple devices)
        String invoice = invoice_example; // String | Invoice number (if applicable)
        Long paymentType = 789; // Long | 33 = InitialDeposit, 34 = AdditionalDeposit, 35 = FinalPayment
        try {
            CreditTransactionResponse result = apiInstance.cardVaultTransactionGet(username, apikey, amount, transactionId, password, devicecode, invoice, paymentType);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#cardVaultTransactionGet");
            e.printStackTrace();
        }
    }
}

                                                  

import .DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String username = username_example; // String | Username
        String apikey = apikey_example; // String | API Key
        Double amount = 1.2; // Double | Transaction amount
        Long transactionId = 789; // Long | /AddToCardVault transaction Id
        String password = password_example; // String | Password (for additional security)
        String devicecode = devicecode_example; // String | Device Code (if using multiple devices)
        String invoice = invoice_example; // String | Invoice number (if applicable)
        Long paymentType = 789; // Long | 33 = InitialDeposit, 34 = AdditionalDeposit, 35 = FinalPayment
        try {
            CreditTransactionResponse result = apiInstance.cardVaultTransactionGet(username, apikey, amount, transactionId, password, devicecode, invoice, paymentType);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#cardVaultTransactionGet");
            e.printStackTrace();
        }
    }
}

                                                  


String *username = username_example; // Username
String *apikey = apikey_example; // API Key
Double *amount = 1.2; // Transaction amount
Long *transactionId = 789; // /AddToCardVault transaction Id
String *password = password_example; // Password (for additional security) (optional)
String *devicecode = devicecode_example; // Device Code (if using multiple devices) (optional)
String *invoice = invoice_example; // Invoice number (if applicable) (optional)
Long *paymentType = 789; // 33 = InitialDeposit, 34 = AdditionalDeposit, 35 = FinalPayment (optional)

DefaultApi *apiInstance = [[DefaultApi alloc] init];

// Perform card vault transaction. 
[apiInstance cardVaultTransactionGetWith:username
    apikey:apikey
    amount:amount
    transactionId:transactionId
    password:password
    devicecode:devicecode
    invoice:invoice
    paymentType:paymentType
              completionHandler: ^(CreditTransactionResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

                                                    

var  = require('');

var api = new .DefaultApi()

var username = username_example; // {String} Username

var apikey = apikey_example; // {String} API Key

var amount = 1.2; // {Double} Transaction amount

var transactionId = 789; // {Long} /AddToCardVault transaction Id

var opts = { 
  'password': password_example, // {String} Password (for additional security)
  'devicecode': devicecode_example, // {String} Device Code (if using multiple devices)
  'invoice': invoice_example, // {String} Invoice number (if applicable)
  'paymentType': 789 // {Long} 33 = InitialDeposit, 34 = AdditionalDeposit, 35 = FinalPayment
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.cardVaultTransactionGet(username, apikey, amount, transactionId, opts, callback);

                                                    

using System;
using System.Diagnostics;
using .Api;
using .Client;
using ;

namespace Example
{
    public class cardVaultTransactionGetExample
    {
        public void main()
        {
            
            var apiInstance = new DefaultApi();
            var username = username_example;  // String | Username
            var apikey = apikey_example;  // String | API Key
            var amount = 1.2;  // Double | Transaction amount
            var transactionId = 789;  // Long | /AddToCardVault transaction Id
            var password = password_example;  // String | Password (for additional security) (optional) 
            var devicecode = devicecode_example;  // String | Device Code (if using multiple devices) (optional) 
            var invoice = invoice_example;  // String | Invoice number (if applicable) (optional) 
            var paymentType = 789;  // Long | 33 = InitialDeposit, 34 = AdditionalDeposit, 35 = FinalPayment (optional) 

            try
            {
                // Perform card vault transaction. 
                CreditTransactionResponse result = apiInstance.cardVaultTransactionGet(username, apikey, amount, transactionId, password, devicecode, invoice, paymentType);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.cardVaultTransactionGet: " + e.Message );
            }
        }
    }
}

                                                    

cardVaultTransactionGet($username, $apikey, $amount, $transactionId, $password, $devicecode, $invoice, $paymentType);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->cardVaultTransactionGet: ', $e->getMessage(), PHP_EOL;
}

                                                  

Parameters

Query parameters
Name Description
username*
password
apikey*
devicecode
amount*
transactionId*
invoice
paymentType

Responses

Status: 200 - Successful response

Status: 400 - Error response


createRecurringBillingGet


/CreateRecurringBilling

Usage and SDK Samples


curl -X get -H "apiKey: [[apiKey]]" -H "apiSecret: [[apiSecret]]" "https://www.froogalpay.com/JSON/Service.svc/CreateRecurringBilling?username=&password=&apikey=&devicecode=&transactionId=&amount=&frequency=&beginDate=&endDate="



import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import .DefaultApi;

import java.io.File;
import java.util.*;

public class DefaultApiExample {

    public static void main(String[] args) {
        
        DefaultApi apiInstance = new DefaultApi();
        String username = username_example; // String | Username
        String apikey = apikey_example; // String | API Key
        String transactionId = transactionId_example; // String | TransactionId of the card vault transaction
        Double amount = 1.2; // Double | Amount
        Long frequency = 789; // Long | View possible values in query description
        String beginDate = beginDate_example; // String | Recurring billing starting on (in \"yyyy-MM-dd\" format)
        String endDate = endDate_example; // String | Recurring billing ending on (in \"yyyy-MM-dd\" format)
        String password = password_example; // String | Password (for additional security)
        String devicecode = devicecode_example; // String | Device Code (if using multiple devices)
        try {
            CreateRecurringResponse result = apiInstance.createRecurringBillingGet(username, apikey, transactionId, amount, frequency, beginDate, endDate, password, devicecode);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#createRecurringBillingGet");
            e.printStackTrace();
        }
    }
}

                                                  

import .DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String username = username_example; // String | Username
        String apikey = apikey_example; // String | API Key
        String transactionId = transactionId_example; // String | TransactionId of the card vault transaction
        Double amount = 1.2; // Double | Amount
        Long frequency = 789; // Long | View possible values in query description
        String beginDate = beginDate_example; // String | Recurring billing starting on (in \"yyyy-MM-dd\" format)
        String endDate = endDate_example; // String | Recurring billing ending on (in \"yyyy-MM-dd\" format)
        String password = password_example; // String | Password (for additional security)
        String devicecode = devicecode_example; // String | Device Code (if using multiple devices)
        try {
            CreateRecurringResponse result = apiInstance.createRecurringBillingGet(username, apikey, transactionId, amount, frequency, beginDate, endDate, password, devicecode);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#createRecurringBillingGet");
            e.printStackTrace();
        }
    }
}

                                                  


String *username = username_example; // Username
String *apikey = apikey_example; // API Key
String *transactionId = transactionId_example; // TransactionId of the card vault transaction
Double *amount = 1.2; // Amount
Long *frequency = 789; // View possible values in query description
String *beginDate = beginDate_example; // Recurring billing starting on (in \"yyyy-MM-dd\" format)
String *endDate = endDate_example; // Recurring billing ending on (in \"yyyy-MM-dd\" format)
String *password = password_example; // Password (for additional security) (optional)
String *devicecode = devicecode_example; // Device Code (if using multiple devices) (optional)

DefaultApi *apiInstance = [[DefaultApi alloc] init];

// Before creating a Recurring billing rule you must add a card to the card vault and keep the original transaction id.     EveryDay = 54,     EveryWeek = 38,     Every_2_Weeks = 40,     Every_3_Weeks = 42,     Every_4_Weeks = 43,     Every_5_Weeks = 44,     Every_6_Weeks = 45,     Every_7_Weeks = 46,     Every_8_Weeks = 47,     EveryMonth = 49,     Every_2_Months = 50 
[apiInstance createRecurringBillingGetWith:username
    apikey:apikey
    transactionId:transactionId
    amount:amount
    frequency:frequency
    beginDate:beginDate
    endDate:endDate
    password:password
    devicecode:devicecode
              completionHandler: ^(CreateRecurringResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

                                                    

var  = require('');

var api = new .DefaultApi()

var username = username_example; // {String} Username

var apikey = apikey_example; // {String} API Key

var transactionId = transactionId_example; // {String} TransactionId of the card vault transaction

var amount = 1.2; // {Double} Amount

var frequency = 789; // {Long} View possible values in query description

var beginDate = beginDate_example; // {String} Recurring billing starting on (in \"yyyy-MM-dd\" format)

var endDate = endDate_example; // {String} Recurring billing ending on (in \"yyyy-MM-dd\" format)

var opts = { 
  'password': password_example, // {String} Password (for additional security)
  'devicecode': devicecode_example // {String} Device Code (if using multiple devices)
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createRecurringBillingGet(username, apikey, transactionId, amount, frequency, beginDate, endDate, opts, callback);

                                                    

using System;
using System.Diagnostics;
using .Api;
using .Client;
using ;

namespace Example
{
    public class createRecurringBillingGetExample
    {
        public void main()
        {
            
            var apiInstance = new DefaultApi();
            var username = username_example;  // String | Username
            var apikey = apikey_example;  // String | API Key
            var transactionId = transactionId_example;  // String | TransactionId of the card vault transaction
            var amount = 1.2;  // Double | Amount
            var frequency = 789;  // Long | View possible values in query description
            var beginDate = beginDate_example;  // String | Recurring billing starting on (in \"yyyy-MM-dd\" format)
            var endDate = endDate_example;  // String | Recurring billing ending on (in \"yyyy-MM-dd\" format)
            var password = password_example;  // String | Password (for additional security) (optional) 
            var devicecode = devicecode_example;  // String | Device Code (if using multiple devices) (optional) 

            try
            {
                // Before creating a Recurring billing rule you must add a card to the card vault and keep the original transaction id.     EveryDay = 54,     EveryWeek = 38,     Every_2_Weeks = 40,     Every_3_Weeks = 42,     Every_4_Weeks = 43,     Every_5_Weeks = 44,     Every_6_Weeks = 45,     Every_7_Weeks = 46,     Every_8_Weeks = 47,     EveryMonth = 49,     Every_2_Months = 50 
                CreateRecurringResponse result = apiInstance.createRecurringBillingGet(username, apikey, transactionId, amount, frequency, beginDate, endDate, password, devicecode);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.createRecurringBillingGet: " + e.Message );
            }
        }
    }
}

                                                    

createRecurringBillingGet($username, $apikey, $transactionId, $amount, $frequency, $beginDate, $endDate, $password, $devicecode);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->createRecurringBillingGet: ', $e->getMessage(), PHP_EOL;
}

                                                  

Parameters

Query parameters
Name Description
username*
password
apikey*
devicecode
transactionId*
amount*
frequency*
beginDate*
endDate*

Responses

Status: 200 - Successful response

Status: 400 - Error response


creditTransactionGet

This query can be used in 2 different scenarios: 1. With an IDTech swiper : you will only need to pass the following parameters : `username`, `apikey`, `amount`, `ksn`, `track1`, `addtovault`. 2. Manual input : leave `ksn` and `track1` parameters empty.


/CreditTransaction

Usage and SDK Samples


curl -X get -H "apiKey: [[apiKey]]" -H "apiSecret: [[apiSecret]]" "https://www.froogalpay.com/JSON/Service.svc/CreditTransaction?username=&password=&apikey=&devicecode=&amount=&ksn=&track1=&name=&invoice=&streetaddress=&city=&state=&zipcode=&cardnumber=&expdate=&cvv=&email=&addtovault=&magstripeData=&secureFormat=&tax="



import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import .DefaultApi;

import java.io.File;
import java.util.*;

public class DefaultApiExample {

    public static void main(String[] args) {
        
        DefaultApi apiInstance = new DefaultApi();
        String username = username_example; // String | Username
        String apikey = apikey_example; // String | API Key
        Double amount = 1.2; // Double | Transaction amount
        Boolean addtovault = true; // Boolean | Add card to vault (performs same operation as /AddCardToVault)
        String password = password_example; // String | Password (for additional security)
        String devicecode = devicecode_example; // String | Device Code (if using multiple devices)
        String ksn = ksn_example; // String | KSN (provide when using swiper)
        String track1 = track1_example; // String | Track1 (provide when using swiper)
        String name = name_example; // String | Cardholder Name
        String invoice = invoice_example; // String | Invoice number (if applicable)
        String streetaddress = streetaddress_example; // String | Street Adress
        String city = city_example; // String | City
        String state = state_example; // String | State
        String zipcode = zipcode_example; // String | Zip Code
        String cardnumber = cardnumber_example; // String | Card Number
        String expdate = expdate_example; // String | Expiration Date (MMYY)
        String cvv = cvv_example; // String | CVV Code
        String email = email_example; // String | Email
        String magstripeData = magstripeData_example; // String | magstripeData
        String secureFormat = secureFormat_example; // String | secureFormat
        String tax = tax_example; // String | tax
        try {
            CreditTransactionResponse result = apiInstance.creditTransactionGet(username, apikey, amount, addtovault, password, devicecode, ksn, track1, name, invoice, streetaddress, city, state, zipcode, cardnumber, expdate, cvv, email, magstripeData, secureFormat, tax);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#creditTransactionGet");
            e.printStackTrace();
        }
    }
}

                                                  

import .DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String username = username_example; // String | Username
        String apikey = apikey_example; // String | API Key
        Double amount = 1.2; // Double | Transaction amount
        Boolean addtovault = true; // Boolean | Add card to vault (performs same operation as /AddCardToVault)
        String password = password_example; // String | Password (for additional security)
        String devicecode = devicecode_example; // String | Device Code (if using multiple devices)
        String ksn = ksn_example; // String | KSN (provide when using swiper)
        String track1 = track1_example; // String | Track1 (provide when using swiper)
        String name = name_example; // String | Cardholder Name
        String invoice = invoice_example; // String | Invoice number (if applicable)
        String streetaddress = streetaddress_example; // String | Street Adress
        String city = city_example; // String | City
        String state = state_example; // String | State
        String zipcode = zipcode_example; // String | Zip Code
        String cardnumber = cardnumber_example; // String | Card Number
        String expdate = expdate_example; // String | Expiration Date (MMYY)
        String cvv = cvv_example; // String | CVV Code
        String email = email_example; // String | Email
        String magstripeData = magstripeData_example; // String | magstripeData
        String secureFormat = secureFormat_example; // String | secureFormat
        String tax = tax_example; // String | tax
        try {
            CreditTransactionResponse result = apiInstance.creditTransactionGet(username, apikey, amount, addtovault, password, devicecode, ksn, track1, name, invoice, streetaddress, city, state, zipcode, cardnumber, expdate, cvv, email, magstripeData, secureFormat, tax);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#creditTransactionGet");
            e.printStackTrace();
        }
    }
}

                                                  


String *username = username_example; // Username
String *apikey = apikey_example; // API Key
Double *amount = 1.2; // Transaction amount
Boolean *addtovault = true; // Add card to vault (performs same operation as /AddCardToVault)
String *password = password_example; // Password (for additional security) (optional)
String *devicecode = devicecode_example; // Device Code (if using multiple devices) (optional)
String *ksn = ksn_example; // KSN (provide when using swiper) (optional)
String *track1 = track1_example; // Track1 (provide when using swiper) (optional)
String *name = name_example; // Cardholder Name (optional)
String *invoice = invoice_example; // Invoice number (if applicable) (optional)
String *streetaddress = streetaddress_example; // Street Adress (optional)
String *city = city_example; // City (optional)
String *state = state_example; // State (optional)
String *zipcode = zipcode_example; // Zip Code (optional)
String *cardnumber = cardnumber_example; // Card Number (optional)
String *expdate = expdate_example; // Expiration Date (MMYY) (optional)
String *cvv = cvv_example; // CVV Code (optional)
String *email = email_example; // Email (optional)
String *magstripeData = magstripeData_example; // magstripeData (optional)
String *secureFormat = secureFormat_example; // secureFormat (optional)
String *tax = tax_example; // tax (optional)

DefaultApi *apiInstance = [[DefaultApi alloc] init];

// Perform credit card transaction. 
[apiInstance creditTransactionGetWith:username
    apikey:apikey
    amount:amount
    addtovault:addtovault
    password:password
    devicecode:devicecode
    ksn:ksn
    track1:track1
    name:name
    invoice:invoice
    streetaddress:streetaddress
    city:city
    state:state
    zipcode:zipcode
    cardnumber:cardnumber
    expdate:expdate
    cvv:cvv
    email:email
    magstripeData:magstripeData
    secureFormat:secureFormat
    tax:tax
              completionHandler: ^(CreditTransactionResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

                                                    

var  = require('');

var api = new .DefaultApi()

var username = username_example; // {String} Username

var apikey = apikey_example; // {String} API Key

var amount = 1.2; // {Double} Transaction amount

var addtovault = true; // {Boolean} Add card to vault (performs same operation as /AddCardToVault)

var opts = { 
  'password': password_example, // {String} Password (for additional security)
  'devicecode': devicecode_example, // {String} Device Code (if using multiple devices)
  'ksn': ksn_example, // {String} KSN (provide when using swiper)
  'track1': track1_example, // {String} Track1 (provide when using swiper)
  'name': name_example, // {String} Cardholder Name
  'invoice': invoice_example, // {String} Invoice number (if applicable)
  'streetaddress': streetaddress_example, // {String} Street Adress
  'city': city_example, // {String} City
  'state': state_example, // {String} State
  'zipcode': zipcode_example, // {String} Zip Code
  'cardnumber': cardnumber_example, // {String} Card Number
  'expdate': expdate_example, // {String} Expiration Date (MMYY)
  'cvv': cvv_example, // {String} CVV Code
  'email': email_example, // {String} Email
  'magstripeData': magstripeData_example, // {String} magstripeData
  'secureFormat': secureFormat_example, // {String} secureFormat
  'tax': tax_example // {String} tax
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.creditTransactionGet(username, apikey, amount, addtovault, opts, callback);

                                                    

using System;
using System.Diagnostics;
using .Api;
using .Client;
using ;

namespace Example
{
    public class creditTransactionGetExample
    {
        public void main()
        {
            
            var apiInstance = new DefaultApi();
            var username = username_example;  // String | Username
            var apikey = apikey_example;  // String | API Key
            var amount = 1.2;  // Double | Transaction amount
            var addtovault = true;  // Boolean | Add card to vault (performs same operation as /AddCardToVault)
            var password = password_example;  // String | Password (for additional security) (optional) 
            var devicecode = devicecode_example;  // String | Device Code (if using multiple devices) (optional) 
            var ksn = ksn_example;  // String | KSN (provide when using swiper) (optional) 
            var track1 = track1_example;  // String | Track1 (provide when using swiper) (optional) 
            var name = name_example;  // String | Cardholder Name (optional) 
            var invoice = invoice_example;  // String | Invoice number (if applicable) (optional) 
            var streetaddress = streetaddress_example;  // String | Street Adress (optional) 
            var city = city_example;  // String | City (optional) 
            var state = state_example;  // String | State (optional) 
            var zipcode = zipcode_example;  // String | Zip Code (optional) 
            var cardnumber = cardnumber_example;  // String | Card Number (optional) 
            var expdate = expdate_example;  // String | Expiration Date (MMYY) (optional) 
            var cvv = cvv_example;  // String | CVV Code (optional) 
            var email = email_example;  // String | Email (optional) 
            var magstripeData = magstripeData_example;  // String | magstripeData (optional) 
            var secureFormat = secureFormat_example;  // String | secureFormat (optional) 
            var tax = tax_example;  // String | tax (optional) 

            try
            {
                // Perform credit card transaction. 
                CreditTransactionResponse result = apiInstance.creditTransactionGet(username, apikey, amount, addtovault, password, devicecode, ksn, track1, name, invoice, streetaddress, city, state, zipcode, cardnumber, expdate, cvv, email, magstripeData, secureFormat, tax);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.creditTransactionGet: " + e.Message );
            }
        }
    }
}

                                                    

creditTransactionGet($username, $apikey, $amount, $addtovault, $password, $devicecode, $ksn, $track1, $name, $invoice, $streetaddress, $city, $state, $zipcode, $cardnumber, $expdate, $cvv, $email, $magstripeData, $secureFormat, $tax);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->creditTransactionGet: ', $e->getMessage(), PHP_EOL;
}

                                                  

Parameters

Query parameters
Name Description
username*
password
apikey*
devicecode
amount*
ksn
track1
name
invoice
streetaddress
city
state
zipcode
cardnumber
expdate
cvv
email
addtovault*
magstripeData
secureFormat
tax

Responses

Status: 200 - Successful response

Status: 400 - Error response


getLastCreditTransactionGet


/GetLastCreditTransaction

Usage and SDK Samples


curl -X get -H "apiKey: [[apiKey]]" -H "apiSecret: [[apiSecret]]" "https://www.froogalpay.com/JSON/Service.svc/GetLastCreditTransaction?username=&password=&apikey=&devicecode="



import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import .DefaultApi;

import java.io.File;
import java.util.*;

public class DefaultApiExample {

    public static void main(String[] args) {
        
        DefaultApi apiInstance = new DefaultApi();
        String username = username_example; // String | Username
        String apikey = apikey_example; // String | API Key
        String password = password_example; // String | Password (for additional security)
        String devicecode = devicecode_example; // String | Device Code (if using multiple devices)
        try {
            CreditTransactionResponse result = apiInstance.getLastCreditTransactionGet(username, apikey, password, devicecode);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#getLastCreditTransactionGet");
            e.printStackTrace();
        }
    }
}

                                                  

import .DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String username = username_example; // String | Username
        String apikey = apikey_example; // String | API Key
        String password = password_example; // String | Password (for additional security)
        String devicecode = devicecode_example; // String | Device Code (if using multiple devices)
        try {
            CreditTransactionResponse result = apiInstance.getLastCreditTransactionGet(username, apikey, password, devicecode);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#getLastCreditTransactionGet");
            e.printStackTrace();
        }
    }
}

                                                  


String *username = username_example; // Username
String *apikey = apikey_example; // API Key
String *password = password_example; // Password (for additional security) (optional)
String *devicecode = devicecode_example; // Device Code (if using multiple devices) (optional)

DefaultApi *apiInstance = [[DefaultApi alloc] init];

// Gets the last credit transaction. 
[apiInstance getLastCreditTransactionGetWith:username
    apikey:apikey
    password:password
    devicecode:devicecode
              completionHandler: ^(CreditTransactionResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

                                                    

var  = require('');

var api = new .DefaultApi()

var username = username_example; // {String} Username

var apikey = apikey_example; // {String} API Key

var opts = { 
  'password': password_example, // {String} Password (for additional security)
  'devicecode': devicecode_example // {String} Device Code (if using multiple devices)
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getLastCreditTransactionGet(username, apikey, opts, callback);

                                                    

using System;
using System.Diagnostics;
using .Api;
using .Client;
using ;

namespace Example
{
    public class getLastCreditTransactionGetExample
    {
        public void main()
        {
            
            var apiInstance = new DefaultApi();
            var username = username_example;  // String | Username
            var apikey = apikey_example;  // String | API Key
            var password = password_example;  // String | Password (for additional security) (optional) 
            var devicecode = devicecode_example;  // String | Device Code (if using multiple devices) (optional) 

            try
            {
                // Gets the last credit transaction. 
                CreditTransactionResponse result = apiInstance.getLastCreditTransactionGet(username, apikey, password, devicecode);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.getLastCreditTransactionGet: " + e.Message );
            }
        }
    }
}

                                                    

getLastCreditTransactionGet($username, $apikey, $password, $devicecode);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->getLastCreditTransactionGet: ', $e->getMessage(), PHP_EOL;
}

                                                  

Parameters

Query parameters
Name Description
username*
password
apikey*
devicecode

Responses

Status: 200 - Successful response

Status: 400 - Error response


getPriceGet


/GetPrice

Usage and SDK Samples


curl -X get -H "apiKey: [[apiKey]]" -H "apiSecret: [[apiSecret]]" "https://www.froogalpay.com/JSON/Service.svc/GetPrice?username=&password=&apikey=&devicecode="



import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import .DefaultApi;

import java.io.File;
import java.util.*;

public class DefaultApiExample {

    public static void main(String[] args) {
        
        DefaultApi apiInstance = new DefaultApi();
        String username = username_example; // String | Username
        String apikey = apikey_example; // String | API Key
        String password = password_example; // String | Password (for additional security)
        String devicecode = devicecode_example; // String | Device Code (if using multiple devices)
        try {
            GetPriceResponse result = apiInstance.getPriceGet(username, apikey, password, devicecode);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#getPriceGet");
            e.printStackTrace();
        }
    }
}

                                                  

import .DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String username = username_example; // String | Username
        String apikey = apikey_example; // String | API Key
        String password = password_example; // String | Password (for additional security)
        String devicecode = devicecode_example; // String | Device Code (if using multiple devices)
        try {
            GetPriceResponse result = apiInstance.getPriceGet(username, apikey, password, devicecode);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#getPriceGet");
            e.printStackTrace();
        }
    }
}

                                                  


String *username = username_example; // Username
String *apikey = apikey_example; // API Key
String *password = password_example; // Password (for additional security) (optional)
String *devicecode = devicecode_example; // Device Code (if using multiple devices) (optional)

DefaultApi *apiInstance = [[DefaultApi alloc] init];

// Gets the price for the current device. 
[apiInstance getPriceGetWith:username
    apikey:apikey
    password:password
    devicecode:devicecode
              completionHandler: ^(GetPriceResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

                                                    

var  = require('');

var api = new .DefaultApi()

var username = username_example; // {String} Username

var apikey = apikey_example; // {String} API Key

var opts = { 
  'password': password_example, // {String} Password (for additional security)
  'devicecode': devicecode_example // {String} Device Code (if using multiple devices)
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getPriceGet(username, apikey, opts, callback);

                                                    

using System;
using System.Diagnostics;
using .Api;
using .Client;
using ;

namespace Example
{
    public class getPriceGetExample
    {
        public void main()
        {
            
            var apiInstance = new DefaultApi();
            var username = username_example;  // String | Username
            var apikey = apikey_example;  // String | API Key
            var password = password_example;  // String | Password (for additional security) (optional) 
            var devicecode = devicecode_example;  // String | Device Code (if using multiple devices) (optional) 

            try
            {
                // Gets the price for the current device. 
                GetPriceResponse result = apiInstance.getPriceGet(username, apikey, password, devicecode);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.getPriceGet: " + e.Message );
            }
        }
    }
}

                                                    

getPriceGet($username, $apikey, $password, $devicecode);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->getPriceGet: ', $e->getMessage(), PHP_EOL;
}

                                                  

Parameters

Query parameters
Name Description
username*
password
apikey*
devicecode

Responses

Status: 200 - Successful response

Status: 400 - Error response


preTransactionGet


/PreTransaction

Usage and SDK Samples


curl -X get -H "apiKey: [[apiKey]]" -H "apiSecret: [[apiSecret]]" "https://www.froogalpay.com/JSON/Service.svc/PreTransaction?username=&password=&apikey=&devicecode=&amount=&name=&invoice=&streetaddress=&city=&state=&zipcode=&email=&addtovault=&successurl=&failurl="



import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import .DefaultApi;

import java.io.File;
import java.util.*;

public class DefaultApiExample {

    public static void main(String[] args) {
        
        DefaultApi apiInstance = new DefaultApi();
        String username = username_example; // String | Username
        String apikey = apikey_example; // String | API Key
        Double amount = 1.2; // Double | Transaction amount
        Boolean addtovault = true; // Boolean | Add card to vault (performs same operation as /AddCardToVault)
        String password = password_example; // String | Password (for additional security)
        String devicecode = devicecode_example; // String | Device Code (if using multiple devices)
        String name = name_example; // String | Cardholder Name
        String invoice = invoice_example; // String | Invoice number (if applicable)
        String streetaddress = streetaddress_example; // String | Street Adress
        String city = city_example; // String | City
        String state = state_example; // String | State
        String zipcode = zipcode_example; // String | Zip Code
        String email = email_example; // String | Email
        String successurl = successurl_example; // String | Where the customer will be redirected after a successfull transaction
        String failurl = failurl_example; // String | Where the customer will be redirected in case of an invalid transaction
        try {
            PreTransactionResponse result = apiInstance.preTransactionGet(username, apikey, amount, addtovault, password, devicecode, name, invoice, streetaddress, city, state, zipcode, email, successurl, failurl);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#preTransactionGet");
            e.printStackTrace();
        }
    }
}

                                                  

import .DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String username = username_example; // String | Username
        String apikey = apikey_example; // String | API Key
        Double amount = 1.2; // Double | Transaction amount
        Boolean addtovault = true; // Boolean | Add card to vault (performs same operation as /AddCardToVault)
        String password = password_example; // String | Password (for additional security)
        String devicecode = devicecode_example; // String | Device Code (if using multiple devices)
        String name = name_example; // String | Cardholder Name
        String invoice = invoice_example; // String | Invoice number (if applicable)
        String streetaddress = streetaddress_example; // String | Street Adress
        String city = city_example; // String | City
        String state = state_example; // String | State
        String zipcode = zipcode_example; // String | Zip Code
        String email = email_example; // String | Email
        String successurl = successurl_example; // String | Where the customer will be redirected after a successfull transaction
        String failurl = failurl_example; // String | Where the customer will be redirected in case of an invalid transaction
        try {
            PreTransactionResponse result = apiInstance.preTransactionGet(username, apikey, amount, addtovault, password, devicecode, name, invoice, streetaddress, city, state, zipcode, email, successurl, failurl);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#preTransactionGet");
            e.printStackTrace();
        }
    }
}

                                                  


String *username = username_example; // Username
String *apikey = apikey_example; // API Key
Double *amount = 1.2; // Transaction amount
Boolean *addtovault = true; // Add card to vault (performs same operation as /AddCardToVault)
String *password = password_example; // Password (for additional security) (optional)
String *devicecode = devicecode_example; // Device Code (if using multiple devices) (optional)
String *name = name_example; // Cardholder Name (optional)
String *invoice = invoice_example; // Invoice number (if applicable) (optional)
String *streetaddress = streetaddress_example; // Street Adress (optional)
String *city = city_example; // City (optional)
String *state = state_example; // State (optional)
String *zipcode = zipcode_example; // Zip Code (optional)
String *email = email_example; // Email (optional)
String *successurl = successurl_example; // Where the customer will be redirected after a successfull transaction (optional)
String *failurl = failurl_example; // Where the customer will be redirected in case of an invalid transaction (optional)

DefaultApi *apiInstance = [[DefaultApi alloc] init];

// Saves pre transaction informations for future payment. User will have to keep UniqueId in his records to process this transaction in the future. 
[apiInstance preTransactionGetWith:username
    apikey:apikey
    amount:amount
    addtovault:addtovault
    password:password
    devicecode:devicecode
    name:name
    invoice:invoice
    streetaddress:streetaddress
    city:city
    state:state
    zipcode:zipcode
    email:email
    successurl:successurl
    failurl:failurl
              completionHandler: ^(PreTransactionResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

                                                    

var  = require('');

var api = new .DefaultApi()

var username = username_example; // {String} Username

var apikey = apikey_example; // {String} API Key

var amount = 1.2; // {Double} Transaction amount

var addtovault = true; // {Boolean} Add card to vault (performs same operation as /AddCardToVault)

var opts = { 
  'password': password_example, // {String} Password (for additional security)
  'devicecode': devicecode_example, // {String} Device Code (if using multiple devices)
  'name': name_example, // {String} Cardholder Name
  'invoice': invoice_example, // {String} Invoice number (if applicable)
  'streetaddress': streetaddress_example, // {String} Street Adress
  'city': city_example, // {String} City
  'state': state_example, // {String} State
  'zipcode': zipcode_example, // {String} Zip Code
  'email': email_example, // {String} Email
  'successurl': successurl_example, // {String} Where the customer will be redirected after a successfull transaction
  'failurl': failurl_example // {String} Where the customer will be redirected in case of an invalid transaction
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.preTransactionGet(username, apikey, amount, addtovault, opts, callback);

                                                    

using System;
using System.Diagnostics;
using .Api;
using .Client;
using ;

namespace Example
{
    public class preTransactionGetExample
    {
        public void main()
        {
            
            var apiInstance = new DefaultApi();
            var username = username_example;  // String | Username
            var apikey = apikey_example;  // String | API Key
            var amount = 1.2;  // Double | Transaction amount
            var addtovault = true;  // Boolean | Add card to vault (performs same operation as /AddCardToVault)
            var password = password_example;  // String | Password (for additional security) (optional) 
            var devicecode = devicecode_example;  // String | Device Code (if using multiple devices) (optional) 
            var name = name_example;  // String | Cardholder Name (optional) 
            var invoice = invoice_example;  // String | Invoice number (if applicable) (optional) 
            var streetaddress = streetaddress_example;  // String | Street Adress (optional) 
            var city = city_example;  // String | City (optional) 
            var state = state_example;  // String | State (optional) 
            var zipcode = zipcode_example;  // String | Zip Code (optional) 
            var email = email_example;  // String | Email (optional) 
            var successurl = successurl_example;  // String | Where the customer will be redirected after a successfull transaction (optional) 
            var failurl = failurl_example;  // String | Where the customer will be redirected in case of an invalid transaction (optional) 

            try
            {
                // Saves pre transaction informations for future payment. User will have to keep UniqueId in his records to process this transaction in the future. 
                PreTransactionResponse result = apiInstance.preTransactionGet(username, apikey, amount, addtovault, password, devicecode, name, invoice, streetaddress, city, state, zipcode, email, successurl, failurl);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.preTransactionGet: " + e.Message );
            }
        }
    }
}

                                                    

preTransactionGet($username, $apikey, $amount, $addtovault, $password, $devicecode, $name, $invoice, $streetaddress, $city, $state, $zipcode, $email, $successurl, $failurl);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->preTransactionGet: ', $e->getMessage(), PHP_EOL;
}

                                                  

Parameters

Query parameters
Name Description
username*
password
apikey*
devicecode
amount*
name
invoice
streetaddress
city
state
zipcode
email
addtovault*
successurl
failurl

Responses

Status: 200 - Successful response

Status: 400 - Error response


processPreTransactionGet


/ProcessPreTransaction

Usage and SDK Samples


curl -X get -H "apiKey: [[apiKey]]" -H "apiSecret: [[apiSecret]]" "https://www.froogalpay.com/JSON/Service.svc/ProcessPreTransaction?username=&password=&apikey=&devicecode=&uniqueid=&amount=&ksn=&track1=&name=&invoice=&streetaddress=&city=&state=&zipcode=&cardnumber=&expdate=&cvv=&email=&addtovault=&magstripeData="



import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import .DefaultApi;

import java.io.File;
import java.util.*;

public class DefaultApiExample {

    public static void main(String[] args) {
        
        DefaultApi apiInstance = new DefaultApi();
        String username = username_example; // String | Username
        String apikey = apikey_example; // String | API Key
        String uniqueid = uniqueid_example; // String | UniqueId of pre transaction to process
        Double amount = 1.2; // Double | Transaction amount
        Boolean addtovault = true; // Boolean | Add card to vault (performs same operation as /AddCardToVault)
        String password = password_example; // String | Password (for additional security)
        String devicecode = devicecode_example; // String | Device Code (if using multiple devices)
        String ksn = ksn_example; // String | KSN (provide when using swiper)
        String track1 = track1_example; // String | Track1 (provide when using swiper)
        String name = name_example; // String | Cardholder Name
        String invoice = invoice_example; // String | Invoice number (if applicable)
        String streetaddress = streetaddress_example; // String | Street Adress
        String city = city_example; // String | City
        String state = state_example; // String | State
        String zipcode = zipcode_example; // String | Zip Code
        String cardnumber = cardnumber_example; // String | Card Number
        String expdate = expdate_example; // String | Expiration Date (MMYY)
        String cvv = cvv_example; // String | CVV Code
        String email = email_example; // String | Email
        String magstripeData = magstripeData_example; // String | magstripeData
        try {
            CreditTransactionResponse result = apiInstance.processPreTransactionGet(username, apikey, uniqueid, amount, addtovault, password, devicecode, ksn, track1, name, invoice, streetaddress, city, state, zipcode, cardnumber, expdate, cvv, email, magstripeData);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#processPreTransactionGet");
            e.printStackTrace();
        }
    }
}

                                                  

import .DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String username = username_example; // String | Username
        String apikey = apikey_example; // String | API Key
        String uniqueid = uniqueid_example; // String | UniqueId of pre transaction to process
        Double amount = 1.2; // Double | Transaction amount
        Boolean addtovault = true; // Boolean | Add card to vault (performs same operation as /AddCardToVault)
        String password = password_example; // String | Password (for additional security)
        String devicecode = devicecode_example; // String | Device Code (if using multiple devices)
        String ksn = ksn_example; // String | KSN (provide when using swiper)
        String track1 = track1_example; // String | Track1 (provide when using swiper)
        String name = name_example; // String | Cardholder Name
        String invoice = invoice_example; // String | Invoice number (if applicable)
        String streetaddress = streetaddress_example; // String | Street Adress
        String city = city_example; // String | City
        String state = state_example; // String | State
        String zipcode = zipcode_example; // String | Zip Code
        String cardnumber = cardnumber_example; // String | Card Number
        String expdate = expdate_example; // String | Expiration Date (MMYY)
        String cvv = cvv_example; // String | CVV Code
        String email = email_example; // String | Email
        String magstripeData = magstripeData_example; // String | magstripeData
        try {
            CreditTransactionResponse result = apiInstance.processPreTransactionGet(username, apikey, uniqueid, amount, addtovault, password, devicecode, ksn, track1, name, invoice, streetaddress, city, state, zipcode, cardnumber, expdate, cvv, email, magstripeData);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#processPreTransactionGet");
            e.printStackTrace();
        }
    }
}

                                                  


String *username = username_example; // Username
String *apikey = apikey_example; // API Key
String *uniqueid = uniqueid_example; // UniqueId of pre transaction to process
Double *amount = 1.2; // Transaction amount
Boolean *addtovault = true; // Add card to vault (performs same operation as /AddCardToVault)
String *password = password_example; // Password (for additional security) (optional)
String *devicecode = devicecode_example; // Device Code (if using multiple devices) (optional)
String *ksn = ksn_example; // KSN (provide when using swiper) (optional)
String *track1 = track1_example; // Track1 (provide when using swiper) (optional)
String *name = name_example; // Cardholder Name (optional)
String *invoice = invoice_example; // Invoice number (if applicable) (optional)
String *streetaddress = streetaddress_example; // Street Adress (optional)
String *city = city_example; // City (optional)
String *state = state_example; // State (optional)
String *zipcode = zipcode_example; // Zip Code (optional)
String *cardnumber = cardnumber_example; // Card Number (optional)
String *expdate = expdate_example; // Expiration Date (MMYY) (optional)
String *cvv = cvv_example; // CVV Code (optional)
String *email = email_example; // Email (optional)
String *magstripeData = magstripeData_example; // magstripeData (optional)

DefaultApi *apiInstance = [[DefaultApi alloc] init];

// Process a pre transaction via API calls. Otherwise hosted payment page is available at : https://www.froogalpay.com/Payment?preTransact={UniqueId} 
[apiInstance processPreTransactionGetWith:username
    apikey:apikey
    uniqueid:uniqueid
    amount:amount
    addtovault:addtovault
    password:password
    devicecode:devicecode
    ksn:ksn
    track1:track1
    name:name
    invoice:invoice
    streetaddress:streetaddress
    city:city
    state:state
    zipcode:zipcode
    cardnumber:cardnumber
    expdate:expdate
    cvv:cvv
    email:email
    magstripeData:magstripeData
              completionHandler: ^(CreditTransactionResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

                                                    

var  = require('');

var api = new .DefaultApi()

var username = username_example; // {String} Username

var apikey = apikey_example; // {String} API Key

var uniqueid = uniqueid_example; // {String} UniqueId of pre transaction to process

var amount = 1.2; // {Double} Transaction amount

var addtovault = true; // {Boolean} Add card to vault (performs same operation as /AddCardToVault)

var opts = { 
  'password': password_example, // {String} Password (for additional security)
  'devicecode': devicecode_example, // {String} Device Code (if using multiple devices)
  'ksn': ksn_example, // {String} KSN (provide when using swiper)
  'track1': track1_example, // {String} Track1 (provide when using swiper)
  'name': name_example, // {String} Cardholder Name
  'invoice': invoice_example, // {String} Invoice number (if applicable)
  'streetaddress': streetaddress_example, // {String} Street Adress
  'city': city_example, // {String} City
  'state': state_example, // {String} State
  'zipcode': zipcode_example, // {String} Zip Code
  'cardnumber': cardnumber_example, // {String} Card Number
  'expdate': expdate_example, // {String} Expiration Date (MMYY)
  'cvv': cvv_example, // {String} CVV Code
  'email': email_example, // {String} Email
  'magstripeData': magstripeData_example // {String} magstripeData
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.processPreTransactionGet(username, apikey, uniqueid, amount, addtovault, opts, callback);

                                                    

using System;
using System.Diagnostics;
using .Api;
using .Client;
using ;

namespace Example
{
    public class processPreTransactionGetExample
    {
        public void main()
        {
            
            var apiInstance = new DefaultApi();
            var username = username_example;  // String | Username
            var apikey = apikey_example;  // String | API Key
            var uniqueid = uniqueid_example;  // String | UniqueId of pre transaction to process
            var amount = 1.2;  // Double | Transaction amount
            var addtovault = true;  // Boolean | Add card to vault (performs same operation as /AddCardToVault)
            var password = password_example;  // String | Password (for additional security) (optional) 
            var devicecode = devicecode_example;  // String | Device Code (if using multiple devices) (optional) 
            var ksn = ksn_example;  // String | KSN (provide when using swiper) (optional) 
            var track1 = track1_example;  // String | Track1 (provide when using swiper) (optional) 
            var name = name_example;  // String | Cardholder Name (optional) 
            var invoice = invoice_example;  // String | Invoice number (if applicable) (optional) 
            var streetaddress = streetaddress_example;  // String | Street Adress (optional) 
            var city = city_example;  // String | City (optional) 
            var state = state_example;  // String | State (optional) 
            var zipcode = zipcode_example;  // String | Zip Code (optional) 
            var cardnumber = cardnumber_example;  // String | Card Number (optional) 
            var expdate = expdate_example;  // String | Expiration Date (MMYY) (optional) 
            var cvv = cvv_example;  // String | CVV Code (optional) 
            var email = email_example;  // String | Email (optional) 
            var magstripeData = magstripeData_example;  // String | magstripeData (optional) 

            try
            {
                // Process a pre transaction via API calls. Otherwise hosted payment page is available at : https://www.froogalpay.com/Payment?preTransact={UniqueId} 
                CreditTransactionResponse result = apiInstance.processPreTransactionGet(username, apikey, uniqueid, amount, addtovault, password, devicecode, ksn, track1, name, invoice, streetaddress, city, state, zipcode, cardnumber, expdate, cvv, email, magstripeData);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.processPreTransactionGet: " + e.Message );
            }
        }
    }
}

                                                    

processPreTransactionGet($username, $apikey, $uniqueid, $amount, $addtovault, $password, $devicecode, $ksn, $track1, $name, $invoice, $streetaddress, $city, $state, $zipcode, $cardnumber, $expdate, $cvv, $email, $magstripeData);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->processPreTransactionGet: ', $e->getMessage(), PHP_EOL;
}

                                                  

Parameters

Query parameters
Name Description
username*
password
apikey*
devicecode
uniqueid*
amount*
ksn
track1
name
invoice
streetaddress
city
state
zipcode
cardnumber
expdate
cvv
email
addtovault*
magstripeData

Responses

Status: 200 - Successful response

Status: 400 - Error response


reprintCreditGet


/ReprintCredit

Usage and SDK Samples


curl -X get -H "apiKey: [[apiKey]]" -H "apiSecret: [[apiSecret]]" "https://www.froogalpay.com/JSON/Service.svc/ReprintCredit?username=&password=&apikey=&devicecode=&transactionid="



import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import .DefaultApi;

import java.io.File;
import java.util.*;

public class DefaultApiExample {

    public static void main(String[] args) {
        
        DefaultApi apiInstance = new DefaultApi();
        String username = username_example; // String | Username
        String apikey = apikey_example; // String | API Key
        String transactionid = transactionid_example; // String | Transaction Id
        String password = password_example; // String | Password (for additional security)
        String devicecode = devicecode_example; // String | Device Code (if using multiple devices)
        try {
            CreditTransactionResponse result = apiInstance.reprintCreditGet(username, apikey, transactionid, password, devicecode);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#reprintCreditGet");
            e.printStackTrace();
        }
    }
}

                                                  

import .DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String username = username_example; // String | Username
        String apikey = apikey_example; // String | API Key
        String transactionid = transactionid_example; // String | Transaction Id
        String password = password_example; // String | Password (for additional security)
        String devicecode = devicecode_example; // String | Device Code (if using multiple devices)
        try {
            CreditTransactionResponse result = apiInstance.reprintCreditGet(username, apikey, transactionid, password, devicecode);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#reprintCreditGet");
            e.printStackTrace();
        }
    }
}

                                                  


String *username = username_example; // Username
String *apikey = apikey_example; // API Key
String *transactionid = transactionid_example; // Transaction Id
String *password = password_example; // Password (for additional security) (optional)
String *devicecode = devicecode_example; // Device Code (if using multiple devices) (optional)

DefaultApi *apiInstance = [[DefaultApi alloc] init];

// Get credit transaction informations for given transaction id. 
[apiInstance reprintCreditGetWith:username
    apikey:apikey
    transactionid:transactionid
    password:password
    devicecode:devicecode
              completionHandler: ^(CreditTransactionResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

                                                    

var  = require('');

var api = new .DefaultApi()

var username = username_example; // {String} Username

var apikey = apikey_example; // {String} API Key

var transactionid = transactionid_example; // {String} Transaction Id

var opts = { 
  'password': password_example, // {String} Password (for additional security)
  'devicecode': devicecode_example // {String} Device Code (if using multiple devices)
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.reprintCreditGet(username, apikey, transactionid, opts, callback);

                                                    

using System;
using System.Diagnostics;
using .Api;
using .Client;
using ;

namespace Example
{
    public class reprintCreditGetExample
    {
        public void main()
        {
            
            var apiInstance = new DefaultApi();
            var username = username_example;  // String | Username
            var apikey = apikey_example;  // String | API Key
            var transactionid = transactionid_example;  // String | Transaction Id
            var password = password_example;  // String | Password (for additional security) (optional) 
            var devicecode = devicecode_example;  // String | Device Code (if using multiple devices) (optional) 

            try
            {
                // Get credit transaction informations for given transaction id. 
                CreditTransactionResponse result = apiInstance.reprintCreditGet(username, apikey, transactionid, password, devicecode);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.reprintCreditGet: " + e.Message );
            }
        }
    }
}

                                                    

reprintCreditGet($username, $apikey, $transactionid, $password, $devicecode);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->reprintCreditGet: ', $e->getMessage(), PHP_EOL;
}

                                                  

Parameters

Query parameters
Name Description
username*
password
apikey*
devicecode
transactionid*

Responses

Status: 200 - Successful response

Status: 400 - Error response


returnTransactionGet


/ReturnTransaction

Usage and SDK Samples


curl -X get -H "apiKey: [[apiKey]]" -H "apiSecret: [[apiSecret]]" "https://www.froogalpay.com/JSON/Service.svc/ReturnTransaction?username=&password=&apikey=&devicecode=&transactionId=&amount="



import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import .DefaultApi;

import java.io.File;
import java.util.*;

public class DefaultApiExample {

    public static void main(String[] args) {
        
        DefaultApi apiInstance = new DefaultApi();
        String username = username_example; // String | Username
        String apikey = apikey_example; // String | API Key
        String transactionId = transactionId_example; // String | TransactionId to refund
        String password = password_example; // String | Password (for additional security)
        String devicecode = devicecode_example; // String | Device Code (if using multiple devices)
        Double amount = 1.2; // Double | Amount to refund (transaction will be refunded completely if not specified)
        try {
            VoidedTransactionResponse result = apiInstance.returnTransactionGet(username, apikey, transactionId, password, devicecode, amount);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#returnTransactionGet");
            e.printStackTrace();
        }
    }
}

                                                  

import .DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String username = username_example; // String | Username
        String apikey = apikey_example; // String | API Key
        String transactionId = transactionId_example; // String | TransactionId to refund
        String password = password_example; // String | Password (for additional security)
        String devicecode = devicecode_example; // String | Device Code (if using multiple devices)
        Double amount = 1.2; // Double | Amount to refund (transaction will be refunded completely if not specified)
        try {
            VoidedTransactionResponse result = apiInstance.returnTransactionGet(username, apikey, transactionId, password, devicecode, amount);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#returnTransactionGet");
            e.printStackTrace();
        }
    }
}

                                                  


String *username = username_example; // Username
String *apikey = apikey_example; // API Key
String *transactionId = transactionId_example; // TransactionId to refund
String *password = password_example; // Password (for additional security) (optional)
String *devicecode = devicecode_example; // Device Code (if using multiple devices) (optional)
Double *amount = 1.2; // Amount to refund (transaction will be refunded completely if not specified) (optional)

DefaultApi *apiInstance = [[DefaultApi alloc] init];

// Refund a previously settled transaction (possible to refund only a part of the transaction by specifying an amount) 
[apiInstance returnTransactionGetWith:username
    apikey:apikey
    transactionId:transactionId
    password:password
    devicecode:devicecode
    amount:amount
              completionHandler: ^(VoidedTransactionResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

                                                    

var  = require('');

var api = new .DefaultApi()

var username = username_example; // {String} Username

var apikey = apikey_example; // {String} API Key

var transactionId = transactionId_example; // {String} TransactionId to refund

var opts = { 
  'password': password_example, // {String} Password (for additional security)
  'devicecode': devicecode_example, // {String} Device Code (if using multiple devices)
  'amount': 1.2 // {Double} Amount to refund (transaction will be refunded completely if not specified)
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.returnTransactionGet(username, apikey, transactionId, opts, callback);

                                                    

using System;
using System.Diagnostics;
using .Api;
using .Client;
using ;

namespace Example
{
    public class returnTransactionGetExample
    {
        public void main()
        {
            
            var apiInstance = new DefaultApi();
            var username = username_example;  // String | Username
            var apikey = apikey_example;  // String | API Key
            var transactionId = transactionId_example;  // String | TransactionId to refund
            var password = password_example;  // String | Password (for additional security) (optional) 
            var devicecode = devicecode_example;  // String | Device Code (if using multiple devices) (optional) 
            var amount = 1.2;  // Double | Amount to refund (transaction will be refunded completely if not specified) (optional) 

            try
            {
                // Refund a previously settled transaction (possible to refund only a part of the transaction by specifying an amount) 
                VoidedTransactionResponse result = apiInstance.returnTransactionGet(username, apikey, transactionId, password, devicecode, amount);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.returnTransactionGet: " + e.Message );
            }
        }
    }
}

                                                    

returnTransactionGet($username, $apikey, $transactionId, $password, $devicecode, $amount);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->returnTransactionGet: ', $e->getMessage(), PHP_EOL;
}

                                                  

Parameters

Query parameters
Name Description
username*
password
apikey*
devicecode
transactionId*
amount

Responses

Status: 200 - Successful response

Status: 400 - Error response


updateCardInVaultGet


/UpdateCardInVault

Usage and SDK Samples


curl -X get -H "apiKey: [[apiKey]]" -H "apiSecret: [[apiSecret]]" "https://www.froogalpay.com/JSON/Service.svc/UpdateCardInVault?username=&password=&apikey=&devicecode=&transactionId=&ksn=&track1=&name=&streetaddress=&city=&state=&zipcode=&cardnumber=&expdate=&cvv=&email="



import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import .DefaultApi;

import java.io.File;
import java.util.*;

public class DefaultApiExample {

    public static void main(String[] args) {
        
        DefaultApi apiInstance = new DefaultApi();
        String username = username_example; // String | Username
        String apikey = apikey_example; // String | API Key
        Long transactionId = 789; // Long | /AddToCardVault transaction Id
        String password = password_example; // String | Password (for additional security)
        String devicecode = devicecode_example; // String | Device Code (if using multiple devices)
        String ksn = ksn_example; // String | KSN (provide when using swiper)
        String track1 = track1_example; // String | Track1 (provide when using swiper)
        String name = name_example; // String | Cardholder Name
        String streetaddress = streetaddress_example; // String | Street Adress
        String city = city_example; // String | City
        String state = state_example; // String | State
        String zipcode = zipcode_example; // String | Zip Code
        String cardnumber = cardnumber_example; // String | Card Number
        String expdate = expdate_example; // String | Expiration Date (MMYY)
        String cvv = cvv_example; // String | CVV Code
        String email = email_example; // String | Email
        try {
            CreditTransactionResponse result = apiInstance.updateCardInVaultGet(username, apikey, transactionId, password, devicecode, ksn, track1, name, streetaddress, city, state, zipcode, cardnumber, expdate, cvv, email);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#updateCardInVaultGet");
            e.printStackTrace();
        }
    }
}

                                                  

import .DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String username = username_example; // String | Username
        String apikey = apikey_example; // String | API Key
        Long transactionId = 789; // Long | /AddToCardVault transaction Id
        String password = password_example; // String | Password (for additional security)
        String devicecode = devicecode_example; // String | Device Code (if using multiple devices)
        String ksn = ksn_example; // String | KSN (provide when using swiper)
        String track1 = track1_example; // String | Track1 (provide when using swiper)
        String name = name_example; // String | Cardholder Name
        String streetaddress = streetaddress_example; // String | Street Adress
        String city = city_example; // String | City
        String state = state_example; // String | State
        String zipcode = zipcode_example; // String | Zip Code
        String cardnumber = cardnumber_example; // String | Card Number
        String expdate = expdate_example; // String | Expiration Date (MMYY)
        String cvv = cvv_example; // String | CVV Code
        String email = email_example; // String | Email
        try {
            CreditTransactionResponse result = apiInstance.updateCardInVaultGet(username, apikey, transactionId, password, devicecode, ksn, track1, name, streetaddress, city, state, zipcode, cardnumber, expdate, cvv, email);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#updateCardInVaultGet");
            e.printStackTrace();
        }
    }
}

                                                  


String *username = username_example; // Username
String *apikey = apikey_example; // API Key
Long *transactionId = 789; // /AddToCardVault transaction Id
String *password = password_example; // Password (for additional security) (optional)
String *devicecode = devicecode_example; // Device Code (if using multiple devices) (optional)
String *ksn = ksn_example; // KSN (provide when using swiper) (optional)
String *track1 = track1_example; // Track1 (provide when using swiper) (optional)
String *name = name_example; // Cardholder Name (optional)
String *streetaddress = streetaddress_example; // Street Adress (optional)
String *city = city_example; // City (optional)
String *state = state_example; // State (optional)
String *zipcode = zipcode_example; // Zip Code (optional)
String *cardnumber = cardnumber_example; // Card Number (optional)
String *expdate = expdate_example; // Expiration Date (MMYY) (optional)
String *cvv = cvv_example; // CVV Code (optional)
String *email = email_example; // Email (optional)

DefaultApi *apiInstance = [[DefaultApi alloc] init];

// Updates card vault informations 
[apiInstance updateCardInVaultGetWith:username
    apikey:apikey
    transactionId:transactionId
    password:password
    devicecode:devicecode
    ksn:ksn
    track1:track1
    name:name
    streetaddress:streetaddress
    city:city
    state:state
    zipcode:zipcode
    cardnumber:cardnumber
    expdate:expdate
    cvv:cvv
    email:email
              completionHandler: ^(CreditTransactionResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

                                                    

var  = require('');

var api = new .DefaultApi()

var username = username_example; // {String} Username

var apikey = apikey_example; // {String} API Key

var transactionId = 789; // {Long} /AddToCardVault transaction Id

var opts = { 
  'password': password_example, // {String} Password (for additional security)
  'devicecode': devicecode_example, // {String} Device Code (if using multiple devices)
  'ksn': ksn_example, // {String} KSN (provide when using swiper)
  'track1': track1_example, // {String} Track1 (provide when using swiper)
  'name': name_example, // {String} Cardholder Name
  'streetaddress': streetaddress_example, // {String} Street Adress
  'city': city_example, // {String} City
  'state': state_example, // {String} State
  'zipcode': zipcode_example, // {String} Zip Code
  'cardnumber': cardnumber_example, // {String} Card Number
  'expdate': expdate_example, // {String} Expiration Date (MMYY)
  'cvv': cvv_example, // {String} CVV Code
  'email': email_example // {String} Email
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateCardInVaultGet(username, apikey, transactionId, opts, callback);

                                                    

using System;
using System.Diagnostics;
using .Api;
using .Client;
using ;

namespace Example
{
    public class updateCardInVaultGetExample
    {
        public void main()
        {
            
            var apiInstance = new DefaultApi();
            var username = username_example;  // String | Username
            var apikey = apikey_example;  // String | API Key
            var transactionId = 789;  // Long | /AddToCardVault transaction Id
            var password = password_example;  // String | Password (for additional security) (optional) 
            var devicecode = devicecode_example;  // String | Device Code (if using multiple devices) (optional) 
            var ksn = ksn_example;  // String | KSN (provide when using swiper) (optional) 
            var track1 = track1_example;  // String | Track1 (provide when using swiper) (optional) 
            var name = name_example;  // String | Cardholder Name (optional) 
            var streetaddress = streetaddress_example;  // String | Street Adress (optional) 
            var city = city_example;  // String | City (optional) 
            var state = state_example;  // String | State (optional) 
            var zipcode = zipcode_example;  // String | Zip Code (optional) 
            var cardnumber = cardnumber_example;  // String | Card Number (optional) 
            var expdate = expdate_example;  // String | Expiration Date (MMYY) (optional) 
            var cvv = cvv_example;  // String | CVV Code (optional) 
            var email = email_example;  // String | Email (optional) 

            try
            {
                // Updates card vault informations 
                CreditTransactionResponse result = apiInstance.updateCardInVaultGet(username, apikey, transactionId, password, devicecode, ksn, track1, name, streetaddress, city, state, zipcode, cardnumber, expdate, cvv, email);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.updateCardInVaultGet: " + e.Message );
            }
        }
    }
}

                                                    

updateCardInVaultGet($username, $apikey, $transactionId, $password, $devicecode, $ksn, $track1, $name, $streetaddress, $city, $state, $zipcode, $cardnumber, $expdate, $cvv, $email);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->updateCardInVaultGet: ', $e->getMessage(), PHP_EOL;
}

                                                  

Parameters

Query parameters
Name Description
username*
password
apikey*
devicecode
transactionId*
ksn
track1
name
streetaddress
city
state
zipcode
cardnumber
expdate
cvv
email

Responses

Status: 200 - Successful response

Status: 400 - Error response


validateCredentialsGet


/ValidateCredentials

Usage and SDK Samples


curl -X get -H "apiKey: [[apiKey]]" -H "apiSecret: [[apiSecret]]" "https://www.froogalpay.com/JSON/Service.svc/ValidateCredentials?username=&password=&apikey=&devicecode="



import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import .DefaultApi;

import java.io.File;
import java.util.*;

public class DefaultApiExample {

    public static void main(String[] args) {
        
        DefaultApi apiInstance = new DefaultApi();
        String username = username_example; // String | Username
        String apikey = apikey_example; // String | API Key
        String password = password_example; // String | Password (for additional security)
        String devicecode = devicecode_example; // String | Device Code (if using multiple devices)
        try {
            LoginResponse result = apiInstance.validateCredentialsGet(username, apikey, password, devicecode);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#validateCredentialsGet");
            e.printStackTrace();
        }
    }
}

                                                  

import .DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String username = username_example; // String | Username
        String apikey = apikey_example; // String | API Key
        String password = password_example; // String | Password (for additional security)
        String devicecode = devicecode_example; // String | Device Code (if using multiple devices)
        try {
            LoginResponse result = apiInstance.validateCredentialsGet(username, apikey, password, devicecode);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#validateCredentialsGet");
            e.printStackTrace();
        }
    }
}

                                                  


String *username = username_example; // Username
String *apikey = apikey_example; // API Key
String *password = password_example; // Password (for additional security) (optional)
String *devicecode = devicecode_example; // Device Code (if using multiple devices) (optional)

DefaultApi *apiInstance = [[DefaultApi alloc] init];

// Validates if the entered credentials are valid for performing any action with the API. 
[apiInstance validateCredentialsGetWith:username
    apikey:apikey
    password:password
    devicecode:devicecode
              completionHandler: ^(LoginResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

                                                    

var  = require('');

var api = new .DefaultApi()

var username = username_example; // {String} Username

var apikey = apikey_example; // {String} API Key

var opts = { 
  'password': password_example, // {String} Password (for additional security)
  'devicecode': devicecode_example // {String} Device Code (if using multiple devices)
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.validateCredentialsGet(username, apikey, opts, callback);

                                                    

using System;
using System.Diagnostics;
using .Api;
using .Client;
using ;

namespace Example
{
    public class validateCredentialsGetExample
    {
        public void main()
        {
            
            var apiInstance = new DefaultApi();
            var username = username_example;  // String | Username
            var apikey = apikey_example;  // String | API Key
            var password = password_example;  // String | Password (for additional security) (optional) 
            var devicecode = devicecode_example;  // String | Device Code (if using multiple devices) (optional) 

            try
            {
                // Validates if the entered credentials are valid for performing any action with the API. 
                LoginResponse result = apiInstance.validateCredentialsGet(username, apikey, password, devicecode);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.validateCredentialsGet: " + e.Message );
            }
        }
    }
}

                                                    

validateCredentialsGet($username, $apikey, $password, $devicecode);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->validateCredentialsGet: ', $e->getMessage(), PHP_EOL;
}

                                                  

Parameters

Query parameters
Name Description
username*
password
apikey*
devicecode

Responses

Status: 200 - Successful response

Status: 400 - Error response


voidTransactionGet


/VoidTransaction

Usage and SDK Samples


curl -X get -H "apiKey: [[apiKey]]" -H "apiSecret: [[apiSecret]]" "https://www.froogalpay.com/JSON/Service.svc/VoidTransaction?username=&password=&apikey=&devicecode=&transactionId="



import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import .DefaultApi;

import java.io.File;
import java.util.*;

public class DefaultApiExample {

    public static void main(String[] args) {
        
        DefaultApi apiInstance = new DefaultApi();
        String username = username_example; // String | Username
        String apikey = apikey_example; // String | API Key
        String transactionId = transactionId_example; // String | TransactionId to void
        String password = password_example; // String | Password (for additional security)
        String devicecode = devicecode_example; // String | Device Code (if using multiple devices)
        try {
            VoidedTransactionResponse result = apiInstance.voidTransactionGet(username, apikey, transactionId, password, devicecode);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#voidTransactionGet");
            e.printStackTrace();
        }
    }
}

                                                  

import .DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String username = username_example; // String | Username
        String apikey = apikey_example; // String | API Key
        String transactionId = transactionId_example; // String | TransactionId to void
        String password = password_example; // String | Password (for additional security)
        String devicecode = devicecode_example; // String | Device Code (if using multiple devices)
        try {
            VoidedTransactionResponse result = apiInstance.voidTransactionGet(username, apikey, transactionId, password, devicecode);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#voidTransactionGet");
            e.printStackTrace();
        }
    }
}

                                                  


String *username = username_example; // Username
String *apikey = apikey_example; // API Key
String *transactionId = transactionId_example; // TransactionId to void
String *password = password_example; // Password (for additional security) (optional)
String *devicecode = devicecode_example; // Device Code (if using multiple devices) (optional)

DefaultApi *apiInstance = [[DefaultApi alloc] init];

// Void a previously unsettled transaction (usually wihtin the same day) 
[apiInstance voidTransactionGetWith:username
    apikey:apikey
    transactionId:transactionId
    password:password
    devicecode:devicecode
              completionHandler: ^(VoidedTransactionResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

                                                    

var  = require('');

var api = new .DefaultApi()

var username = username_example; // {String} Username

var apikey = apikey_example; // {String} API Key

var transactionId = transactionId_example; // {String} TransactionId to void

var opts = { 
  'password': password_example, // {String} Password (for additional security)
  'devicecode': devicecode_example // {String} Device Code (if using multiple devices)
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.voidTransactionGet(username, apikey, transactionId, opts, callback);

                                                    

using System;
using System.Diagnostics;
using .Api;
using .Client;
using ;

namespace Example
{
    public class voidTransactionGetExample
    {
        public void main()
        {
            
            var apiInstance = new DefaultApi();
            var username = username_example;  // String | Username
            var apikey = apikey_example;  // String | API Key
            var transactionId = transactionId_example;  // String | TransactionId to void
            var password = password_example;  // String | Password (for additional security) (optional) 
            var devicecode = devicecode_example;  // String | Device Code (if using multiple devices) (optional) 

            try
            {
                // Void a previously unsettled transaction (usually wihtin the same day) 
                VoidedTransactionResponse result = apiInstance.voidTransactionGet(username, apikey, transactionId, password, devicecode);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.voidTransactionGet: " + e.Message );
            }
        }
    }
}

                                                    

voidTransactionGet($username, $apikey, $transactionId, $password, $devicecode);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->voidTransactionGet: ', $e->getMessage(), PHP_EOL;
}

                                                  

Parameters

Query parameters
Name Description
username*
password
apikey*
devicecode
transactionId*

Responses

Status: 200 - Successful response

Status: 400 - Error response


Generated 2016-09-15T12:39:36.021Z