Updated on June 9, 2023

Objects Reference

Payout Configuration

Name Type Required Description
id integer ✓ Processor configuration identifier.
parameters string ✓ Processor parameters. Pre-populated for each processor individually.
processor Sys.Enum ✓ Processors’ names. Determined by the Service Provider. Do not change to create/update a Sub-Account. Pass "processor": "None" to enable Manual Payouts. Effects only ACH payouts.
Available Values:
Id Processor name
ACHDirect
44 BMO
29 BNS
19 CheckAlt
43 CIBC
47 CibcP2H
45 CibcUS
38 Colonnade
17 ConnectNPay
32 Element
23 Emulator
26 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

Payouts

Name Type Required Description
calculation object ✓ Payout amount calculation parameters.
name string ✓ Payout name. Max (250)
payoutMethodACH object ✓ A list of ACH payment method parameters for all system currencies. You can specify different parameters for each currency.
scheduler object ✓ Payout configurations.
twoStepApproval bool optional Enables two step payout approval: authorization and manual confirmation.

Payout Method ACH

Name Type Required Description
Currency Enum ✓ Transactions processing currency type.
Available Values:
Currency Id
USD
EUR
CAD
GBP
AUD
SGD 11
JPY 23
NZD 32
ILS
AccountNumber String ✓ ACH account number. Max (17) Min (3)
NameOnAccount String ✓ ACH account name. Max (120)
RoutingNumber String ✓ ACH bank routing number. Max (9) Min (9)
AccountType Enum ✓ ACH account type.
Available Values:
Savings Savings account
Checking Checking account
EntityType Enum ✓ ACH entity type.
Available Values:
Personal Personal account
Business Business account
UseBillingAdress Bool ✓ Must be always “true” if ‘id’ in “processor” object of “CIBC US”
billingAddress Object Conditional Required if “useBillingAddress” = true, else optional

Payouts Calculation

Name Type Required Description
FixedAmount Double Optional Payout amount. Must be greater than 0. Required if PayoutType = Fixed.
PercentageAmount Double Optional Payout amount taken as a percentage of the total account balance for a selected date or a time period. Must be greater than 0. Required if PayoutType = Percentage.
IntervalCount Integer Optional Payout intervals count. Must be greater than 0 and required if PayoutType = Pastinterval.
IntervalGap Integer Optional Payout interval gap. Must be greater than 0 and required if PayoutType = PastInterval/PastDate.
PayoutType Enum Optional Payout amount calculation mode.
Available Values:
Fixed Fixed amount
Percentage Percentage amount
PastDate Balance on the day in the past
PastInterval Balance for the time interval