v1

latestOpenAPI 3.0.02026-07-2640301.0 MB

ACH Endpoints

ach/failures

This endpoint is used to retrieve a list of transactions which failed during a specific date range. This endpoint is queried based on the date that a failure occurred on, not on the date when the transaction originally occurred.

get/ach/failures

Query parameters

AccountIDstring required

Your account ID

Keystring required

API key for the account

Signaturestring required

Hashed signature for the request

StartDateTimestring date-time required

Start of date range to query for any failed transactions

EndDateTimestring date-time required

End of date range to query for any failed transactions

Response

Successboolean required

True if the request was successful, false if it failed

ErrorMessagestring required

Contains a description of the error if the request failed

NumberOfRecordsnumber required

Total number of failed transaction records returned

Example response

{
  "Success": true,
  "FailedTransactions": {
    "0": {
      "TransactionDateTime": "2019-12-04 18:13:39",
      "TransactionType": "ACH Funding",
      "ErrorCode": "R01",
      "FailureReason": "insufficient funds",
      "ClientReferenceNumber": "null"
    }
  }
}