Updated on June 9, 2023

Transactions

REST Sandbox URL: https://sandbox.4levers.com/NewReportsApi/api/Reports/transactions REST Production URL: https://reports-api.4levers.com/api/Reports/transactions Transactions report provides detailed information on real-time and history transactions for a specific Sub-Account and time range.
Request Example (REST Production URL)
GET: https://reports-api.4levers.com/api/Reports/transactions?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 ✓
entrymode array integer optional nullable
transaction entry mode(s) numerical value.
status enum optional transaction processing status
Available Values:
  • processed
  • declined
  • chbcredited
  • chbamountmismatch
  • chbcurrencymismatch
  • chbdouble
  • chbexception
  • chbmultiple
  • chbunrelated
daterangetype enum optional specify the date range type
Available Values:
  • systemdate
  • merchantdate
  • settlementdate
transactionid integer (int64) optional transaction identifier
displayrelatedtransactions bool optional choose true to display related transactions
merchanttransactionid string optional transaction identifier per merchant
processors string array optional specify one or more acquiring companies
processortransactionid string optional transaction identifier per processor
processorauthorizationcode string optional processor authorization code if applicable
paymentmethods enum optional specify the payment method
required in case credit card is populated.
Available Values:
  • creditcard
  • ach
  • giftcard
creditcards enum optional specify a credit card type
Available Values:
  • visa
  • mastercard
  • diners
  • isracard
  • americanexpress
  • discover
  • jcb
  • visadebit
  • mastercarddebit
  • delta
  • electron
  • maestro
  • solo
interac
transactiontype enum optional
specify a transaction type
Available Values:
  • verify
  • authorization
  • void
  • partialvoid
  • capture
  • partialcapture
  • charge
  • refund
  • partialrefund
  • credit
  • chargeback
  • retrieval
  • representment
  • arbitration
  • reversalcancel
paymenttypes enum optional specify a payment type
Available Values:
  • regular one-time payment
  • recurring subscription payments
  • installments recurring installments
  • deferred deferred payment
CCAccountOwnerName string optional specify the name on the platform account
CCAccountNumber string optional specify the platform account number
bin string optional credit card bank identification number.
first 6 digits of the credit card number.
last4 string optional last 4 digits of the credit card number
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 enum optional enter currency type ids to filter sub-account by
Available Values:
  • CAD
  • USD
  • EUR
  • GBP
  • AUD
  • SGD
  • JPY
  • NZD
amountfrom number optional amount range starting value
amountto number optional amount range ending value

Response Parameters

Name Description
transactionid transaction identifier (e.g. authorization transaction identifier)
merchanttransactionid transaction identifier by merchant
processortransactionid transaction identifier by processor
systemdate transaction processing date and time
settlementdate transaction settlement date and time
merchantdate transaction processing date and time by merchant
paymentmethod payment method: ach, credit card or gift card type.
ccoraccountnumber credit card number or bank account number in case of an ach
ccexpirationdate credit card expiration date
token payment method token
CCorAccountOwnerName name on credit card number or bank account in case of an ach
amount transaction amount
currency transaction currency
transactiotype type of the transaction
status transaction status
processor name of the processor
authorizationcode code of the authorization
errordescription description of an error
chargebackreason chargeback reason code
chargebackreasondescription chargeback reason description
chargebackdisputedate chargeback dispute date
terminalid clearing terminal identifier
servicepurchasedtype service purchased type
transactiondescription description of the transaction
merchantfreetext merchant comment on the transaction
subaccount sub-account identifier
platformaccount platform account name
performedby user created the record
entrymode nullable
transaction entry mode(s) numerical value.
 
				
					[
  {
    "transactionId": "101000000004431070",
    "merchantTransactionId": "108",
    "processorTransactionId": "22d0b6e9-7e4d-4a4b-ad42-23d693069f92",
    "systemDate": "2019-10-19T15:32:23.29",
    "settlementDate": "2020-05-04T23:59:59",
    "merchantDate": "",
    "paymentMethod": "Visa",
    "CCorAccountNumber": "411111******1111",
    "CCOrAccountOwnerId": "",
    "CCExpirationDate": "12/20",
    "token": "15facb01-4b25-4511-b5f0-0a083e48857b",
    "CCorAccountOwnerName": "Eleanor Johnson",
    "amount": "100.00",
    "currency": "USD",
    "transactionTypes": "Capture",
    "paymentTypes": "One Off",
    "statuses": "Processed",
    "processor": "Processor Name",
    "dynamicDescriptor": "",
    "merchantId": "",
    "authorizationOrErrorCode": "01919Z",
    "errorDescription": "OK",
    "cvvResponse": "",
    "avsResponse": "",
    "chargebackReason": "75",
    "CHBOrRetrievalReasonCode": "",
    "chargebackDisputeDate": "2011-04-07T00:00:00",
    "terminalId": "",
    "servicePurchasedType": "RegularTransaction",
    "transactionDescription": "Transaction Description",
    "merchantFreeText": "Merchant Free Text",
    "subAccount": "Sub-Account Id - Sub-Account Name",
    "platformAccount": "Platform Account Name",
    "transactionSource": "Echo API",
    "performedBy": "username",
    "entryModes": "0-Unknown",
    "cvvPresent": "",
    "billingAddressAddressLine": "123 Main Street",
    "billingAddressСity": "Сity name",
    "billingAddressСountry": "US",
    "billingAddressEmail": "test@domain.com",
    "billingAddressState": "CA",
    "billingAddressPhoneNumber": "12346879",
    "billingAddressZipPostalCode": "94000",
    "CCOrAccountIpAddress": ""
  },
  {
    "transactionId": "101000000004431070",
    "merchantTransactionId": "108",
    "processorTransactionId": "22d0b6e9-7e4d-4a4b-ad42-23d693069f92",
    "systemDate": "2019-10-19T15:32:23.29",
    "settlementDate": "2020-05-04T23:59:59",
    "merchantDate": "",
    "paymentMethod": "Visa",
    "CCorAccountNumber": "411111******1111",
    "CCOrAccountOwnerId": "",
    "CCExpirationDate": "12/20",
    "token": "15facb01-4b25-4511-b5f0-0a083e48857b",
    "CCorAccountOwnerName": "Eleanor Johnson",
    "amount": "100.00",
    "currency": "USD",
    "transactionTypes": "Capture",
    "paymentTypes": "One Off",
    "statuses": "Processed",
    "processor": "Processor Name",
    "dynamicDescriptor": "",
    "merchantId": "",
    "authorizationOrErrorCode": "01919Z",
    "errorDescription": "OK",
    "cvvResponse": "",
    "avsResponse": "",
    "chargebackReason": "75",
    "CHBOrRetrievalReasonCode": "",
    "chargebackDisputeDate": "2011-04-07T00:00:00",
    "terminalId": "",
    "servicePurchasedType": "RegularTransaction",
    "transactionDescription": "Transaction Description",
    "merchantFreeText": "Merchant Free Text",
    "subAccount": "Sub-Account Id - Sub-Account Name",
    "platformAccount": "Platform Account Name",
    "transactionSource": "Echo API",
    "performedBy": "username",
    "entryModes": "0-Unknown",
    "cvvPresent": "",
    "billingAddressAddressLine": "123 Main Street",
    "billingAddressСity": "Сity name",
    "billingAddressСountry": "US",
    "billingAddressEmail": "test@domain.com",
    "billingAddressState": "CA",
    "billingAddressPhoneNumber": "12346879",
    "billingAddressZipPostalCode": "94000",
    "CCOrAccountIpAddress": ""
  }
]