Objects Reference
ACH
| Name | Type | Required | Description | ||||||
|---|---|---|---|---|---|---|---|---|---|
| accountNumber | string | ✓ | ACH Account Number. MaxLength(17) | ||||||
| accountType | enum | ✓ | achAccountTypeId Valid Parameters
| ||||||
| entityType | enum | ✓ | achEntityTypeId Valid Parameters
| ||||||
| 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 | Billing address. MaxLength(50) | |
| city | string | City name. MaxLength(50) | |
| country | string | Country name. Enter two or three-letter country code. MaxLength(3) | |
| string | Contact Email. MaxLength(50) | ||
| phoneNumber | string | Contact phone number. MaxLength(20) | |
| state | string | Sate name. Enter two or three-letter state code. MaxLength(3) | |
| zipPostalCode | string | Zip code. MaxLength(20) |
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 | string | conditional | creditCardTypeId. Valid Parameters
| ||||||||||||||||||||||||||||
| 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 | Merchant free text. MaxLength(255) | |
| transactionDate | datetime | Merchant transaction processing date. ISO format (yyyy-MM-dd HH:mm:ss). | |
| transactionDescription | string | Merchant transaction description. MaxLength(255) | |
| transactionId | string | Merchant transaction identifier. MaxLength(255) |
Original Transaction
| Name | Type | Required | Description | ||||||
|---|---|---|---|---|---|---|---|---|---|
| transactionId | string | conditional | Original transaction identifier. 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. Valid Parameters
|