ACH
Request Parameters
| Name | Type | Required | Description | |||||||||||||||||||||
| accountId | integer | ✓ | Platform Account identifier. Muset be greater than 0. | |||||||||||||||||||||
| accountOwnerId | string | optional | ACH Account Owner ID. MaxLength(50) | |||||||||||||||||||||
| amount | decimal | ✓ | Transaction amount. Value ≥ 0 (2 decimal places) | |||||||||||||||||||||
| billingAddress | object | optional | User Billing Address data object. | |||||||||||||||||||||
| billingOverride | object | optional | Data object that contains an array of billingFee objects. | |||||||||||||||||||||
| ach | object | conditional | ACH data object. Required if Payment method = ACH. | |||||||||||||||||||||
| currency | enum | ✓ | CurrencyTypeId. Available Values:
| |||||||||||||||||||||
| merchantData | object | optional | Merchant Data data object. | |||||||||||||||||||||
| entryMode | integer | optional | Nullable Transaction entry mode numerical value. | |||||||||||||||||||||
| paymentMethod | enum | ✓ | PaymentMethod enum values. Available Values:
| |||||||||||||||||||||
| processorData | object | optional | Processor Data data object. | |||||||||||||||||||||
| subAccountId | integer | ✓ | Sub-Account identifier. Value ≥ 0 | |||||||||||||||||||||
| terminalId | string | optional | Terminal identifier. MaxLength(20) | |||||||||||||||||||||
| transactionMethod | enum | optional | transactionMethodId. Available Values:
| |||||||||||||||||||||
| type | enum | ✓ | transactionTypeId Available Values:
| |||||||||||||||||||||
| chargeback | object | conditional | Additional chargeback parameters. Null if transaction “type“ ≠ “Chargeback” and “Update“ conditional if transaction “type“ = “Chargeback” or “Update“ | |||||||||||||||||||||
| originalTransaction | object | conditional | Original Transaction data object. Required for Capture and Refund and Update. | |||||||||||||||||||||
| subscription | object | conditional | Subscription data object. Use for recurring transactions. |
//ACH request example
{
"accountId": "Platform Account Id",
"amount": 13,
"billingAddress": {
"addressLine": "Address",
"city": "City Name",
"country": "USA",
"email": "email@mail.com",
"phoneNumber": "12346879",
"state": "FL",
"zipPostalCode": "123465798"
},
"billingOverride": [
{
"fixedAmount": "feeFixedAmount",
"id": "objectId",
"percentageAmount": "feePercentageAmount",
"sourceId": "feeSourceIdentifier",
"sourceType": "BillingAccountId",
"targetId": "feeTargetIdentifier",
"targetType": "BillingAccountId",
"reverse": "true",
"billingAmount": "billingAmountValue"
}
],
"ach": {
"accountNumber": "1099999903",
"accountType": "Savings",
"entityType": "Personal",
"nameOnAccount": "Eleanor Johnson",
"routingNumber": "114567895"
},
"currency": "USD",
"merchantData": {
"freeText": "string",
"transactionDate": "dateTime",
"transactionDescription": "string",
"transactionId": "string"
},
"entryMode": "2",
"paymentMethod": "ACH",
"processorData": {
"dynamicDescriptor": "01919Z"
},
"subAccountId": "Sub-Account Id",
"terminalId": "string",
"transactionMethod": "RegularTransaction",
"type": "Charge"
}