Deposit

Deposits represent transfers of funds to your bank account.

Deposit / List

List | Find

Examples

List Deposit
PaymentsApi.PUBLIC_KEY = "YOUR_PUBLIC_API_KEY";
PaymentsApi.PRIVATE_KEY = "YOUR_PRIVATE_API_KEY";

ResourceList<Deposit> deposit = Deposit.list(new PaymentsMap("max", 30));

System.out.println ("Total: " + deposit.getTotal());
for (Deposit o: deposit.getList()) {
    System.out.println(o.toString());
}
require 'simplify'

Simplify::public_key = "YOUR_PUBLIC_API_KEY"
Simplify::private_key = "YOUR_PRIVATE_API_KEY"

val = Simplify::Deposit.list({"max" => 30})

puts "Total: #{val['total']}"
val['list'].each do |o|
    puts o.inspect
end
import simplify

simplify.public_key = "YOUR_PUBLIC_API_KEY"
simplify.private_key = "YOUR_PRIVATE_API_KEY"

deposits = simplify.Deposit.list({"max": 30})

print "Total: " + str(deposits.total)
for o in deposits.list:
    print o
<?php

require_once("./lib/Simplify.php");

Simplify::$publicKey = 'YOUR_PUBLIC_API_KEY';
Simplify::$privateKey = 'YOUR_PRIVATE_API_KEY';

$deposit = Simplify_Deposit::listDeposit(array("max" => 30));

print "Total: " . $deposit->total . "\n";
foreach ($deposit->list as $o) {
    print_r($o);
}

?>
use Net::Simplify;

$Net::Simplify::public_key = "YOUR_PUBLIC_API_KEY";
$Net::Simplify::private_key = "YOUR_PRIVATE_API_KEY";

$deposits = Net::Simplify::Deposit->list({max => 30});

print "Total: ", $deposits->total, "\n";
foreach my $deposit ($deposits->list) {
    print $deposit->{id}, "\n";
}
using SimplifyCommerce.Payments;

PaymentsApi.PublicApiKey = "YOUR_PUBLIC_KEY";
PaymentsApi.PrivateApiKey = "YOUR_PRIVATE_KEY";

PaymentsApi api = new PaymentsApi();


try
{
    ResourceList<Deposit> deposit = (ResourceList<Deposit>)api.List(typeof(Deposit));

    Console.WriteLine ("Total: " + deposit.Total);
    Console.WriteLine ("List: " + deposit.List.ToString());

}
catch (Exception e)
{
    Console.WriteLine(e.ToString());
}

var Simplify = require("simplify-commerce"),
    client = Simplify.getClient({
        publicKey: 'YOUR_PUBLIC_API_KEY',
        privateKey: 'YOUR_PRIVATE_API_KEY'
    });

client.deposit.list({max: 30}, function(errData, data){

    if(errData){
        console.error("Error Message: " + errData.data.error.message);
        // handle the error
        return;
    }

    console.log("Total: " + data.total);

    for(var i=0; i < data.list.length; i++){
        console.log("Amount: " + data.list[i].amount);
    }
});
INPUT PARAMETERS
filter
filter.idFilter by the deposit Id
filter.amountFilter by the deposit amount (in the smallest unit of your currency)
filter.dateCreatedMin*Filter by the minimum created date you are searching for - Date in UTC millis
filter.dateCreatedMax*Filter by the maximum created date you are searching for - Date in UTC millis
filter.depositDateMinFilter by the earliest deposit date you are searching for - Date in UTC millis
filter.depositDateMaxFilter by the latest deposit date you are searching for - Date in UTC millis
filter.creditCountFilter by the creditCount figure for the deposit
filter.creditAmountFilter by the creditAmount figure for the deposit
filter.debitCountFilter by the debitCount figure for the deposit
filter.debitAmountFilter by the debitAmount figure for the deposit
filter.netCountFilter by the netCount figure for the deposit
filter.netAmountFilter by the netAmount figure for the deposit
filter.qYou can use this to filter by different figures or strings - can be the Id, creditAmount or the debitAmount for the deposit

*Use dateCreatedMin with dateCreatedMax in the same filter if you want to search between two created dates
optional
max Allows up to a max of 50 list items to return.
[min value: 0, max value: 50, default: 20]
optional
offset Used in paging of the list. This is the start offset of the page.
[min value: 0, default: 0]
optional
sorting Allows for ascending or descending sorting of the list. The value is a map between the property name and the sorting direction (either 'asc' for ascending or 'desc' for descending). Sortable properties are:amount, dateCreated, depositDate optional
OUTPUT
filter Filters to apply to the list.
list Object list
max Allows up to a max of 50 list items to return.
offset Used in paging of the list. This is the start offset of the page.
sorting Allows for ascending or descending sorting of the list.
total Total number of records available

Deposit / Find

List | Find

Examples

Find Deposit
PaymentsApi.PUBLIC_KEY = "YOUR_PUBLIC_API_KEY";
PaymentsApi.PRIVATE_KEY = "YOUR_PRIVATE_API_KEY";

Deposit deposit = Deposit.find("4TR6Bc");

System.out.println (deposit);
require 'simplify'

Simplify::public_key = "YOUR_PUBLIC_API_KEY"
Simplify::private_key = "YOUR_PRIVATE_API_KEY"

deposit = Simplify::Deposit.find('4TR6Bc')

puts deposit.inspect

import simplify

simplify.public_key = "YOUR_PUBLIC_API_KEY"
simplify.private_key = "YOUR_PRIVATE_API_KEY"

deposit = simplify.Deposit.find('4TR6Bc')

print deposit
<?php

require_once("./lib/Simplify.php");

Simplify::$publicKey = 'YOUR_PUBLIC_API_KEY';
Simplify::$privateKey = 'YOUR_PRIVATE_API_KEY';

$obj  = Simplify_Deposit::findDeposit('4TR6Bc');

print_r($obj);

?>
use Net::Simplify;

$Net::Simplify::public_key = "YOUR_PUBLIC_API_KEY";
$Net::Simplify::private_key = "YOUR_PRIVATE_API_KEY";

$deposit = Net::Simplify::Deposit->find('4TR6Bc');

print $deposit->{id}, "\n";
using SimplifyCommerce.Payments;
using Newtonsoft.Json;

PaymentsApi.PublicApiKey = "YOUR_PUBLIC_KEY";
PaymentsApi.PrivateApiKey = "YOUR_PRIVATE_KEY";

PaymentsApi api = new PaymentsApi();


try
{
    String id = "1234";

    Deposit deposit = (Deposit)api.Find(typeof(Deposit), id);

    // output all properties
    Console.WriteLine(JsonConvert.SerializeObject(deposit).ToString());
}
catch (Exception e)
{
    Console.WriteLine(e.ToString());
}

var Simplify = require("simplify-commerce"),
    client = Simplify.getClient({
        publicKey: 'YOUR_PUBLIC_API_KEY',
        privateKey: 'YOUR_PRIVATE_API_KEY'
    });

client.deposit.find("4TR6Bc", function(errData, data){

    if(errData){
        console.error("Error Message: " + errData.data.error.message);
        // handle the error
        return;
    }

    console.log("Success Response: " + JSON.stringify(data));
});
INPUT PARAMETERS
None
OUTPUT
id Object ID
creditAmount Credit Amount in the smallest unit of your currency. Example: 100 = $1.00
creditCount Credit Count
currency Currency
dateCreated Date in UTC millis the deposit was created in the system
debitAmount Debit Amount in the smallest unit of your currency. Example: 100 = $1.00
debitCount Debit Count
depositDate Deposit Date in UTC millis
netAmount Net Amount in the smallest unit of your currency. Example: 100 = $1.00
netCount Net Count