Voiding 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.

Void a Single ACH Transaction

To void a single ACH transaction, you can use the following endpoint:

PUT /api/v3/AchTransactions/companycode/{companyCode}/{itemId}/void

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

{
"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-12T03:44:05.581Z",
  "settleDate": "2025-06-12T03:44:05.581Z",
  "returnDate": "2025-06-12T03:44:05.581Z",
  "achEffectiveDate": "2025-06-12T03:44:05.581Z",
  "depositDateTime": "2025-06-12T03:44:05.581Z",
  "apiReportDateTime": "2025-06-12T03:44:05.581Z",
  "sendDate": "2025-06-12T03:44:05.581Z",
  "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-12T03:44:05.581Z",
  "requestedAchEffectiveDate": "2025-06-12T03:44:05.581Z",
  "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"
}

Void Many ACH Transactions

To void several ACH transactions using your reference numbers, you can use the following endpoint:

PUT /api/v3/AchTransactions/companycode/{companyCode}/void/referendcenumbers

Note

companyCode and is required.

companyCode can be obtained by using the endpoint:

GET /api/v3/UserProfiles/me

Model:

{
  "referenceNumbers": [
    "string"
  ]
}

Response Codes

200 - OK

400 - Bad Request

401 - Unauthorized

403 - Forbidden

Example Output:

200

{
"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-12T03:49:05.087Z",
    "settleDate": "2025-06-12T03:49:05.087Z",
    "returnDate": "2025-06-12T03:49:05.087Z",
    "achEffectiveDate": "2025-06-12T03:49:05.087Z",
    "depositDateTime": "2025-06-12T03:49:05.087Z",
    "apiReportDateTime": "2025-06-12T03:49:05.087Z",
    "sendDate": "2025-06-12T03:49:05.087Z",
    "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-12T03:49:05.087Z",
    "requestedAchEffectiveDate": "2025-06-12T03:49:05.087Z",
    "createdBy": {
      "id": "string",
      "name": "string",
      "username": "string"
    }
  }
],
"errors": {
  "additionalProp1": {
    "errorMessage": "string",
    "notFound": true,
    "invalidStatus": true
  },
  "additionalProp2": {
    "errorMessage": "string",
    "notFound": true,
    "invalidStatus": true
  },
  "additionalProp3": {
    "errorMessage": "string",
    "notFound": true,
    "invalidStatus": true
  }
}
}
No links
400
Bad Request

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"
}

Void Many ACH Transactions Using Flex Item ID

To void several ACH transactions using Flex Item ID, you can use the following endpoint:

PUT /api/v3/AchTransactions/companycode/{companyCode}/void/achitemids

Note

companyCode and is required.

companyCode can be obtained by using the endpoint:

GET /api/v3/UserProfiles/me

Model:

{
  "achItemIds": [
    0
  ]
}

Response Codes

200 - OK

400 - Bad Request

401 - Unauthorized

403 - Forbidden

Example Output:

200

{
"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-12T03:49:05.096Z",
    "settleDate": "2025-06-12T03:49:05.096Z",
    "returnDate": "2025-06-12T03:49:05.096Z",
    "achEffectiveDate": "2025-06-12T03:49:05.096Z",
    "depositDateTime": "2025-06-12T03:49:05.096Z",
    "apiReportDateTime": "2025-06-12T03:49:05.096Z",
    "sendDate": "2025-06-12T03:49:05.096Z",
    "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-12T03:49:05.096Z",
    "requestedAchEffectiveDate": "2025-06-12T03:49:05.096Z",
    "createdBy": {
      "id": "string",
      "name": "string",
      "username": "string"
    }
  }
],
"errors": {
  "additionalProp1": {
    "errorMessage": "string",
    "notFound": true,
    "invalidStatus": true
  },
  "additionalProp2": {
    "errorMessage": "string",
    "notFound": true,
    "invalidStatus": true
  },
  "additionalProp3": {
    "errorMessage": "string",
    "notFound": true,
    "invalidStatus": true
  }
}
}

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"
}