Management API Index (Components)

Name	Description
Account Activity Enum	Enumerates types of financial transactions that can occur on a customer's account.	view xml
Address Enum	Enumeration of possible types of addresses available in the system.	view xml
Address Source Enum		view xml
Adjustment Enum	Enumeration of possible adjustment types.	view xml
Asset Transaction Enum	Enumerates types of asset transactions.	view xml
BackgroundVerificationResult	Represents result of background verification that ran for a business or a person (business owner).	view xml
Bankruptcy	Represents information about bankruptcy history of the company based on background verification...	view xml
BatchFee	Represents fees that are applied to all batch sale/credit transactions.	view xml
BatchFeeCommission	Represents commissions that are applied to batch sale/credit transactions.	view xml
BatchFeePolicy	Represents commission policy applied to batch sale/credit transactions.	view xml
Billing Cycle Activity Enum	Enumeration of possible billing cycle activities available in the system.	view xml
Billing Cycle Enum		view xml
Billing History Enum	Entity that represents billing history records available in the system.	view xml
BillingSettings	Represents information about recurring billing settings assigned to a particular merchant.	view xml
BrandingProfile	Represents configuration settings for branding profile.	view xml
BusinessInfo	Represents fields reflecting business information for a merchant.	view xml
BusinessOwner	Represents the owner of the business.	view xml
BusinessReference	Represents information about the company to be used as a business reference of the merchant.	view xml
CancelEmail	Represents the list of email templates used for notification about credit or refund getting...	view xml
Charge Enum		view xml
Claim Enum		view xml
Commission Enum	Enumeration of possible commission to be charged depending on the type of action.	view xml
Commission Status Enum	Enumeration of possible commission statuses.	view xml
CommissionPolicy	Represents configuration for revenue sharing for the reseller.	view xml
Contract Enum		view xml
Contract Status Enum	Enumeration of possible contract statuses.	view xml
ConvenienceFee	Represents rules according to which convenience fee is charged on merchant’s transactions.	view xml
CopyToList	Represents the list of merchant codes or merchant account codes that are targets for copyTo action....	view xml
Credit Agency Delete Enum		view xml
Credit Agency Dispute Enum		view xml
Credit Agency Status Enum	Enumeration of possible credit agency statuses.	view xml
Credit Agency Transaction Status Enum	Enumeration of possible credit agency transaction statuses.	view xml
Customer	Represents information about the customer.	view xml
Customer Account Status Enum	Represents states/statuses of a customer account.	view xml
Customer Enum	Enumeration of possible customer types available in the system.	view xml
CustomerFees	Represents fees that are applied to merchant's customers.	view xml
DateRange	Represents a date range with lower and upper limits. Range can include only lower or only upper...	view xml
Decline Enum	Enumeration of possible transaction decline types.	view xml
Email Confirmation Enum	Enumeration of possible email confirmation notifications available in the system.	view xml
Email Enum	Enumeration of possible customer's (or merchant's) email address types.	view xml
Email Status Enum	Enumeration of possible email statuses.	view xml
FeeCycle	Represents information about the day of a month when fees are withdrawn.	view xml
FieldList	Represents the list of fields within an object that should be included as part of the result...	view xml
FlatFee	Represents fees that are applied to all transactions other than sale and credit.	view xml
FlatFeeCommission	Represents commission structure for fees applied to all transactions other than sale and credit.	view xml
Import Log Status Enum	Enumerates statuses of an import file processing.	view xml
InvoiceNotificationEmail	Represents the list of email settings used for notification about invoice being created.	view xml
Key	Represents a security key (pgp, ssl, etc) stored and managed within the system.	view xml
KeyType	Represents the enumeration of possible types of a security key.	view xml
Lead	Represents lead object.	view xml
Letter Status Enum	Enumerates possible statuses within letter processing life cycle.	view xml
Lien	Represents information about the lien history of the company.	view xml
Merchant	Represents merchant object without sub-components	view xml
MerchantChargebacksReserve	Encapsulates chargeback reserve related information.	view xml
MerchantChargeInfo	Group fields reflecting information of merchant's charge account.	view xml
MerchantContactInfo	Groups fields reflecting contact information for a merchant	view xml
MerchantDepositInfo	Deposit information for remittances sent to the merchant.	view xml
MerchantEmails	Encapsulates information and settings for automated emails.	view xml
MerchantFacade	Represents merchant object with all sub-components	view xml
MerchantFee	Represents fees that are applied to a merchant.	view xml
MerchantLetters	Encapsulates information and settings for automated letters.	view xml
MerchantLimits	Represents information about limits applicable to transactions performed by the merchant or...	view xml
MerchantPhases	Encapsulates information on time intervals that are used to classify outstanding debt.	view xml
MerchantProcessingInfo	Groups processing related settings of the merchant.	view xml
MerchantRefundsReserve	Encapsulates refund reserve related information.	view xml
MerchantRemittanceConfig	Integration settings for the merchant remittance process.	view xml
MerchantRemittanceInfo	Remittance settings for the merchant.	view xml
MerchantReturnsReserve	Encapsulates returns reserve related information.	view xml
Object Enum	Enumeration of possible values of objects, that can be used as the creteria for selection for the...	view xml
Payment Option Enum	Enumerates possible types of payment options.	view xml
Payment Plan Enum	Enumeration of possible types of payment plans.	view xml
PaymentOption	Payment option information associated with the merchant.	view xml
Phone Enum		view xml
Plan	Represents information about the plan.	view xml
Portfolio	Represents portfolio object without sub-components.	view xml
PostRule	Set of rules to validate AVS/CSC response codes	view xml
PreRule	Set of rules to validate billing address, issuing bank country, BIN	view xml
ProcessingInfo	Information associated with transaction processing within internal and external systems.	view xml
ProcessingRequest	Represents information included in processing request sent to a processor.	view xml
RealtimeFee	Represents fees that are applied to all real-time sale/credit transactions.	view xml
RealtimeFeeCommission	Represents commission structure for realtime fees.	view xml
RealtimeFeePolicy	Encapsulates various rules used during the fee assessment process.	view xml
RecurringFee	Represents fees that are charged on a monthly basis.	view xml
RecurringFeeCommission	Represents commission structure for fees charged on a monthly basis.	view xml
Reseller	Represents reseller object without sub-components.	view xml
ResellerContactInfo	Groups fields reflecting contact information for a reseller	view xml
ResellerDepositInfo	Groups fields reflecting deposit information for a reseller	view xml
Return Enum		view xml
ReturnsDeliveryFrequency	Defines delivery schedule for returns.	view xml
Review Enum	Enumeration of possible review process stages.	view xml
RiskIndicator	Encapsulates information on risk indicator found during background verification of a merchant or an...	view xml
Scheduled Payment Status Enum	Enumeration of possible scheduled payment statuses.	view xml
ServiceResponse	Response envelope for error messages and status message returned by actions that generate no...	view xml
SettlementMode	Represents settlement mode used for processing with a particular provider.	view xml
SettlementModePaymentech	Represents settlement mode used for processing with Paymentech.	view xml
SettlementType	Enumerates possible types of settlement for real-time authorizations.	view xml
Skip Trace Enum		view xml
Skip Trace Mode Enum		view xml
Subscription	Information about the subscription transaction.	view xml
Subscription Adjustment Enum		view xml
SubscriptionAdjustment	Adjustment applied to a subscription transaction.	view xml
Suffix Enum		view xml
Terminal		view xml
Terminal	Represents information about the terminal.	view xml
TerminalData		view xml
TerminalOrder	Represents information about the terminal order shipping settings.	view xml
TerminalOrderDetail	Represents information about terminals included in the order.	view xml
TerminalProfile		view xml
Time Cycle Enum	Enumeration of possible time cycle types available in the system.	view xml
Title Enum	Enumeration of possible titles used in various notifications to address a client.	view xml
Transaction	Represents a transaction associated with a particular merchant.	view xml
User	Represents user of the system.	view xml
UserAccessInfo	Groups fields reflecting access information for a user	view xml
UserContactInfo	Groups fields reflecting contact information for a user	view xml

All Logos and Trademarks used or mentioned on this page are copyrighted property of their respective owners and are used for display purposes only.