Chargeback

An instance of a credit/debit card payment that is in dispute.

Chargeback / List

List | Find

Examples

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

ResourceList<Chargeback> chargeback = Chargeback.list(new PaymentsMap("max", 30));

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

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

val = Simplify::Chargeback.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"

chargebacks = simplify.Chargeback.list({"max": 30})

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

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

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

$chargeback = Simplify_Chargeback::listChargeback(array("max" => 30));

print "Total: " . $chargeback->total . "\n";
foreach ($chargeback->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";

$chargebacks = Net::Simplify::Chargeback->list({max => 30});

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

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

PaymentsApi api = new PaymentsApi();


try
{
    ResourceList<Chargeback> chargeback = (ResourceList<Chargeback>)api.List(typeof(Chargeback));

    Console.WriteLine ("Total: " + chargeback.Total);
    Console.WriteLine ("List: " + chargeback.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.chargeback.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.textFilter by the description of the chargeback
filter.idFilter by the chargeback Id
filter.amountFilter by the chargeback 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.chargebackDateMin*Filter by the earliest chargeback date you are searching for - Date in UTC millis
filter.chargebackDateMax*Filter by the latest chargeback date you are searching for - Date in UTC millis
filter.depositFilter by the deposit id
filter.qYou can use this to filter by the Id, the payment card's last 4 digits or the chargeback amount

*Use dateCreatedMin with dateCreatedMax (or chargebackDateMin and chargebackDateMax) 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:id, amount, description, dateCreated 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

Chargeback / Find

List | Find

Examples

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

Chargeback chargeback = Chargeback.find("4TR6Bc");

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

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

chargeback = Simplify::Chargeback.find('4TR6Bc')

puts chargeback.inspect

import simplify

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

chargeback = simplify.Chargeback.find('4TR6Bc')

print chargeback
<?php

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

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

$obj  = Simplify_Chargeback::findChargeback('4TR6Bc');

print_r($obj);

?>
use Net::Simplify;

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

$chargeback = Net::Simplify::Chargeback->find('4TR6Bc');

print $chargeback->{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";

    Chargeback chargeback = (Chargeback)api.Find(typeof(Chargeback), id);

    // output all properties
    Console.WriteLine(JsonConvert.SerializeObject(chargeback).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.chargeback.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 Unique id of the chargeback
payment.authorization.id Authorization ID
payment.card.customer.id Customer ID
payment.card.id Unique ID of the card associated with the payment
payment.customer.id Customer ID
payment.id Payment ID
payment.refunds.id Unique id of the refund
payment.transactionDetails.id Transaction details id
amount Amount of the refund in the smallest unit of your currency. Example: 100 = $1.00
currency Currency code (ISO-4217) for the chargeback. Must match the currency associated with your account.
dateCreated Date in UTC millis the refund was created in the system
description Reason for the chargeback
fee Fee associated with this chargeback
feeCurrency Currency code (ISO4217) for the chargeback fee.
last4 Last 4 numbers of the card associated with this chargeback
payment Payment associated with chargeback
payment.amount Amount of the payment in the smallest unit of your currency. Example: 100 = $1.00
payment.amountEstimated Flag indicating whether the settlement amount is estimated, or is the actual settled amount.
payment.amountRemaining Amount of the payment less any refunds that have been applied in the smallest unit of your currency. Example: 100 = $1.00
payment.authCode Payment authorization code
payment.authorization Authorization associated with a payment if the payment was not captured immediately.
payment.card Credit or debit card being used to apply the payment to.
payment.card.addressCity City of the cardholder.
payment.card.addressCountry Country code (ISO-3166-1-alpha-2 code) of residence of the cardholder.
payment.card.addressLine1 Address of the cardholder.
payment.card.addressLine2 Address of the cardholder if needed.
payment.card.addressState State of residence of the cardholder. State abbreviations should be used.
payment.card.addressZip Postal code of the cardholder. The postal code size is between 5 and 9 in length and only contain numbers or letters.
payment.card.customer Customer associated with the card
payment.card.customer.email Email address of the customer
payment.card.customer.name Name of the customer
payment.card.dateCreated Creation date in UTC millis of the card in the system
payment.card.expMonth Expiration month of the card. Format is MM. Example: January = 01
payment.card.expYear Expiration year of the card. Format is YY. Example: 2013 = 13
payment.card.indicator Card indicator, i.e. DEBIT, CREDIT or CHARGE CARD.
payment.card.indicatorSource Card indicator source.
payment.card.last4 Last 4 digits of the card number
payment.card.name Name as appears on the card.
payment.card.type Type of credit or debit card
payment.currency Currency code (ISO-4217) for the transaction. Must match the currency associated with your account.
payment.customer Customer associated with the payment
payment.customer.email Email address of the customer
payment.customer.name Name of the customer
payment.dateCreated Date the payment occurred in UTC millis
payment.declineReason Decline Reason.
payment.description Description of payment
payment.disputed Flag to indicate if there is a dispute on this payment
payment.fee The fee charged for processing the transaction. This is the summation of a percentage of the transaction's value and a per transaction fee.
payment.feeCurrency ISO4217 Currency code for the fee.
payment.feeEstimated Flag indicating whether fees provided are estimated or actual.
payment.paymentDate Date of payment in UTC millis.
payment.paymentStatus Payment status.
payment.reference Custom reference field to be used with outside systems
payment.refunded Boolean if the payment was refunded or not
payment.refundedFees The total amount of fees refunded as a result of refund(s) on a payment.
payment.refunds Refunds associated with this payment
payment.replayId The replayId that was submitted with the payment create request.
payment.settlementAmount Amount of the payment converted to your currency.
payment.settlementCurrency ISO4217 Currency code for the settlement currency.
payment.source The source of the payment (one of ECOMMERCE or VIRTUAL_TERMINAL)
payment.taxExempt Specify true to indicate that the payment is tax-exempt.
payment.transactionData Level 2 and 3 data associated with the payment.
payment.transactionDetails Raw response from the payment processor.
payment.transactionDetails.data Raw response data from the acquirer.
reference Custom reference field to be used with outside systems
resolution Resolution description of the chargeback
settlementCurrency ISO4217 Currency code of the settlement amount.
transactionAmount Amount of the payment associated with this chargeback
transactionDate Date of the payment associated with this chargeback