developer:resellerapi:objects:merchantsummary

MerchantSummary

Summary of merchant activity over a given time period.

Description

Time period to be analyzed must be specified in the initial search using the getMerchantSummary method. All information returned applies only to the specified time period and is not a definitive total of all of the merchant's transaction information. The summary data is not real time and can lag up to 2 hours.

Properties

Type Name Description
integer MerchantID Merchant ID (assigned by the gateway).
string MerchantName Name of the merchant whose activity you are searching.
Credit Card Activity
integer SalesCount Total number of sales processed by the merchant.
double SalesAmount Total dollar amount of sales processed.
integer CreditsCount Total number of credits processed by the merchant.
double CreditsAmount Total dollar amount of credits processed.
integer VoidsCount Total number of voids processed by the merchant.
double VoidsAmount Total dollar amount of voids processed.
integer DeclinesCount Total number of declines processed by the merchant.
double DeclinesAmount Total dollar amount of declines processed
ACH (Check) Activity
integer CheckSalesCount Total number of check sales processed (by date entered)
double CheckSalesAmount Total dollar amount of check sales processed (by date entered)
integer CheckRefundsCount Total number of check refunds processed (by date entered)
double CheckRefundsAmount Total dollar amount of check refunds processed (by date entered)
integer ReturnedCheckSaleCount Total number of check sales returned (by date returned)
double ReturnedCheckSaleAmount Total dollar amount of check sales returned (by date returned)
integer ReturnedCheckRefundCount Total number of check refunds returned (by date returned)
double ReturnedCheckRefundAmount Total dollar amount of check refunds returned (by date returned)
integer CheckChargebacksCount Total number of check sales returned as chargebacks (by date returned)
double CheckChargebacksAmount Total dollar amount of check sales returned as chargebacks (by date returned)
integer SettledCheckSaleCount Total number of check sales settled (by date settled)
double SettledCheckSaleAmount Total dollar amount of check sales settled (by date settled)
integer SettledCheckRefundCount Total number of check refunds settled (by date settled)
double SettledCheckRefundAmount Total dollar amount of check refunds settled (by date settled)
integer LargeCheckSalesCount Total number of large check sales processed (by date entered). Large checks are any ach transaction that exceeds a merchants defined threshold (typically $5,000)
double LargeCheckSalesAmount Total dollar amount of large check sales processed (by date entered)
integer LargeCheckRefundsCount Total number of large check refunds processed (by date entered)
double LargeCheckRefundsAmount Total dollar amount of Large check refunds processed (by date entered)
integer CheckDepositCount Total number of ach batches deposited to merchant (not support for all ach platforms)

Places Used

Change History

Version Change
1.4 Add new ACH summary parameters
developer/resellerapi/objects/merchantsummary.txt · Last modified: 2010/08/16 11:41 by tem

Page Tools