Getting Transactions

Swagger UI Collection

You can view the full API documentation for ACH Transactions in our Swagger Collection. This collection provides detailed information about all available endpoints, including request and response schemas, parameters, and examples.

Open List of ACH Transactions in System

To view all ACH transactions in the system, use the following endpoint:

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

Note

companyCode and itemId are required.

companyCode can be obtained by using the endpoint:

GET /api/v3/UserProfiles/me

Response Codes

200 - OK

400 - Bad Request

401 - Unauthorized

403 - Forbidden

Example Output

200

"total": 0,
"creditAmount": 0,
"debitAmount": 0,
"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-11T20:50:04.032Z",
    "settleDate": "2025-06-11T20:50:04.032Z",
    "returnDate": "2025-06-11T20:50:04.032Z",
    "achEffectiveDate": "2025-06-11T20:50:04.032Z",
    "depositDateTime": "2025-06-11T20:50:04.032Z",
    "apiReportDateTime": "2025-06-11T20:50:04.032Z",
    "sendDate": "2025-06-11T20:50:04.032Z",
    "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-11T20:50:04.032Z",
    "requestedAchEffectiveDate": "2025-06-11T20:50:04.032Z",
    "createdBy": {
      "id": "string",
      "name": "string",
      "username": "string"
    }
  }
]
}

400

{
"errors": {
  "additionalProp1": [
    "string"
  ],
  "additionalProp2": [
    "string"
  ],
  "additionalProp3": [
    "string"
  ]
},
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
}

401

{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
}

403

{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
}

Get a Single ACH Transaction

To retrieve a specific ACH transaction, use the following endpoint:

GET /api/v3/AchTransactions/companycode/{companyCode}/{itemId}

Note

companyCode and itenId are required.

companyCode can be obtained by using the endpoint:

GET /api/v3/UserProfiles/me

Response Codes

200 - OK

400 - Bad Request

401 - Unauthorized

403 - Forbidden

Example Output

200

{
"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-11T21:19:26.144Z",
  "settleDate": "2025-06-11T21:19:26.144Z",
  "returnDate": "2025-06-11T21:19:26.144Z",
  "achEffectiveDate": "2025-06-11T21:19:26.144Z",
  "depositDateTime": "2025-06-11T21:19:26.144Z",
  "apiReportDateTime": "2025-06-11T21:19:26.144Z",
  "sendDate": "2025-06-11T21:19:26.144Z",
  "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-11T21:19:26.144Z",
  "requestedAchEffectiveDate": "2025-06-11T21:19:26.144Z",
  "createdBy": {
    "id": "string",
    "name": "string",
    "username": "string"
  }
}
}

400

{
"errors": {
  "additionalProp1": [
    "string"
  ],
  "additionalProp2": [
    "string"
  ],
  "additionalProp3": [
    "string"
  ]
},
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
}

401

{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
}

403

{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
}

Export Document List of ACH Transactions In System

To export a list of ACH transactions in the system, use the following endpoint:

GET /api/v3/AchTransactions/companycode/{companyCode}/export/filetype/{filetype}

Note

companyCode and fileType are required.

companyCode can be obtained by using the endpoint:

GET /api/v3/UserProfiles/me

fileType can be ExcelOpenXml, or Json

Response Codes

200 - OK

400 - Bad Request

401 - Unauthorized

403 - Forbidden

Getting a Paged list of ACH NOC items In System

To retrieve a paged list of ACH NOC (Notice-of-Change) items that are currently in the system, use the following endpoint:

GET /api/v3/AchNocs/companycode/{companyCode}

Note

companyCode is required. companyCode can be obtained by using the endpoint:

GET /api/v3/UserProfiles/me

Response Codes

200 - OK

400 - Bad Request

401 - Unauthorized

403 - Forbidden

Example Output

200

{
"total": 0,
"transactions": [
  {
    "achNocItemId": 0,
    "achItemId": 0,
    "yourReferenceNumber": "string",
    "nocCode": "string",
    "nocReason": "string",
    "correctedRouteNumber": "string",
    "correctedAccountNumber": "string",
    "correctedAchTransactionCode": "string",
    "correctedData": "string",
    "nocCreatedDate": "2025-06-12T16:35:40.645Z",
    "sendDate": "2025-06-12T16:35:40.645Z",
    "achEffectiveEntryDate": "2025-06-12T16:35:40.645Z",
    "receiverName": "string",
    "amount": 0
    }
  ]
}

400

{
"errors": {
  "additionalProp1": [
    "string"
  ],
  "additionalProp2": [
    "string"
  ],
  "additionalProp3": [
    "string"
  ]
},
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
 }

401

{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
}

403

{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
}

Export Document List of ACH NOC Items In System

To export a list of ACH NOC items currently in the system, use the following endpoint:

GET /api/v3/AchNocs/companycode/{companyCode}/export/filetype/{fileType}

Note

companyCode and fileType are required.

companyCode can be obtained by using the endpoint:

GET /api/v3/UserProfiles/me

fileType can be ExcelOpenXml, or Json

Response Codes

200 - OK

400 - Bad Request

401 - Unauthorized

403 - Forbidden

Example Output

400

{
"errors": {
  "additionalProp1": [
    "string"
  ],
  "additionalProp2": [
    "string"
  ],
  "additionalProp3": [
    "string"
  ]
},
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
}

401

"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
}

403

{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
}