ACH
Request Parameters
Transaction Packet
| Name | Type | Required | Description | |||||||||||||||||||||
| accountId | integer | ✓ | Platform Account identifier. | |||||||||||||||||||||
| ach | object | ✓ | ACH data object. | |||||||||||||||||||||
| amount | decimal | ✓ | Transaction amount. Amount=0 can be passed with any transaction type. | |||||||||||||||||||||
| billingAddress | object | optional | User Billing Address data object. | |||||||||||||||||||||
| billingOverride | object | ✓ | Data object that contains an array of billingFee objects. | |||||||||||||||||||||
| currency | enum | ✓ | currencyTypeId Disabled for updating by the Update transaction. Available Values:
| |||||||||||||||||||||
| entryMode | integer | optional | Nullable Transaction entry mode numerical value. | |||||||||||||||||||||
| merchantData | object | optional | Merchant Data data object. | |||||||||||||||||||||
| originalTransaction | object | optional | Original Transaction data object. 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 14 (Retrieval) or 15 (Representment) or 16 (Arbitration) or 17 (Reversal) or 18 (Update) The request will not pass validation in case originalTransaction data is included in the request packet for all other transactionTypeIds. Disabled for updating by the Update transaction. | |||||||||||||||||||||
| paymentMethod | enum | ✓ | PaymentMethodTypeId. Available Values:
| |||||||||||||||||||||
| paymentType | enum | optional | PaymentType enum values. Available Values:
| |||||||||||||||||||||
| processorData | object | ✓ | Processor Data data object. | |||||||||||||||||||||
| status | enum | ✓ | transactionStatusId. Available Values:
| |||||||||||||||||||||
| subAccountId | integer | ✓ | Sub-Account identifier. Disabled for updates by Update transactions. | |||||||||||||||||||||
| terminalId | string | optional | Terminal identifier. | |||||||||||||||||||||
| transactionMethod | enum | optional | transactionMethodId Available Values:
| |||||||||||||||||||||
| type | enum | ✓ | transactionTypeId Available Values:
|
ACH Regular Transaction 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",
"entryMode": "2",
"merchantData": {
"freeText": "Update MerchantText",
"transactionDate": "2023-05-04T05:37:31",
"transactionDescription": "Update Description",
"transactionId": "UpdateMerchantTrxID"
},
"paymentMethod": "Ach",
"paymentType": "OneOff",
"processorData": {
"authorizationNumber": "01919Z",
"errorCode": "",
"errorCodeDescription": "",
"transactionId": "MCS1L2VI720190390"
},
"status": "Processed",
"subAccountId": "Sub-Account Id",
"terminalId": "string",
"transactionMethod": "RegularTransaction",
"type": "Authorization"
}
ACH Submit Transaction Request Example
{
"accountId": "Platform Account Id",
"amount": 50,
"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": "ACH Account Number",
"accountType": "ACH Account Type",
"entityType": "Personal",
"nameOnAccount": "Scarlet Johnson",
"routingNumber": "ACH Account Routing Number"
},
"originalTransaction": {
"transactionId": "Transaction ID",
"transactionType": "Processor"
},
"currency": "USD",
"entryMode": "2",
"merchantData": {
"freeText": "Update MerchantText",
"transactionDate": "2023-05-04T05:37:31",
"transactionDescription": "Update Description",
"transactionId": "UpdateMerchantTrxID"
},
"paymentMethod": "ACH",
"processorData": {
"authorizationNumber": "A0101Z",
"avsResultIndication": "P",
"cvvResultIndication": "D",
"errorCode": "123",
"errorCodeDescription": "Error description message",
"transactionId": "Transaction ID"
},
"status": "Processed",
"subAccountId": "Sub-Account Id",
"terminalId": "string",
"transactionMethod": "RegularTransaction",
"type": "Chargeback"
}