Updated on May 17, 2023

Objects Reference

ACH
 NameTypeRequiredDescription
 accountNumberstring✓ACH Account Number.
 accountTypeenum✓

achAccountTypeId

Available Values:
 
savings1Savings accounts are intended for putting money aside for long periods of time.
checking2Checking accounts are intended for depositing checks, making withdrawals and managing bill payments.
 entityTypeenum✓achEntityTypeId
In case is missing in the request, entityType=0.
Available Values:
 
personal0Personal account
business1Business account
 nameOnAccountstring✓Name of the account owner.
 routingNumberstring✓The ACH routing number is a 9–digit number assigned to financial institutions by The American Bankers Association (ABA)
to identify the financial institution upon which a payment was drawn.
Billing Address
 NameTypeRequiredDescription
 addressLinestringoptionalBilling address.
 citystringoptionalCity name.
 countrystringoptional

Country name.

Enter two or three-letter country code.
 emailstringoptionalContact Email.
 phoneNumberstringoptionalContact phone number.
 statestringoptional

State name.

Enter two or three-letter state code.
 zipPostalCodestringoptionalZip code.
Billing Override
 NameTypeRequiredDescription
 fixedAmountdecimaloptional

Fee fixed amount.

Required if billingAmount is not populated.
 idstringoptionalFee identifier.
Required if Billing Override object is included in the request.
 percentageAmountdecimaloptionalMax 6 decimal places.
Fee percentage amount.
Required if billingAmount is not populated.
 sourceIdstringoptionalFee source identifier.
In case sourceType=subAccountId the entry format must be as follows: accountId.subAccountId (101.2).
Specify sourceType as well if selected.
In case sourceId and sourceType are omitted, the default values are current accountId and subAccountId.
In case sourceType=operatorId, sourceId is ignored and a source billing account is determined based on provided subAccountId and transactionId.
 sourceTypeenumoptionalSource type.
Required if there’s sourceId in the request.
Available Values:
 
billingAccountId1
subAccountId2
platformAccountId3
serviceProviderId4
operatorId5
 targetIdstringoptionalFee target identifier.
In case targetType=subAccountId the entry format must be as follows: accountId.subAccountId (101.2).
Specify targetType as well if selected.
In case targetId and targetType are omitted, the default values are taken from the current Service Provider Fee Target settings.
In case targetType=operatorId, targetId is ignored and a target billing account is determined based on provided subAccountId and transactionId.
 targetTypeenumoptionalTarget type.
Required if there’s targetId in the request.
Available Values:
 
billingAccountId1
subAccountId2
platformAccountId3
serviceProviderId4
operatorId5
 reversebooleanoptional

Boolean to enable fees reversal.

Available Values:
 
truereversal enabled
falsereversal disabled
 billingAmountdecimaloptionalBilling amount value.
Pass Billing Amount value to set/change transaction amount for commission and fees calculation.
In case you wish to use this feature, BillingAmount parameter must be included and have a valid value
in the transaction BillingOverride to override the original transaction billing amount for calculation of commissions and fees.
Credit Card
 NameTypeRequiredDescription
 binstring✓Credit card bank identification number.
First 6 digits of the credit card number.
 expirationDatestring✓Credit card expiration date.
 last4string✓Credit card number last 4 digits.
 nameOnCardstringoptionalCardholders name.
 tokenstringoptionalCredit card payment external token.
 typeenum✓

creditCardTypeId

Available Values:
 
Visa0
Mastercard1
Diners2
IsraCard3
AmericanExpress4
Discover7
JCB8
VisaDebit9
MastercardDebit10
Delta11
Electron12
Maestro13
Solo14
Interac15
Merchant Data
 NameTypeRequiredDescription
 freeTextstringoptionalMerchant free text.
 transactionDatedatetimeoptionalMerchant transaction processing date.
ISO format (yyyy-MM-dd HH:mm:ss).
 transactionDescriptionstringoptionalMerchant transaction description.
 transactionIdstringoptionalMerchant transaction identifier.
Original Transaction
 NameTypeRequiredDescription
 transactionIdstringoptionalOriginal transaction identifier.
Required ONLY if transactionTypeId = 3 (Void) or 4 (Partial Void) or 5 (Capture) or 6 (Partial Capture) or 8 (Refund) or 9 (Partial Refund) or 12 (Cancel) or 13 (Adjustment) or 14 (Retrieval) or 15 (Representment) or 16 (Arbitration) or 17 (Reversal).
 transactionTypeenumoptionalOriginal transaction type identifier.
Required ONLY if transactionTypeId = 3 (Void) or 4 (Partial Void) or 5 (Capture) or 6 (Partial Capture) or 8 (Refund) or 9 (Partial Refund) or 12 (Cancel) or 13 (Adjustment) or 14 (Retrieval) or 15 (Representment) or 16 (Arbitration) or 17 (Reversal).
Available Values:
 
Amaryllis0
Processor1
Merchant2
Processor Data
 NameTypeRequiredDescription
 authorizationNumberstringoptionalAuthorization number.
 avsResultIndicationchar (max 3)optionalAVS result indication.
 cvvResultIndicationcharoptionalCVV result indication.
 errorCodestringoptionalError code.
Required if transactionStatusId=1 (Declined).
Only for declined transactions.
 errorCodeDescriptionstringoptionalError code description.
Required if transactionStatusId=1 (Declined).
Only for declined transactions.
 transactionIdstringoptionalProcessor transaction identifier.
Chargeback
 NameTypeRequiredDescription
 disputeDatedatetimeoptionalDispute date of the chargeback.
 reasonCodestringoptionalChargeback reason code.