Objects Reference
ACH
| Name | Type | Required | Description | |||||||
| accountNumber | string | ✓ | ACH Account Number. MaxLength(17) | |||||||
| accountType | enum | ✓ | achAccountTypeId Available Values:
| |||||||
| entityType | enum | ✓ | achEntityTypeId Available Values:
| |||||||
| nameOnAccount | string | ✓ | Name of the account owner. Max (120) | |||||||
| routingNumber | string | ✓ | 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. Max (9) |
Billing Address
| Name | Type | Required | Description | |
| addressLine | string | optional | Billing address. MaxLength(50) | |
| city | string | optional | City name. MaxLength(50) | |
| country | string | optional | Country name. Enter two or three-letter country code. MaxLength(3) | |
| string | optional | Contact Email. MaxLength(50) | ||
| phoneNumber | string | optional | Contact phone number. MaxLength(20) | |
| state | string | optional | Sate name. Enter two or three-letter state code. MaxLength(3) | |
| zipPostalCode | string | optional | Zip code. MaxLength(20) |
Billing Override
| Name | Type | Required | Description | |||||||||||
| fixedAmount | decimal | conditional | Fee fixed amount. Required if billingAmount is not populated. If “billingAmount” is not populated or null then “fixedAmount” must be >= 0; Max 6 decimal places. | |||||||||||
| id | string | conditional | Fee identifier. Required if Billing Override object is included in the request. Value > 0 | |||||||||||
| percentageAmount | decimal | conditional | Max 6 decimal places. Fee percentage amount. Required if billingAmount is not populated. If “billingAmount” is not populated or null then “percentageAmount” must be >= 0. | |||||||||||
| sourceId | string | optional | Fee 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. | |||||||||||
| sourceType | enum | conditional | Source type. Required if there’s sourceId in the request. Available Values:
| |||||||||||
| targetId | string | optional | Fee 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. | |||||||||||
| targetType | enum | conditional | Target type. Required if there’s targetId in the request. Available Values:
| |||||||||||
| reverse | boolean | optional | Boolean to enable fees reversal. Available Values:
| |||||||||||
| billingAmount | decimal | optional | Billing 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
| Name | Type | Required | Description | |||||||||||||||||||||||||||||
| number | string | conditional | Credit card number. Required if “token” is null; else – Null | |||||||||||||||||||||||||||||
| expirationDate | string | conditional | Credit card expiration date. Required if “token” is null; else – Null | |||||||||||||||||||||||||||||
| nameOnCard | string | conditional | Cardholder’s name. MaxLength(120) Required if “token” is null; else – Null | |||||||||||||||||||||||||||||
| type | enum | conditional | creditCardTypeId. Required if “token” is null. Else Null Available Values:
| |||||||||||||||||||||||||||||
| cvv | string | conditional | Credit card CVV value. Only digits are allowed. Min length = 3,Max length = 4 Required if “token” is null; else – Null | |||||||||||||||||||||||||||||
| tokenization | object | conditional | Tokenization parameters. In case the token is specified then credit card information should be empty and vise versa. |
Tokenization
| Name | Type | Required | Description | |||||||||||||||||||||||||||||
| type | enum | conditional | Tokenization flags indicationg external or internal tokenization type. Internal tokenization is performed by the system propritary tools. Null if there is no tokenization object. Available Values:
| |||||||||||||||||||||||||||||
| cardType | enum | conditional | creditCardTypeId Null if “token” is null Available Values:
| |||||||||||||||||||||||||||||
| token | string | conditional | Credit card token value. Null if there is no tokenization object. MaxLength(255) | |||||||||||||||||||||||||||||
| maskedNumber | string | conditional | Credit card masked number. Null if “token” is null. | |||||||||||||||||||||||||||||
| nameOnCard | string | conditional | Cardholder’s name. MaxLength(120) Required if “token” is not null AND “type” = 1 (required only for External tokenization), else – Null. | |||||||||||||||||||||||||||||
| cvv | string | conditional | Credit card CVV value. Only digits are allowed. Min length = 3,Max length = 4 Required if “token” is null; else – Null |
Merchant Data
| Name | Type | Required | Description | |
| freeText | string | optional | Merchant free text. MaxLength(255) | |
| transactionDate | datetime | optional | Merchant transaction processing date. ISO format (yyyy-MM-dd HH:mm:ss). | |
| transactionDescription | string | optional | Merchant transaction description. MaxLength(255) | |
| transactionId | string | optional | Merchant transaction identifier. MaxLength(255) |
Original Transaction
| Name | Type | Required | Description | |||||||
| transactionId | string | conditional | Original transaction identifier. Required for Submit transaction and transaction “type“ = “Update“ If “transactionType” = System , then the value must be > 0, if “transactionType” = Processor, then the value must be text, if “transactionType” = Merchant, then the value must be text. | |||||||
| transactionType | enum | ✓ | Original transaction type identifier. Available Values:
|
Processor Data
| Name | Type | Required | Description | |
| dynamicDescriptor | string | ✓ | Processor dynamic descriptor value. MaxLength(255) |
Chargeback
| Name | Type | Required | Description | |
| disputeDate | datetime | optional | Dispute date of the chargeback. date ≤ Today | |
| reasonCode | string | optional | Chargeback reason code. MaxLength(25) |
Subscription
| Name | Type | Required | Description | |
| firstInstallment | object | conditional | ||
| schedule | object | conditional | Required if “subscription” is not null | |
| expiration | object | conditional | Required if “subscription” is not null | |
| recurringAmount | decimal | ✓ | value > 0 (2 decimal places) | |
| initialPreAuthaMount | decimal | conditional | Value ≥ 0 (2 decimal places). Gateway validation logic: if initialPreAuthAmount > 0 then transaction amount should be 0 |
First Installment
| Name | Type | Required | Description | |
| amount | decimal | conditional | Installment amount Value > 0 Required if “firstInstallment” is not null | |
| interval | decimal | conditional | Installment interval Value > 0 Required if “firstInstallment” is not null |
Schedule
| Name | Type | Required | Description | |||||||||
| interval | integer | conditional | Schedule interval value Value > 0 Required if “schedule” is not null Available Values:
| |||||||||
| intervalCount | integer | conditional | Available values: 1-999 – for daily Available values: 1-999 – for monthly, weekly Value > 0 Required if “interval”=Daily, Weekly, Monthly | |||||||||
| dayNumber | integer | conditional | Available values: 0-6 – for weekly Available values: 1-31 – for monthly/yearly Required if “interval”=Weekly, Monthly, Yearly | |||||||||
| monthNumber | integer | conditional | Available values: 1-12 Required if “interval”= Yearly |
Expiration
| Name | Type | Required | Description | |||||||||
| type | enum | optional | Expiration type. Available Values:
| |||||||||
| numberOfOccurrences | integer | conditional | Number of occurences Required if “type”=2 (EndAfterNumberOfOccurrences) Available values: 1-99999 | |||||||||
| date | datetime | conditional | Required if “type”=3 (EndByDate) | |||||||||
| numberOfDays | integer | conditional | Required if “type”=4 (EndAfterNumberOfDays) Value > 0 |
3D-Secure
| Name | Type | Required | Description | |
| eci | string | optional | ECI indicates the result of 3D-secfure authentication process (verification successful/verification attempted/unable to verify). Required if “token” is not null. This value is provided by the 3D Secure processor. MaxLength(2) | |
| xid | string | optional | XID is the ID (or code) of the particular authentication. Required if “token” is not null. This value is provided by the 3D Secure processor. MaxLength(36) | |
| cavv | string | optional | CAVV is the authentication verification value. Required if “token” is not null. This value is provided by the 3D Secure processor. MaxLength(99) | |
| result | string | optional | Result A string describing if a customer was successfully verified or attempted. – “verified” indicates that a cardholder’s bank successfully verified the user. – “attempted” indicates that a cardholder is enrolled in 3DS, but their bank does not support 3DS. Must be null if “token” is not null. | |
| directoryServerId | string | optional | DirectoryServerId is a transaction identifier assigned by the directory server. Must be null if “token” is not null. This value is provided by the 3D Secure processor. MaxLength(50) | |
| version | string | optional | Result is a using version of 3D Secure. Must be null if “token” is not null. This value is provided by the 3D Secure processor. MaxLength(10) | |
| token | string | optional | 3D – Secure token. |