Updated on September 14, 2023

Payouts Reconciliation

REST Sandbox URL: https://sandbox.4levers.com/NewReportsApi/api/Reports/payouts-reconciliation REST Production URL: https://reports-api.4levers.com/api/Reports/payouts-reconciliation Payouts Reconciliation report displays detailed payout information in one place according to the selected timeframe.
Request Example (REST Production URL)
GET: https://reports-api.4levers.com/api/Reports/payouts-reconciliation?DateFrom=2020-12-10&DateTo=2020-12-22&PayoutMethod=ACH&Currencies=USD&Take=5
Request Parameters
Name Type Required Description
dateFrom datetime ✓ determines the selection starting time range
dateTo datetime ✓ determines the selection ending time range
dateRangeType enum optional specify the date range type
Available Values:
  • processdate
  • returndate
payoutStatuses enum optional transaction processing status
Available Values:
  • processed
  • rejectedbyprocessor
payoutId integer optional payout transaction identifier
payoutNameDescriptor string optional report is queried by both the payout name and the descriptor value
payoutMethods enum optional specify the payment method of the payout
Available Values:
  • ach
  • creditcard
payoutTypes enum optional specify the payout type
Available Values:
percentage percentage amount
pastinterval amount for the interval in the past
payoutondemand single payout
Processors enum optional specify the payout type
Available Values:
Id Processor name
7 ACHDirect
44 BMO
29 BNS
19 CheckAlt
43 CIBC
47 CibcP2H
45 CibcUS
38 Colonnade
17 ConnectNPay
32 Element
23 Emulator
49 Nmi
30 GlobalPayments
40 GlobalPaymentEcom
31 GoCardless
46 Gratify
35 Heartland
34 ICredit
16 IpCommerce
20 LittleAndCo
48 MerchantWarrior
18 MeS
41 IPPay
15 JetPay
21 PayPal
33 PayPoint
27 PiroPay
42 ProPay
37 Realex
24 Valitor
39 WellsFargo
36 WorldPay
50 HYP
51 CFSB
ProcessorTransactionId string optional Transaction identifier per processor
ProcessorAuthorizationCode string optional Processor authorization code if applicable
amountFrom number optional enter payout bottom amount
amountTo number optional enter payout top amount
currencies enum optional enter an array of currency type ids to filter sub-accounts by
Available Values:
  • CAD
  • USD
  • EUR
  • GBP
  • AUD
  • SGD
  • JPY
  • NZD
transactionId integer (int64) optional transaction identifier
merchantTransactionId string optional transaction identifier per merchant
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
Response Parameters
Name Description
payoutId Payout identifier
payoutProcessDate Date when payout was processed
payoutRejectOrReturnDate Date when payout was rejected by processor
payoutType Payout type
payoutName Name of the payout
payoutDescriptor Transaction.DynamicDescriptor values
payoutMethod Payout payment method. PaymentMethod=CreditCard in case a negative payout has been processed using Card On File instructions.
payoutAmount Transaction amount
payoutStatus Transaction status
payoutProcessor Payout Processor
payoutPerformedBy User created the record
activityType If PayoutType = “Payout On Demand”, the Activity Type should be “Payout On Demand”. Available Values: Sale, Credit, Chargeback, Outgoing Fee, Interchange Fee, Reserve Fee, Incoming Fee, Reserve Release, Balance Adjustment, Payout Adjustment, Payout on Demand
settlementDate Settlement date
transactionId Transaction identifier
merchantTransactionId Transaction identifier per merchant
processorTransactionId Transaction identifier per processor
transactionSystemDate System date of the transaction
transactionMerchantDate Merchant date of the transaction
transactionProcessorDate Processor date of the transaction
transactionType Type of the transaction
transactionPaymentMethod Payment Method of the transaction. Available values: ACH, Fee, Gift Card or Credit Card type
transactionAmount Transaction Amount
transactionProcessor Transaction Processor name
feeName Fee name
feeGroupName Fee group name
feeType Fee type
feeCategory Fee category
feeAmount Fee amount
feeSource Fee source
feeTarget Fee target
reserveCollectionDate Date when the fee was applied
reserveReleaseDate Release date
reserveReleaseType Release type. Available values: Scheduled, Manual.
reserveReleaseAmount Release Amount
adjustmentId Adjustment Id
adjustmentDate Adjustment date and time
adjustmentCategory Adjustment category
adjustmentType Adjustment type
adjustmentName Adjustment name
adjustmentPaymentMethod Adjustment payment method
adjustmentStatus Adjustment status
payoutValue Payout value
percentageLimit Percentage limit
percentageLimitAdjustmentValue Percentage limit adjustment value
amountLimit Amount limit value
amountLimitAdjustmentValue Amount limit adjustment value
activeLimit Active limit value
adjustmentAmount Adjustment amount
activityAmount Depending on Activity Type it is one of the following values: Transaction Amount, Fee Amount, Release Amount, Adjustment Amount, Payout Amount
currency Transaction currency
payoutAuthorizationCode Code of payout aithorization
subAccount Sub-account identifier
platformAccount Platform Account name 
				
					[
  {
        "payoutId": "1999001136945796604",         
        "payoutProcessDate": "2022-03-03T16:40:15",            
        "payoutRejectOrReturnDate": "",            
        "payoutType": "Payout on Demand",            
        "payoutName": "",          
        "payoutDescriptor": "TestDescriptor",          
        "payoutMethod": "ACH",         
        "payoutAmount": "1.00",            
        "payoutStatus": "Processed",           
        "payoutAuthorizationCode": "",         
        "payoutProcessor": "Emulator",         
        "payoutPerformedBy": "test",           
        "activityType": "Payout on Demand",          
        "settlementDate": "",          
        "transactionId": "",           
        "merchantTransactionId": "",           
        "processorTransactionId": "",          
        "transactionSystemDate": "",           
        "transactionMerchantDate": "",         
        "transactionProcessorDate": "",            
        "transactionType": "",         
        "transactionPaymentMethod": "",            
        "transactionAmount": "",           
        "transactionProcessor": "",            
        "feeName": "",         
        "feeGroupName": "",            
        "feeType": "",         
        "feeCategory": "",         
        "feeAmount": "",           
        "feeSource": "",           
        "feeTarget": "",           
        "reserveCollectionDate": "",           
        "reserveReleaseDate": "",          
        "reserveReleaseType": "",          
        "reserveReleaseAmount": "",            
        "adjustmentId": "",            
        "adjustmentDate": "",          
        "adjustmentCategory": "",          
        "adjustmentType": "",          
        "adjustmentName": "",          
        "adjustmentPaymentMethod": "",         
        "adjustmentStatus": "",            
        "payoutValue": "",         
        "percentageLimit": "",         
        "percentageLimitAdjustmentValue": "",          
        "amountLimit": "",         
        "amountLimitAdjustmentValue": "",          
        "activeLimit": "",         
        "adjustmentAmount": "",            
        "activityAmount": "1.00",          
        "currency": "USD",         
        "subAccount": "Test Account",         
        "platformAccount": "Test Account"         
    }
]