Updated on September 14, 2023

Objects Reference

Payouts Configurations

Name Type Required Description
manualPayout bool optional Enables manual payout processing option. Disables external payout processor. To enable Manual Payouts pass "processor": "None".
negativePayout bool optional A boolean parameter that enables negative payouts processing.
importPayout bool optional A boolean parameter that enables import payouts from processor company. Can be True, only if payout “processor” = “ProPay“.
payouts object optional List of payouts. Max (250)
processor object optional Payout processor parameters.
skipBalanceCheck bool optional Allows to skip payouts source platform account available balance check prior the payout processing. Required to enable negativePayout.

Payouts

Name Type Required Description
calculation object ✓ Payout amount calculation parameters.
name string ✓ Payout name. Max (250)
payoutMethodAch object ✓ ACH payment method parameters.
payoutMethodCreditCard object optional Credit Card payment method parameters. Used in case of a negative payout processed via Card On File instructions and on-demand payouts.
cardOnFileProcessorConfiguration object optional Parameters of card-on-file processor. May vary for different processors.
scheduler object ✓ Payout configurations.
twoStepApproval bool optional Enables two step payout approval: authorization and manual confirmation.

Payout Method ACH

Name Type Required Description
accountNumber string ✓ ACH account number. Max (17).
nameOnAccount string ✓ ACH account name. Max (120).
routingNumber string ✓ ACH bank routing number. Max (9).
accountType enum optional ACH account type.
Available Values:
Savings 1 Savings account
Checking 2 Checking account
entityType enum optional ACH entity type.
Available Values:
Personal 0 Personal account
Business 1 Business account
useBillingAdress bool ✓ Must be always “true” if ‘id’ in “processor” object of “CIBC US”
billingAddress object conditional Required if “useBillingAdress” = true, else optional

cardOnFileProcessorConfiguration

Name Type Required Description
id integer int64 Processor identifier. Ignore with POST request and supply just the processor name. Not required with PUT method. Required with all other methods.
parameters string ✓ List of processor parameters.
processor Sys.Enum ✓ Processors’ names. Determined by the Service Provider.
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
26 Nmi
30 GlobalPayments
40 GlobalPaymentEcom
31 GoCardless
46 Gratify
5 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 Method Credit Card

Name Type Required Description
creditCardNumber string ✓ Credit card number. Varchar (16). Pattern: ^([2-6]{1})([0-9]{11,15}|[0-9\*]{11,15})$
creditCardNameOnCard string ✓ Cardholder’s name indicated on the credit card. Varchar(50).
creditCardExpirationDate string ✓ Credit card expiration date. Char (4) Format: MMYY. Pattern: ^(0[1-9]|1[0-2])[0-9]{2}$
creditCardCVV string conditional Credit card CVV value. Varchar (4). POST – required, if user sets CoF configuration with credit card PUT – 1) optional, if user updates any data except credit card details 2) required, if user updates credit card details

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.
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.
payoutType enum optional Payout amount calculation mode.
Available Values:
Fixed 1 fixed amount
Percentage 2 Percentage amount
PastDate 3 Balance on the day in the past
PastInterval 4 Balance for the time interval
OneTime 4 Single payout

Scheduler

Name Type Required Description
id integer optional Payouts scheduler identifier.
isSchedulerDisabled bool optional Set "isSchedulerDisabled": true or false to enable/disable a Payout scheduler.
dayNumber integer optional Payout day sequence number. Must be greater than 0.
endDate datetime optional Payout expiration date. Must be greater than DateTime.Now, if Expiration is set to UntilDate.
expiration enum optional Payout expiration settings.
Available Values:
UntilDate 1 Payout expires on a certain date
LimitedCount 2 Enter number of occurrences
NeverExpire 3 Payout never expires
interval enum optional Payout interval.
Available Values:
Daily 1 Every day. Enter day sequential number.
Weekly 2 Every week Enter a week sequential number and a weekday number (see enumeration below)
  • Sunday – 0
  • Monday – 1
  • Tuesday – 2
  • Wednesday – 3
  • Thursday – 4
  • Friday – 5
  • Saturday – 6
Monthly 3 Every month Enter fee day and month sequential number.
Yearly 4 Every year Enter a fee year, month and day sequential number.
intervalCount integer optional Day sequential number. Must be greater than 0.
monthNumber integer optional Month sequential number. Maximum = 12. Minimum = 1. Required if Interval=Monthly or Yearly.
occurrencesQuantity integer optional Payouts quantity. Required and greater than 0 if Expiration=LimitedCount.

Processing

Name Type Required Description
ach object optional ACH processing settings. Optional if creditcard is not null.
creditСards object optional Credit card processing settings.
Optional if ACH is not null.
currency enum optional Transactions processing currency type.
Available Values:
Currency Id
USD 1
EUR 2
CAD 6
GBP 4
AUD 5
SGD 11
JPY 23
NZD 32
ILS 8
fraudPreventionEnabled bool optional Boolean enables fraud detection service.
bnplEnabled bool optional Boolean enables BNPL payment type.
recurringBilling object optional Recurring billing configurations.
transactionMode enum optional Transaction processing mode.
Available Values:
Processing 0 Enables transactions processing using regular system gateway.
Import 1 Enables transactions import service to import transactions from the external processor.
Echo 2 Enables echo mode, that replicates client’s transactions.

Recurring Billing

Name Type Required Description
autoRenewalEnabled bool optional Enables recurring billing plan auto renewal option.
recurringEngineEnabled bool optional Enables recurring billing processing option.
subscriptionsEnabled bool optional Enables recurring billing creation option.

CreditCard

Name Type Required Description
autoCapture bool optional Boolean enables capturing service. Can be enabled for all transactionmode with the exception of echo and import.
giftCardsEnabled bool optional Boolean parameter that enables gift cards processing. Available in case credit cards processing is enabled. Available for echo and import transaction modes.
creditCardTypes enum ✓ Credit card type identifier. Required at least one. Determined by the service provider. you can remove credit cards from the list that you receive with get method, but cannot add extra credit card types.
CreditCardTypeIds
Available Values:
Visa 0
Mastercard 1
Diners 2
IsraCard 3
AmericanExpress 4
Discover 7
JCB 8
VisaDebit 9
MastercardDebit 10
Delta 11
Electron 12
Maestro 13
Solo 14
Interac 15
threeDSecure bool ✓ Can be enabled only for Processing Transactions Mode.
tokenization enum optional
Tokenization options.
Available Values:
External 1
Internal 2

ACH

Name Type Required Description
processors object ✓ Processor configurations.

Processors

Name Type Required Description
id integer optional Processor identifier.
parameters string ✓ Processor parameters. Pre-populated for each processor individually.
processor sys.enum optional 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
7 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

Billing

Name Type Required Description
scheduledFees list optional Scheduled fees settings.
slidingscaleFees list optional Scale range fees settings.
transactionFees list optional Per transaction fees settings.
interchangeFeesOverride object optional Interchange fees override settings.
interchangeFeeSeason object optional Not required parameters enabled for interchangeFees.
interchangeFeesRegions list optional Interchange fees region(s) id(s). Data type is int32 Use GET method to fetch a Sub-Account template based on the Service Provider id. Interchange Fees Regions list will be pre-populated based on Service Providers interchange fees settings. You can remove but cannot add extra regions.
interchangeFeesReversalEnabled list optional
Transactions types for interchange fees reversal.
Available Values:
Cancel 12
Partialrefund 9
Refund 8
Reversal 17
Void 3
Chargeback 11
feePriorityLevel byte optional Specify fees priority level for per-transaction fees and sliding scale fees. Available options: 1-10.
slidingScaleCounterReset object optional Counter reset for Sliding Scale fees.

Interchange Fees Override

Name Type Required Description
source enum ✓ String with FeeSource enum values.
Available Values:
  1. SubAccount
  2. Platform
  3. ServiceProvider
  4. Agent
  5. Operator
  6. Self
target enum ✓ String with FeeSource enum values.
Available Values:
  • platform – 0
  • ServiceProvider – 1
  • Operator – 2
  • SubAccount – 4
  • Agent – 6
  • Self – 7
sourceSubAccountId integer optional
targetSubAccountId integer optional A target Sub-Account identifier.
sourceAgentId integer optional A source Agent identifier.
targetAgentId integer optional A target Agent identifier.

Fee Season

Name Type Required Description
dateFrom string ✓ Fee is active starting from this date.
dateTo string ✓ Fee ending date.
offSeasonMonth list ✓ A list of fee inactive months.
Int32
Enter zero to make a fee active on every month.

Split

Name Type Required Description
priorityLevel integer ✓ Fees split priority level from 1 to 10.
percentage double ✓ Each Priority Level cannot have more than 100% of the total fee amount.
There can be a Level 2 priority even if Level 1 has 100% – in this case Level 2 will not have any effect.
Each Fee Trget can be assigned to the same priority Level just once, but different Fee Targets can be on the same priority Level.
A specific Fee Value can be split unlimited number of times but only up to 10 priority Levels.
In case of a partial refund, partial contra (if set) is based on the relative amount.
source enum ✓ String with FeeSource enum values.
Available Values:
  • SubAccount – 1
  • Platform – 2
  • ServiceProvider – 3
  • Agent – 4
  • Operator – 5
  • Self – 6
target enum ✓ String with FeeSource enum values.
Available Values:
  • Platform – 0
  • ServiceProvider – 1
  • Operator – 2
  • SubAccount – 4
  • Agent – 6
  • Self – 7
sourceSubAccountId integer optional Source Sub-Account identifier.
targetSubAccountId integer optional Target Sub-Account identifier.
sourceAgentId integer optional Source Agent identifier.
targetAgentId integer optional Target Agent identifier.

Buyrate

Name Type Required Description
amount double ✓ Max 6 decimal places.
percentage double ✓
Max 6 decimal places. The value of percentage parameter must be ≤ 100.
source enum ✓
String with FeeSource enum values.
Available Values:
  • SubAccount – 1
  • Platform – 2
  • ServiceProvider – 3
  • Agent – 4
  • Operator – 5
  • Self – 6
target enum ✓
String with FeeSource enum values.
Available Values:
  • Platform – 0
  • ServiceProvider – 1
  • Operator – 2
  • SubAccount – 4
  • Agent – 6
  • Self – 7
sourceSubAccountId integer optional Source Sub-Account identifier.
targetSubAccountId integer optional Target Sub-Account identifier.
sourceAgentId integer optional Source Agent identifier.
targetAgentId integer optional Target Agent identifier.
buyrateGapPayer integer optional String with FeeSource enum values. It is possible to set Buyrate amount and percentage greater than Amount/Percentage of the orirginal fee. Gap amount would be charged from buyrateGapPayer
Available Values:
  • Platform – 2
  • ServiceProvider – 3
  • Operator – 5
  • SubAccount – 1
  • Agent – 4
  • Self – 6
buyrateGapPayerSubAccountId integer optional Gap Payer Sub-account identifier. Required if buyrateGapPayer = “SubAccount”
buyrateGapPayerAgentId integer optional Gap Payer Agent identifier. Required if buyrateGapPayer = “Agent”

Override

Name Type Required Description
source enum ✓ String with FeeSource enum values.
Available Values:
  • SubAccount – 1
  • Platform – 2
  • ServiceProvider – 3
  • Agent – 4
  • Operator – 5
  • Self – 6
target enum ✓ String with FeeSource enum values.
Available Values:
  • Platform – 0
  • ServiceProvider – 1
  • Operator – 2
  • SubAccount – 4
  • Agent – 6
  • Self – 7
sourceSubAccountId integer optional A source Sub-Account identifier.
targetSubAccountId integer optional A target Sub-Account identifier.
sourceAgentId integer optional A source Agent identifier.
targetAgentId integer optional aA target Agent identifier.

Sliding Scale Counter Reset

Name Type Required Description
timeInterval enum optional
Counter reset intervals.
Available Values:
Weekly Select to enable a weekly counter reset. 2
Monthly Select to enable a monthly counter reset. 3
Yearly Select to enable an annual counter reset. 4
Infinite Select to enable an infinite counter. 5
numberOfIntervals integer ✓ Enter number of intervals for a selected timeinterval. The counter will reset every number of intervals that you determine: timeInterval=Weekly numberOfIntervals=2 Counter will reset every two weeks.

Scheduled Fees

Name Type Required Description
id integer optional Scheduled fees identifier.
amount double optional
Fee amount.
Max 2 decimal places.
dayNumber integer optional Day sequential number.
Must be greater than 0.
endDate datetime optional Fee expiration date.
Must be greater than datetime. Now, if expiration is set to UntilDate.
expiration enum optional Fee expiration settings.
Available Values:
UntilDate – 1 – Select to set a fee expiration date.
LimitedCount – 2 – Select to enable fees limited count.
NeverExpire – 3 – Select to disable fees expiration.
interval enum optional Fee interval.
Available Values:
  • Daily – 1 every day.
Enter day sequential number.
  • Weekly – 2 every week
Enter a week sequential number and a weekday number (see enumeration below).
    • Sunday – 0
    • Monday – 1
    • Tuesday – 2
    • Wednesday – 3
    • Thursday – 4
    • Friday – 5
    • Saturday – 6
  • Monthly – 3 – every month
Enter fee day and month sequential number.
  • Yearly – 4 every year
Enter a fee year, month and day sequential number.
intervalCount integer optional Day sequential number.
Must be greater than 0.
monthNumber integer optional Month sequential number. Maximum =” 12. “minimum =” 1.
Required “if Interval=”Monthly or Yearly.
name string optional Fee name.
Max (50)
occurrencesQuantity integer optional Number of a fee occurrences.
Required if Expiration=LimitedCount.
override object optional Default FeeSource and FeeTarget override.
feeSeason object optional Not required parameters enabled for slidingScaleFees, scheduledFees and transactionFees.

Sliding Scale Fees

Name Type Required Description
feePriorityLevel integer optional Fee priority level from 0 to 10.
id integer optional Fee identifier.
name string ✓ Fee name. Max (50)
override object optional Default FeeSource and FeeTarget override.
split object optional Not required Split parameters. Use to split fees among multiple targets. Set priority level and a fee share for each fee target.
feeSeason object optional Not required parameters enabled for slidingScaleFees, scheduledFees and transactionFees.
buyrate object optional Buyrate parameters. A Buyrate is used to split a fee value between the original Fee Target and the Buyrate Target. The split is on a value level, for example: a Fee is set to 5% and a Buyrate is set to 3%. In this case, the Fee Target will get 2% and the Buyrate Target will get 3% of the fee value. Required in case a fee is configured as buyrate fee.
ranges enum ✓ Scale range fees ranges. Required at least one.
reversalEnabled enum optional Enables fees reversal for Refund, Void, Chargeback and Cancel transaction types. For PUT and POST pass an empty value if “Fee Target” = “Reserve Balance” and “Reserve Release Date Delay” = “Never”. Option PartialRefund can’t be used if fee has buyrate configuration
Available Values:
Cancel 12
PartialRefund 9
Refund 8
Reversal 17
Void 3
Chargeback 11

Sliding Scale Range

Can be amount, percentage or combination of the two.
Name Type Required Description
amount double ✓ Fee amount. ^\d+(\.\d{1,2})?$ Max 2 decimal places.
percentage double ✓ Fee percentage amount. Max 6 decimal places.
maxCount integer ✓ Maximum transactions count. Сan be equal to “minCount”
minCount integer ✓ Minimum transactions count. Must be greater than 0.

Transaction Fees

Name Type Required Description
feePriorityLevel integer optional Fee priority level from 0 to 10.
amount double optional Fee amount. ^\d+(\.\d{1,2})?$
Max 2 decimal places.
typeid integer optional Fee identifier.
percentage double optional Fee percentage amount.
Max 6 decimal places.
name string ✓ Fee name.
override object optional Default FeeSource and FeeTarget override.
split object optional Not required Split parameters. Use to split fees among multiple targets. Set priority level and a fee share for each fee target.
feeSeason object optional Not required parameters enabled for slidingScaleFees, scheduledFees and transactionFees.
buyrate object optional Buyrate parameters. A Buyrate is used to split a fee value between the original Fee Target and the Buyrate Target. The split is on a value level, for example: a Fee is set to 5% and a Buyrate is set to 3%. In this case, the Fee Target will get 2% and the Buyrate Target will get 3% of the fee value. Required in case a fee is configured as buyrate fee.
reversalEnabled enum optional Enables fees reversal for Refund, Void, Chargeback and Cancel transaction types. Option PartialRefund can’t be used if fee has buyrate configuration For PUT and POST pass an empty value if “Fee Target” = “Reserve Balance” and “Reserve Release Date Delay” = “Never”.
Available Values:
  • Cancel – 12
  • PartialRefund – 9
  • Refund – 8
  • Reversal – 17
  • Void – 3
  • Chargeback – 11

Merchant Statement

Name Type Required Description
merchantNumber string ✓ Merchant number. Max 50 Pattern: ^([\+ ]+)?(\d[\d- ]+)?(\([\d- ]+\))?[\d- ]+\d$
merchantName string ✓ Merchant name.
merchantDBA string ✓ Merchant Doing Business As (DBA) name.
autoDeliveryContactEmail string optional Delivery email address. Max 50

Billing Address

Name Type Required Description
country string conditional
Required if “useBillingAdress” = true else optional country value in the list of available countries. reg exp: /^([a-z]|[A-Z])*$/
streetAddress string conditional Required if “useBillingAdress” = true else optional reg exp: /^([a-z]|[A-Z]|[0-9]|[.]|[-]|[,]|[+]|[ ]|[/]|[‘])*$/
city string conditional Required if “useBillingAdress” = true else optional reg exp: /^([a-z]|[A-Z]|[0-9]|[,]|[-]|[ ])*$/
province string conditional
Required if “useBillingAdress” = true and “processor” = “CIBC US” else optional reg exp: /^([a-z]|[A-Z])*$/
zipCode string conditional Required if “useBillingAdress” = true else optional reg exp: /^([a-z]|[A-Z]|[0-9]|[,]|[-]|[ ])*$/