• User Documentation 
  • Amaryllis Release Notes 
  • For Developers 

  • User Documentation 
  • Amaryllis Release Notes 
  • For Developers 

Heartland - Dev Portal

  • folder icon closed folder iconIntroduction
  • folder icon closed folder iconAuthentication
  • folder icon closed folder iconManagement
    • Getting Started
    • Platform Accounts Management
      • Get Platform Account Configuration
      • Get Platform Account
      • Create Platform Account
      • Update Platform Account
      • Objects Reference
    • Sub-Accounts Management
      • Get Sub-Account Configurations
      • Get Sub-Account
      • Create Sub-Account
      • Update Sub-Account
      • Objects Reference
    • Users Management
      • Get User by User Id
      • Get User by Username
      • Create User
      • Update User
      • Objects Reference
    • Underwriting Management
      • Get Application
      • Get Application Template
      • Get Application Fields Statuses
      • Get Application Status
      • Get Linked Sub-Accounts
      • Get Resubmission
      • UMS IFrame Authentication
      • UMS IFrame
      • UMS IFrame Authentication in Resubmission Mode
      • UMS IFrame in Resubmission Mode
      • Create Application
      • Update Application
      • Update Application Fields Statuses
      • Update Application Status
      • Objects Reference
      • Response Codes
  • folder icon closed folder iconTransactions Processing
    • Getting Started
    • Credit Card Transactions
      • 3D-Secure
      • Authorization
      • Void
      • Capture
      • Charge
      • Refund
      • Credit
      • Verify
      • Chargeback
      • Cancel
    • Update
    • Adjustment
    • Recurring
    • ACH
    • Response
    • Response Codes
    • Objects Reference
  • folder icon closed folder iconTransactions Echo
    • Getting Started
    • Credit Card Transactions
      • Authorization
      • Void
      • Capture
      • Charge
      • Refund
      • Credit
      • Verify
      • Chargeback
      • Cancel
    • Update
    • Adjustment
    • ACH
    • Echo Response
    • Response Codes
    • Objects Reference
  • folder icon closed folder iconTokenization
    • Processing with a Token
      • Getting Started
      • Processing with Tokenization
    • Tokenization iFrame
      • iFrame Integration
      • iFrame Customization
      • iFrame Testing
      • Response Example
    • Tokenization API
      • Getting Started
      • Tokenization Request
      • Tokenization Response
      • Response Codes
  • folder icon closed folder iconPayouts
    • Getting Started
    • Payout Transactions
    • Response
    • Objects Reference
  • folder icon closed folder iconReports
    • Getting Started
    • Reports API
      • Account Balances
      • Payouts
      • Payouts Reconciliation
      • Transaction Details
      • Settlements
      • Account Summary
      • Transactions
      • Transactions Summary
      • Fees Summary
      • Incoming Fees
      • Expected Future Revenue
      • Profitability Analysis
      • Reconciliation Summary
      • Reconciliation Records
      • Chargeback Analysis
      • Tokens
      • Sign-up Summary
    • Status Codes
  • folder icon closed folder iconErrors
  • folder icon closed folder iconResponse Codes
  1. Home
  2. Docs
  3. Heartland – Dev Portal
  4. Reports
  5. Reports API
  6. Chargeback Analysis
Updated on June 9, 2023

Heartland - Dev Portal

  • folder icon closed folder iconIntroduction
  • folder icon closed folder iconAuthentication
  • folder icon closed folder iconManagement
    • Getting Started
    • Platform Accounts Management
      • Get Platform Account Configuration
      • Get Platform Account
      • Create Platform Account
      • Update Platform Account
      • Objects Reference
    • Sub-Accounts Management
      • Get Sub-Account Configurations
      • Get Sub-Account
      • Create Sub-Account
      • Update Sub-Account
      • Objects Reference
    • Users Management
      • Get User by User Id
      • Get User by Username
      • Create User
      • Update User
      • Objects Reference
    • Underwriting Management
      • Get Application
      • Get Application Template
      • Get Application Fields Statuses
      • Get Application Status
      • Get Linked Sub-Accounts
      • Get Resubmission
      • UMS IFrame Authentication
      • UMS IFrame
      • UMS IFrame Authentication in Resubmission Mode
      • UMS IFrame in Resubmission Mode
      • Create Application
      • Update Application
      • Update Application Fields Statuses
      • Update Application Status
      • Objects Reference
      • Response Codes
  • folder icon closed folder iconTransactions Processing
    • Getting Started
    • Credit Card Transactions
      • 3D-Secure
      • Authorization
      • Void
      • Capture
      • Charge
      • Refund
      • Credit
      • Verify
      • Chargeback
      • Cancel
    • Update
    • Adjustment
    • Recurring
    • ACH
    • Response
    • Response Codes
    • Objects Reference
  • folder icon closed folder iconTransactions Echo
    • Getting Started
    • Credit Card Transactions
      • Authorization
      • Void
      • Capture
      • Charge
      • Refund
      • Credit
      • Verify
      • Chargeback
      • Cancel
    • Update
    • Adjustment
    • ACH
    • Echo Response
    • Response Codes
    • Objects Reference
  • folder icon closed folder iconTokenization
    • Processing with a Token
      • Getting Started
      • Processing with Tokenization
    • Tokenization iFrame
      • iFrame Integration
      • iFrame Customization
      • iFrame Testing
      • Response Example
    • Tokenization API
      • Getting Started
      • Tokenization Request
      • Tokenization Response
      • Response Codes
  • folder icon closed folder iconPayouts
    • Getting Started
    • Payout Transactions
    • Response
    • Objects Reference
  • folder icon closed folder iconReports
    • Getting Started
    • Reports API
      • Account Balances
      • Payouts
      • Payouts Reconciliation
      • Transaction Details
      • Settlements
      • Account Summary
      • Transactions
      • Transactions Summary
      • Fees Summary
      • Incoming Fees
      • Expected Future Revenue
      • Profitability Analysis
      • Reconciliation Summary
      • Reconciliation Records
      • Chargeback Analysis
      • Tokens
      • Sign-up Summary
    • Status Codes
  • folder icon closed folder iconErrors
  • folder icon closed folder iconResponse Codes

Chargeback Analysis

REST Sandbox URL: https://sandbox.4levers.com/NewReportsApi/api/Reports/chargeback-analysis

REST Production URL: https://reports-api.4levers.com/api/Reports/chargeback-analysis

Chargeback Analysis report offers a complete set of data and statistics on your Sub-Account chargeback rates and volumes for a specified date.

Request Example (REST Production URL)

GET: https://reports-api.4levers.com/api/Reports/chargeback-analysis?DateFrom=2019-06-01&DateTo=2019-07-24

Request Parameters

 NameTypeRequiredDescription
 datefromdatetime✓determines the selection starting/ending time range
 datetodatetime✓
 processorsstring/arrayoptionalspecify one or more clearing processors
 paymentmethodsenumoptional

specify the payment method

required in case credit card is populated.

Available Values:
 
  • creditcard
  • ach
  • giftcard
 creditcardsenumoptional

specify a credit card type

Available Values:
 
  • visa
  • mastercard
  • diners
  • isracard
  • americanexpress
  • discover
  • jcb
  • visadebit
  • mastercarddebit
  • delta
  • electron
  • maestro
  • solo
  • interac
 paymenttypesenumoptional

specify a payment type

regular one-time payment

recurring subscription payments

installments recurring installments

deferred deferred payment
 daterangetypeenumoptional

specify the report output date range type

systemdateprocessordate
 serviceprovidersinteger/arrayoptionalenter your service provider id(s)
 operatorsinteger/arrayoptionalenter your operator id(s)
 accountsinteger/arrayoptionalenter your platform account id(s)
 subaccountsstring/arrayoptionalenter your sub-account id(s)
 skipintegeroptional

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
 takeintegeroptional
 currenciesstring arrayoptional

enter currency type ids to filter sub-accounts by

Available Values:
 
  • CAD
  • USD
  • EUR
  • GBP
  • AUD
  • SGD
  • JPY
  • NZD

Response Parameters

 NameDescription
 datechargeback processing date
 numberofsalesdeposit (sale) transactions count
 amountofsalesgross amount of all deposit (sale) transactions
 numberofchargebackschargeback transactions count
 amountofchargebacksamount of all chargeback transactions
 ratiobynumberchargeback transactions count share in the total count of deposit transactions
 ratiobyamountchargeback transactions accumulated amount share in the total volume of deposit transactions
 accumulatedratiobynumberchargeback transactions accumulated count share in the total count of deposit transactions
 accumulatedratiobyamountchargeback transactions amount share in the total volume of deposit transactions
 currencytransaction currency
 subaccountsub-account identifier and name
 platformaccountplatform account name

 

				
					[
  {
    "date": "2019-09-10",
    "numberOfSales": "35",
    "amountOfSales": "20.00",
    "numberOfChargebacks": "8",
    "amountOfChargebacks": "4.00",
    "ratioByNumber": "22.86",
    "ratioByAmount": "11.43",
    "accumulatedRatioByNumber": "11.24",
    "accumulatedRatioByAmount": "1.51",
    "currency": "USD",
    "subAccount": "Sub-Account Id - Sub-Account Name",
    "platformAccount": "Platform Account Name"
  },
  {
    "date": "2019-09-10",
    "numberOfSales": "0",
    "amountOfSales": "0.00",
    "numberOfChargebacks": "0",
    "amountOfChargebacks": "0.00",
    "ratioByNumber": "0",
    "ratioByAmount": "0",
    "accumulatedRatioByNumber": "0",
    "accumulatedRatioByAmount": "0",
    "currency": "USD",
    "subAccount": "Sub-Account Id - Sub-Account Name",
    "platformAccount": "Platform Account Name"
  }
]				
			
Still stuck? How can we help?
Was this page helpful? Yes No

How can we help?

© Amaryllis Payment Solutions, 2022  All rights reserved.