TransactionReview

An instance of a review for a given payment or authorization.

TransactionReview / Create

Create | List

Examples

Create TransactionReview
PaymentsApi.PUBLIC_KEY = "YOUR_PUBLIC_API_KEY";
PaymentsApi.PRIVATE_KEY = "YOUR_PRIVATE_API_KEY";

TransactionReview transactionReview = TransactionReview.create(new PaymentsMap()
);

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

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

transactionReview = Simplify::TransactionReview.create({
        "amount" => "100",
        "payment" => "[PAYMENT ID]",
        "reason" => "Refund Description"
})

puts transactionReview.inspect
import simplify

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

transactionReview = simplify.TransactionReview.create({
        "amount" : "100",
        "payment" : "[PAYMENT ID]",
        "reason" : "Refund Description"

})

print transactionReview
<?php

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

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

$transactionReview = Simplify_TransactionReview::createTransactionReview(array(
        'amount' => '100',
        'payment' => '[PAYMENT ID]',
        'reason' => 'Refund Description'
));

print_r($transactionReview);

?>
use Net::Simplify;

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

my $transactionReview = Net::Simplify::TransactionReview->create({
    amount => "100",
    payment => "[PAYMENT ID]",
    reason => "Refund Description"
});

print "TransactionReview ID ", $transactionReview->{id}, "\n";
using SimplifyCommerce.Payments;

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

PaymentsApi api = new PaymentsApi();

TransactionReview transactionReview = new TransactionReview();

try
{
    transactionReview = (TransactionReview)api.Create(transactionReview);
}
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.transactionreview.create({
    amount : "100",
    payment : "[PAYMENT ID]",
    reason : "Refund Description"
}, 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
fraudResult.id ID of the fraud record.
id Transaction Review ID.
transaction.card.customer.id Customer ID
transaction.card.id Unique ID of the card associated with the payment
transaction.id Transaction ID
dateCreated Date the review was created.
fraudResult Fraud details attached to this transaction.
fraudResult.avsMatchCode AVS check code: “M” for match, “N” for no match, “W” zip code match only, “Z” address match only, “U” data unavailable, “S” not supported, “R” retry, “E” error.
fraudResult.cvcMatchCode CVC check code.
fraudResult.dateCreated Date the fraud result record was created.
fraudResult.detail Details regarding transaction and the fraud detection carried out.
fraudResult.fraudulent Flag indicating whether the transaction is considered fraudulent or not.
fraudResult.lastUpdated Date the fraud result record was last updated.
fraudResult.mapName Map showing the zip code of the billing address, shipping address and IP location, if available.
fraudResult.score Fraud detection score.
fraudResult.status Fraud status.
lastUpdated Date the review was last updated.
status Status of the review.
transaction Payment or Authorization for which this review was created.
transaction.amount Amount of the payment in the smallest unit of your currency. Example: 100 = $1.00
transaction.amountEstimated Flag indicating whether the settlement amount is estimated, or is the actual settled amount.
transaction.authCode Payment authorization code
transaction.card Credit or debit card being used to apply the payment to.
transaction.card.addressCity City of the cardholder.
transaction.card.addressCountry Country code (ISO-3166-1-alpha-2 code) of residence of the cardholder.
transaction.card.addressLine1 Address of the cardholder.
transaction.card.addressLine2 Address of the cardholder if needed.
transaction.card.addressState State of residence of the cardholder. State abbreviations should be used.
transaction.card.addressZip Postal code of the cardholder. The postal code size is between 5 and 9 in length and only contain numbers or letters.
transaction.card.customer Customer associated with the card
transaction.card.customer.email Email address of the customer
transaction.card.customer.name Name of the customer
transaction.card.dateCreated Creation date in UTC millis of the card in the system
transaction.card.expMonth Expiration month of the card. Format is MM. Example: January = 01
transaction.card.expYear Expiration year of the card. Format is YY. Example: 2013 = 13
transaction.card.indicator Card indicator, i.e. DEBIT, CREDIT or CHARGE CARD.
transaction.card.indicatorSource Card indicator source.
transaction.card.last4 Last 4 digits of the card number
transaction.card.name Name as appears on the card.
transaction.card.type Type of credit or debit card
transaction.currency Currency code (ISO-4217) for the transaction. Must match the currency associated with your account.
transaction.dateCreated Date the payment occurred in UTC millis
transaction.declineReason Decline Reason
transaction.description Description of payment
transaction.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.
transaction.feeCurrency ISO4217 Currency code for the fee.
transaction.feeEstimated Flag indicating whether fees provided are estimated or actual.
transaction.paymentDate Date of payment in UTC millis.
transaction.paymentStatus Payment status.
transaction.settlementAmount Amount of the payment converted to your currency.
transaction.settlementCurrency ISO4217 Currency code for the settlement currency.
transaction.source The source of the payment (one of ECOMMERCE or VIRTUAL_TERMINAL)
transactionType Type of transaction this review is attached to, “payment” or “authorization”.

TransactionReview / Delete

INPUT PARAMETERS
id ID of the transaction review to delete. required
OUTPUT
fraudResult.id ID of the fraud record.
id Transaction Review ID.
transaction.card.customer.id Customer ID
transaction.card.id Unique ID of the card associated with the payment
transaction.id Transaction ID
dateCreated Date the review was created.
fraudResult Fraud details attached to this transaction.
fraudResult.avsMatchCode AVS check code: “M” for match, “N” for no match, “W” zip code match only, “Z” address match only, “U” data unavailable, “S” not supported, “R” retry, “E” error.
fraudResult.cvcMatchCode CVC check code.
fraudResult.dateCreated Date the fraud result record was created.
fraudResult.detail Details regarding transaction and the fraud detection carried out.
fraudResult.fraudulent Flag indicating whether the transaction is considered fraudulent or not.
fraudResult.lastUpdated Date the fraud result record was last updated.
fraudResult.mapName Map showing the zip code of the billing address, shipping address and IP location, if available.
fraudResult.score Fraud detection score.
fraudResult.status Fraud status.
lastUpdated Date the review was last updated.
status Status of the review.
transaction Payment or Authorization for which this review was created.
transaction.amount Amount of the payment in the smallest unit of your currency. Example: 100 = $1.00
transaction.amountEstimated Flag indicating whether the settlement amount is estimated, or is the actual settled amount.
transaction.authCode Payment authorization code
transaction.card Credit or debit card being used to apply the payment to.
transaction.card.addressCity City of the cardholder.
transaction.card.addressCountry Country code (ISO-3166-1-alpha-2 code) of residence of the cardholder.
transaction.card.addressLine1 Address of the cardholder.
transaction.card.addressLine2 Address of the cardholder if needed.
transaction.card.addressState State of residence of the cardholder. State abbreviations should be used.
transaction.card.addressZip Postal code of the cardholder. The postal code size is between 5 and 9 in length and only contain numbers or letters.
transaction.card.customer Customer associated with the card
transaction.card.customer.email Email address of the customer
transaction.card.customer.name Name of the customer
transaction.card.dateCreated Creation date in UTC millis of the card in the system
transaction.card.expMonth Expiration month of the card. Format is MM. Example: January = 01
transaction.card.expYear Expiration year of the card. Format is YY. Example: 2013 = 13
transaction.card.indicator Card indicator, i.e. DEBIT, CREDIT or CHARGE CARD.
transaction.card.indicatorSource Card indicator source.
transaction.card.last4 Last 4 digits of the card number
transaction.card.name Name as appears on the card.
transaction.card.type Type of credit or debit card
transaction.currency Currency code (ISO-4217) for the transaction. Must match the currency associated with your account.
transaction.dateCreated Date the payment occurred in UTC millis
transaction.declineReason Decline Reason
transaction.description Description of payment
transaction.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.
transaction.feeCurrency ISO4217 Currency code for the fee.
transaction.feeEstimated Flag indicating whether fees provided are estimated or actual.
transaction.paymentDate Date of payment in UTC millis.
transaction.paymentStatus Payment status.
transaction.settlementAmount Amount of the payment converted to your currency.
transaction.settlementCurrency ISO4217 Currency code for the settlement currency.
transaction.source The source of the payment (one of ECOMMERCE or VIRTUAL_TERMINAL)
transactionType Type of transaction this review is attached to, “payment” or “authorization”.

TransactionReview / List

Create | List

Examples

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

ResourceList<TransactionReview> transactionReview = TransactionReview.list(new PaymentsMap("max", 30));

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

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

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

transactionReviews = simplify.TransactionReview.list({"max": 30})

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

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

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

$transactionReview = Simplify_TransactionReview::listTransactionReview(array("max" => 30));

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

$transactionReviews = Net::Simplify::TransactionReview->list({max => 30});

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

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

PaymentsApi api = new PaymentsApi();


try
{
    ResourceList<TransactionReview> transactionReview = (ResourceList<TransactionReview>)api.List(typeof(TransactionReview));

    Console.WriteLine ("Total: " + transactionReview.Total);
    Console.WriteLine ("List: " + transactionReview.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.transactionreview.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 Id of the transaction review
filter.labelFilter by the status of the transaction review
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:dateCreated, status 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

TransactionReview / Find

INPUT PARAMETERS
None
OUTPUT
fraudResult.id ID of the fraud record.
id Transaction Review ID.
transaction.card.customer.id Customer ID
transaction.card.id Unique ID of the card associated with the payment
transaction.id Transaction ID
dateCreated Date the review was created.
fraudResult Fraud details attached to this transaction.
fraudResult.avsMatchCode AVS check code: “M” for match, “N” for no match, “W” zip code match only, “Z” address match only, “U” data unavailable, “S” not supported, “R” retry, “E” error.
fraudResult.cvcMatchCode CVC check code.
fraudResult.dateCreated Date the fraud result record was created.
fraudResult.detail Details regarding transaction and the fraud detection carried out.
fraudResult.fraudulent Flag indicating whether the transaction is considered fraudulent or not.
fraudResult.lastUpdated Date the fraud result record was last updated.
fraudResult.mapName Map showing the zip code of the billing address, shipping address and IP location, if available.
fraudResult.score Fraud detection score.
fraudResult.status Fraud status.
lastUpdated Date the review was last updated.
status Status of the review.
transaction Payment or Authorization for which this review was created.
transaction.amount Amount of the payment in the smallest unit of your currency. Example: 100 = $1.00
transaction.amountEstimated Flag indicating whether the settlement amount is estimated, or is the actual settled amount.
transaction.authCode Payment authorization code
transaction.card Credit or debit card being used to apply the payment to.
transaction.card.addressCity City of the cardholder.
transaction.card.addressCountry Country code (ISO-3166-1-alpha-2 code) of residence of the cardholder.
transaction.card.addressLine1 Address of the cardholder.
transaction.card.addressLine2 Address of the cardholder if needed.
transaction.card.addressState State of residence of the cardholder. State abbreviations should be used.
transaction.card.addressZip Postal code of the cardholder. The postal code size is between 5 and 9 in length and only contain numbers or letters.
transaction.card.customer Customer associated with the card
transaction.card.customer.email Email address of the customer
transaction.card.customer.name Name of the customer
transaction.card.dateCreated Creation date in UTC millis of the card in the system
transaction.card.expMonth Expiration month of the card. Format is MM. Example: January = 01
transaction.card.expYear Expiration year of the card. Format is YY. Example: 2013 = 13
transaction.card.indicator Card indicator, i.e. DEBIT, CREDIT or CHARGE CARD.
transaction.card.indicatorSource Card indicator source.
transaction.card.last4 Last 4 digits of the card number
transaction.card.name Name as appears on the card.
transaction.card.type Type of credit or debit card
transaction.currency Currency code (ISO-4217) for the transaction. Must match the currency associated with your account.
transaction.dateCreated Date the payment occurred in UTC millis
transaction.declineReason Decline Reason
transaction.description Description of payment
transaction.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.
transaction.feeCurrency ISO4217 Currency code for the fee.
transaction.feeEstimated Flag indicating whether fees provided are estimated or actual.
transaction.paymentDate Date of payment in UTC millis.
transaction.paymentStatus Payment status.
transaction.settlementAmount Amount of the payment converted to your currency.
transaction.settlementCurrency ISO4217 Currency code for the settlement currency.
transaction.source The source of the payment (one of ECOMMERCE or VIRTUAL_TERMINAL)
transactionType Type of transaction this review is attached to, “payment” or “authorization”.

TransactionReview / Update

INPUT PARAMETERS
id ID of the transaction review to update.
[max length: 255]
required
status Status of the transaction review. optional
OUTPUT
fraudResult.id ID of the fraud record.
id Transaction Review ID.
transaction.card.customer.id Customer ID
transaction.card.id Unique ID of the card associated with the payment
transaction.id Transaction ID
dateCreated Date the review was created.
fraudResult Fraud details attached to this transaction.
fraudResult.avsMatchCode AVS check code: “M” for match, “N” for no match, “W” zip code match only, “Z” address match only, “U” data unavailable, “S” not supported, “R” retry, “E” error.
fraudResult.cvcMatchCode CVC check code.
fraudResult.dateCreated Date the fraud result record was created.
fraudResult.detail Details regarding transaction and the fraud detection carried out.
fraudResult.fraudulent Flag indicating whether the transaction is considered fraudulent or not.
fraudResult.lastUpdated Date the fraud result record was last updated.
fraudResult.mapName Map showing the zip code of the billing address, shipping address and IP location, if available.
fraudResult.score Fraud detection score.
fraudResult.status Fraud status.
lastUpdated Date the review was last updated.
status Status of the review.
transaction Payment or Authorization for which this review was created.
transaction.amount Amount of the payment in the smallest unit of your currency. Example: 100 = $1.00
transaction.amountEstimated Flag indicating whether the settlement amount is estimated, or is the actual settled amount.
transaction.authCode Payment authorization code
transaction.card Credit or debit card being used to apply the payment to.
transaction.card.addressCity City of the cardholder.
transaction.card.addressCountry Country code (ISO-3166-1-alpha-2 code) of residence of the cardholder.
transaction.card.addressLine1 Address of the cardholder.
transaction.card.addressLine2 Address of the cardholder if needed.
transaction.card.addressState State of residence of the cardholder. State abbreviations should be used.
transaction.card.addressZip Postal code of the cardholder. The postal code size is between 5 and 9 in length and only contain numbers or letters.
transaction.card.customer Customer associated with the card
transaction.card.customer.email Email address of the customer
transaction.card.customer.name Name of the customer
transaction.card.dateCreated Creation date in UTC millis of the card in the system
transaction.card.expMonth Expiration month of the card. Format is MM. Example: January = 01
transaction.card.expYear Expiration year of the card. Format is YY. Example: 2013 = 13
transaction.card.indicator Card indicator, i.e. DEBIT, CREDIT or CHARGE CARD.
transaction.card.indicatorSource Card indicator source.
transaction.card.last4 Last 4 digits of the card number
transaction.card.name Name as appears on the card.
transaction.card.type Type of credit or debit card
transaction.currency Currency code (ISO-4217) for the transaction. Must match the currency associated with your account.
transaction.dateCreated Date the payment occurred in UTC millis
transaction.declineReason Decline Reason
transaction.description Description of payment
transaction.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.
transaction.feeCurrency ISO4217 Currency code for the fee.
transaction.feeEstimated Flag indicating whether fees provided are estimated or actual.
transaction.paymentDate Date of payment in UTC millis.
transaction.paymentStatus Payment status.
transaction.settlementAmount Amount of the payment converted to your currency.
transaction.settlementCurrency ISO4217 Currency code for the settlement currency.
transaction.source The source of the payment (one of ECOMMERCE or VIRTUAL_TERMINAL)
transactionType Type of transaction this review is attached to, “payment” or “authorization”.