Fees Summary

REST Sandbox URL: https://sandbox.4levers.com/NewReportsApi/api/Reports/fees-summary

REST Production URL: https://reports-api.4levers.com/api/Reports/fees-summary

Fees Summary report provides a complete overview of all the fees that have been processed on your Sub-Account on a specific date.

Fees Summary report displays incoming fees for transactions processed by the same Sub-Account, as the fee target Sub-Account.

Request Example (REST Production URL)

GET: https://reports-api.4levers.com/api/Reports/fees-summary?DateFrom=2019-07-23&DateTo=2019-07-24

Request Parameters

Name	Type	Required	Description
datefrom	datetime	✓	determines the selection starting/ending time range
dateto	datetime	✓	determines the selection starting/ending time range
feeid	integer/array	optional	enter your fee id(s)
feegroupid	integer/array	optional	enter your fee group id(s)
feetype	enum	optional	select fee type to output in the report Available Values: pertransaction calculated per transaction scalerange calculated per transaction count scheduled calculated on a scheduled basis interchangefee interchange fees feeonfee fees for other fees
feecategory	enum	optional	nullable fee categories Available Values: fee tax
processors	string/array	optional	clearing acquirer name(s)
feetargets	enum	optional	specify the fee recipient Available Values: platform platform is a fee recipient serviceprovider service provider is a fee recipient operator operator is a fee recipient reservebalance fee assigned to a reserve balance subaccount sub-account is a fee recipient outgoing outgoing fees agent fees for agents
serviceproviders	integer/array	optional	enter your service provider id(s)
operators	integer/array	optional	enter your operator id(s)
accounts	integer/array	optional	enter your platform account id(s)
subaccounts	string/array	optional	enter your sub-account id(s)
skip	integer	optional	these parameters determine which records will be displayed in the report based on specified index number. to get from fifth to twentieth record specify skip = 4 and take = 16
take	integer	optional
currencies	string array	optional	enter currency type ids to filter sub-accounts by Available Values: CAD USD EUR GBP AUD SGD JPY NZD

Response Parameters

	Name	Description
	feeDate	system fee processing date and time
	feename	name of the fee
	feegroupname	name of the fee group
	feetype	fee type
	feecategory	fee categories
	transactionid	transaction identifier
	marchanttransactionid	transaction identifier per merchant
	processortransactionid	transaction identifier per processor
	transactiontype	type of transaction a fee has been calculated for
	transactionamount	transaction amount
	pertrxamount	fee per transaction fee amount
	pertrxpercentage	fee percentage value per transaction
	feeamount	fee fixed amount
	currency	fee currency
	feetarget	fee recipient
	subaccount	sub-account identifier
	platformaccount	platform account name
	billingamount	billing amount value. used to calculate transaction commissions and fees.

				
					[
  {
        "feeDate": "2022-03-04T17:59:59",  
        "feeName": "test_fee", 
        "feeGroupName": "test",    
        "feeType": "Per Transaction Fee",    
        "feeCategory": "Tax",  
        "transactionId": "1588001137083647671",    
        "merchantTransactionId": "69", 
        "processorTransactionId": "90ed214e-8558-4e49-987e-2a56c4e7bbae",  
        "transactionSystemDate": "0001-01-01T00:00:00",    
        "transactionMerchantDate": "2022-03-01T00:00:00",  
        "transactionOrigin": "test_accountId", 
        "transactionType": "Charge",   
        "transactionDescription": "test",  
        "merchantFreeText": "here can be any Merchant Free Text",    
        "paymentMethod": "Visa",   
        "entryMode": "0-Unknown",  
        "transactionAmount": "15.00",  
        "transactionStatus": "Processed",  
        "processor": "Emulator",   
        "terminalId": "t--0123345345345345",   
        "billingAmount": "15.000000",  
        "perTrxAmount": "0.000000",    
        "perTrxPercentage": "10.000000",   
        "feeAmount": "1.500000",   
        "feeTarget": "ti4_sub2",   
        "currency": "USD", 
        "subAccount": "test_account",
        "platformAccount": "test_account"
  },
  {
    "feeDate": "2022-03-04T17:59:59",  
        "feeName": "test_fee", 
        "feeGroupName": "test",    
        "feeType": "Per Transaction Fee",    
        "feeCategory": "Tax",  
        "transactionId": "1588001137083647671",    
        "merchantTransactionId": "69", 
        "processorTransactionId": "90ed214e-8558-4e49-987e-2a56c4e7bbae",  
        "transactionSystemDate": "0001-01-01T00:00:00",    
        "transactionMerchantDate": "2022-03-01T00:00:00",  
        "transactionOrigin": "test_accountId", 
        "transactionType": "Charge",   
        "transactionDescription": "test",  
        "merchantFreeText": "here can be any Merchant Free Text",    
        "paymentMethod": "Visa",   
        "entryMode": "0-Unknown",  
        "transactionAmount": "15.00",  
        "transactionStatus": "Processed",  
        "processor": "Emulator",   
        "terminalId": "t--0123345345345345",   
        "billingAmount": "15.000000",  
        "perTrxAmount": "0.000000",    
        "perTrxPercentage": "10.000000",   
        "feeAmount": "1.500000",   
        "feeTarget": "ti4_sub2",   
        "currency": "USD", 
        "subAccount": "test_account",
        "platformAccount": "test_account"
  }
]

Still stuck? How can we help?

Was this page helpful? Yes No