Skip to content
Documentation

Creating Transactions

Single Transaction

Section titled “Single Transaction”

To add a single ACH transaction to the system, use the following endpoint:

POST /api/v3/AchTransactions/companycode/{companyCode}

Single Model

Section titled “Single Model”

Model required for creating the transaction (filled with random example values):

Model Example:
{
  "firstSignerFirstName": "firstName",
  "firstSignerLastName": "lastName",
  "address1": "string",
  "address2": "string",
  "city": "3845470 0L{.&41{4772``}p,?75?2",
  "state": "Vn",
  "zip": "reTZ8nSa",
  "countryCode": "ro",
  "yourReferenceNumber": "string",
  "bankRoutingNumber": "271-09",
  "bankAccountNumber": "709-1",
  "amount": 0,
  "achTransactionCode": 0,
  "achAccountType": "PersonalChecking",
  "achTransactionType": "Debit",
  "achTransactionSubType": " ",
  "achEntryClass": "IAT",
  "achPaymentTypeCode": "st",
  "achCheckNumber": 0,
  "achIdentificationNumber": "string",
  "achCompanyEntryDescription": "string",
  "achCompanyDiscretionaryData": "string",
  "achTransactionDiscretionaryData": "st",
  "achAddendaText": "string",
  "sameDayAchRequested": true,
  "sendDate": "2025-06-11T18:25:21.435Z",
  "achEffectiveDate": "2025-06-11T18:25:21.435Z",
  "iatAddenda": {
    "transactionTypeCode": "",
    "foreignBeneficiaryPayer": {
      "name": "&-?`-L55-8{&10.9-1004L5{`662`8",
      "streetAddress": "98234/L``0? `56.-",
      "city": "0,'8{14''2p,{?ppp6{-1,p- ,}'&29`92",
      "stateCode": "YE",
      "postalCode": "vEci4",
      "countryCode": "Qv"
    }
  }
}

Response Codes

Section titled “Response Codes”

200 - OK

400 - Bad Request

401 - Unauthorized

403 - Forbidden

Example Output: 
{
"transaction": {
  "achItemId": 0,
  "companyCode": "string",
  "flexBatchId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "merchantId": 0,
  "itemStatus": "string",
  "itemStatusDescription": "string",
  "firstSignerFirstName": "string",
  "firstSignerLastName": "string",
  "address1": "string",
  "address2": "string",
  "city": "string",
  "state": "string",
  "zip": "string",
  "countryCode": "string",
  "yourReferenceNumber": "string",
  "amount": 0,
  "bankRoutingNumber": "string",
  "bankAccountNumber": "string",
  "returnReason": "string",
  "returnMessage": "string",
  "itemSource": "string",
  "returnItemId": 0,
  "reportStatus": "string",
  "receivedDateTime": "2025-06-11T19:08:30.745Z",
  "settleDate": "2025-06-11T19:08:30.745Z",
  "returnDate": "2025-06-11T19:08:30.745Z",
  "achEffectiveDate": "2025-06-11T19:08:30.745Z",
  "depositDateTime": "2025-06-11T19:08:30.745Z",
  "apiReportDateTime": "2025-06-11T19:08:30.745Z",
  "sendDate": "2025-06-11T19:08:30.745Z",
  "bankId": 0,
  "achTransactionCode": 0,
  "achAccountType": "string",
  "achTransactionType": "string",
  "achTransactionSubType": "string",
  "achEntryClass": "string",
  "achPaymentTypeCode": "string",
  "achCheckNumber": 0,
  "achIdentificationNumber": "string",
  "achCompanyEntryDescription": "string",
  "achCompanyDiscretionaryData": "string",
  "achTransactionDiscretionaryData": "string",
  "achAddendaText": "string",
  "sameDayAchRequested": true,
  "returnFileName": "string",
  "settlementReportFileName": "string",
  "returnReportFileName": "string",
  "iatAddenda": {
    "transactionTypeCode": "string",
    "foreignBeneficiaryPayer": {
      "name": "string",
      "streetAddress": "string",
      "city": "string",
      "stateCode": "string",
      "postalCode": "string",
      "countryCode": "string"
    }
  },
  "requestedSendDate": "2025-06-11T19:08:30.746Z",
  "requestedAchEffectiveDate": "2025-06-11T19:08:30.746Z",
  "createdBy": {
    "id": "string",
    "name": "string",
    "username": "string"
    }
  }
}'
);

Bulk Transaction

Section titled “Bulk Transaction”

To add many ACH transactions to the system, use the following endpoint:

POST /api/v3/AchTransactions/companycode/{companyCode}/many

Bulk Model

Section titled “Bulk Model”

Model required for creating the transaction (filled with random example values):

Model Example:
{
  "alwaysCommitValid": true,
  "items": [
    {
      "firstSignerFirstName": "`}1 ?3L@1",
      "firstSignerLastName": "9 6'}5 ?&",
      "address1": "string",
      "address2": "string",
      "city": "'58-L,p2}0L?,8p`p9}L-560``L937",
      "state": "zO",
      "zip": "CV",
      "countryCode": "XQ",
      "yourReferenceNumber": "string",
      "bankRoutingNumber": "511804537",
      "bankAccountNumber": "51991127",
      "amount": 0,
      "achTransactionCode": 0,
      "achAccountType": "PersonalChecking",
      "achTransactionType": "Credit",
      "achTransactionSubType": "Prenote",
      "achEntryClass": "",
      "achPaymentTypeCode": "S",
      "achCheckNumber": 0,
      "achIdentificationNumber": "string",
      "achCompanyEntryDescription": "string",
      "achCompanyDiscretionaryData": "string",
      "achTransactionDiscretionaryData": "st",
      "achAddendaText": "string",
      "sameDayAchRequested": true,
      "sendDate": "2025-06-11T19:03:28.262Z",
      "achEffectiveDate": "2025-06-11T19:03:28.262Z",
      "iatAddenda": {
        "transactionTypeCode": "",
        "foreignBeneficiaryPayer": {
          "name": "1&{5.3}-{?&91?1.0636 p{6949,7",
          "streetAddress": " /p",
          "city": "p40'7.0'&p1p ,3'.,4-.p6'919{}",
          "stateCode": "pb",
          "postalCode": "E4zN0",
          "countryCode": "oW"
        }
      }
    }
  ]
}

Response Codes

Section titled “Response Codes”

200 - OK

401 - Unauthorized

403 - Forbidden

Example Output: 
{
"errors": {
  "additionalProp1": [
    {
      "errorMessage": "string",
      "memberNames": [
        "string"
      ]
    }
  ],
  "additionalProp2": [
    {
      "errorMessage": "string",
      "memberNames": [
        "string"
      ]
    }
  ],
  "additionalProp3": [
    {
      "errorMessage": "string",
      "memberNames": [
        "string"
      ]
    }
  ]
},
"transactions": [
  {
    "achItemId": 0,
    "companyCode": "string",
    "flexBatchId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "merchantId": 0,
    "itemStatus": "string",
    "itemStatusDescription": "string",
    "firstSignerFirstName": "string",
    "firstSignerLastName": "string",
    "address1": "string",
    "address2": "string",
    "city": "string",
    "state": "string",
    "zip": "string",
    "countryCode": "string",
    "yourReferenceNumber": "string",
    "amount": 0,
    "bankRoutingNumber": "string",
    "bankAccountNumber": "string",
    "returnReason": "string",
    "returnMessage": "string",
    "itemSource": "string",
    "returnItemId": 0,
    "reportStatus": "string",
    "receivedDateTime": "2025-06-11T19:08:30.771Z",
    "settleDate": "2025-06-11T19:08:30.771Z",
    "returnDate": "2025-06-11T19:08:30.771Z",
    "achEffectiveDate": "2025-06-11T19:08:30.771Z",
    "depositDateTime": "2025-06-11T19:08:30.771Z",
    "apiReportDateTime": "2025-06-11T19:08:30.771Z",
    "sendDate": "2025-06-11T19:08:30.771Z",
    "bankId": 0,
    "achTransactionCode": 0,
    "achAccountType": "string",
    "achTransactionType": "string",
    "achTransactionSubType": "string",
    "achEntryClass": "string",
    "achPaymentTypeCode": "string",
    "achCheckNumber": 0,
    "achIdentificationNumber": "string",
    "achCompanyEntryDescription": "string",
    "achCompanyDiscretionaryData": "string",
    "achTransactionDiscretionaryData": "string",
    "achAddendaText": "string",
    "sameDayAchRequested": true,
    "returnFileName": "string",
    "settlementReportFileName": "string",
    "returnReportFileName": "string",
    "iatAddenda": {
      "transactionTypeCode": "string",
      "foreignBeneficiaryPayer": {
        "name": "string",
        "streetAddress": "string",
        "city": "string",
        "stateCode": "string",
        "postalCode": "string",
        "countryCode": "string"
      }
    },
    "requestedSendDate": "2025-06-11T19:08:30.771Z",
    "requestedAchEffectiveDate": "2025-06-11T19:08:30.771Z",
    "createdBy": {
      "id": "string",
      "name": "string",
      "username": "string"
    }
  }
]
}