Updated on September 14, 2023

Payouts

REST Sandbox URL: https://sandbox.4levers.com/NewReportsApi/api/Reports/payout-transactions REST Production URL: https://reports-api.4levers.com/api/Reports/payout-transactions Payouts report provides access to all your Sub-Account payouts history. The output payout report contains a detailed information about payouts for a selected time range.
Request Example (REST Production URL)
GET: https://reports-api.4levers.com/api/Reports/payout-transactions?DateFrom=2020-12-10&DateTo=2020-12-22&DateRangeType=CreationDate&PayoutMethod=ACH&Currencies=USD&Take=5
Request Parameters
Name Type Required Description
1 dateFrom datetime ✓ determines the selection starting time range
2 dateTo datetime ✓ determines the selection ending time range
dateRangeType enum optional specify the date range type:
Available Values:
  • creationdate
  • modificationdate
payoutStatus enum optional transaction processing status:
Available Values:
  • pendingapproval
  • pendingprocessing
  • processed
  • declinedbyuser
  • rejectedbyprocessor
  • declinedbyprocessor
payoutId integer optional payout transaction identifier
payoutNameDescriptor string optional report is queried by both the payout name and the descriptor value
payoutMethod enum optional specify the payment method of the payout
Available Values:
ach to process regular payouts
creditcard to process negative payouts via card on file instructions in case configured.
payoutType enum optional specify the payout type
Available Values:
fixed fixed amount
percentage percentage amount
pastdate amount for the date in the past
pastinterval amount for the interval in the past
payoutondemand single payout
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
Processors enum optional Processors’ names.
Available Values:
  • 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
ProcessorAuthorizationCode string optional Processor authorization code if applicable
SystemErrorCode integer optional Processor error code. Max length is 9 symbols
ProcessorErrorCode string optional Processor Authorization Code. Max length is 50 symbols
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
creatIondate creation date and time
modificationDate payout modification date and time
payoutMethod payout payment method.paymentmethod=creditcardin case a negative payout has been processed using card on file instructions.
payoutType payout type
amount transaction amount
currency transaction currency
payoutName name of the payout
payoutDescriptor transaction.dynamicdescriptor values
status transaction status
authorizationOrErrorCode Code of the authorization
processor Name of the processor
errorDescription Description of an error
subAccount sub-account identifier
platformAccount platform account name
performedBy user created the record 
				
					[
  {
        "payoutId": "1999001136565446674",             
        "creationDate": "2022-03-01T12:57:22",             
        "modificationDate": "2022-03-03T16:57:50",             
        "payoutType": "Payout on Demand",                
        "payoutName": "",              
        "payoutDescriptor": "",                
        "payoutMethod": "ACH",             
        "amount": "22.00",             
        "currency": "USD",             
        "status": "Processed",             
        "authorizationOrErrorCode": "db57d867-3500-44e0-9ac7-87b3484b7196",                
        "errorDescription": "",                
        "processor": "Emulator",               
        "subAccount": "Test Account",             
        "platformAccount": "Test Account",                
        "performedBy": "User"
  },
  {
        "payoutId": "1999001136565446675",             
        "creationDate": "2022-03-01T12:57:22",             
        "modificationDate": "2022-03-03T16:57:50",             
        "payoutType": "Payout on Demand",                
        "payoutName": "",              
        "payoutDescriptor": "",                
        "payoutMethod": "ACH",             
        "amount": "22.00",             
        "currency": "USD",             
        "status": "Processed",             
        "authorizationOrErrorCode": "db57d867-3500-44e0-9ac7-87b3484b7196",                
        "errorDescription": "",                
        "processor": "Emulator",               
        "subAccount": "Test Account",             
        "platformAccount": "Test Account",                
        "performedBy": "User"
  }
]