BatchAchOrig

Perform various operations on batch Automated Clearing House (ACH) origination records.

Symitar eDocs References: Coming soon.

Operations

getBatchAchOrigSelectFields

post
Authorizations
Body
AccountNumberstringOptional
BatchAchOrigLocatorintegerOptional
Responses
200

Successful operation.

application/json
post
/getBatchAchOrigSelectFields
POST /nexum/627/persistent/account/getBatchAchOrigSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 678

{
  "Credentials": {
    "UserNumberCredentials": {
      "UserNumber": 1995,
      "Password": "2dfKQYR!TeXJwe"
    }
  },
  "AccountNumber": "text",
  "BatchAchOrigLocator": 1,
  "SelectableFields": {
    "IncludeAllBatchAchOrigFields": true,
    "BatchAchOrigFields": {
      "CompanyDiscretionaryData": true,
      "CompanyEntryDescription": true,
      "CompanyId": true,
      "CompanyName": true,
      "DepositSettlementDate": true,
      "EffectiveEntryDate": true,
      "Expiration": true,
      "GroupNumber": true,
      "Id": true,
      "IdType": true,
      "Locator": true,
      "OrigAmount": true,
      "PaySettlementDate": true,
      "PostMethod": true,
      "RecordChangeDate": true,
      "StandardEntryClassCode": true,
      "Status": true,
      "TotalOriginationCount": true,
      "TotalPostedCount": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "BatchAchOrig": {
    "CompanyDiscretionaryData": "text",
    "CompanyEntryDescription": "text",
    "CompanyId": "text",
    "CompanyName": "text",
    "DepositSettlementDate": "2025-11-07",
    "EffectiveEntryDate": "2025-11-07",
    "Expiration": "2025-11-07",
    "GroupNumber": "text",
    "Id": "text",
    "IdType": 1,
    "Locator": 1,
    "OrigAmount": 1,
    "PaySettlementDate": "2025-11-07",
    "PostMethod": 1,
    "RecordChangeDate": "2025-11-07",
    "StandardEntryClassCode": "text",
    "Status": 1,
    "TotalOriginationCount": 1,
    "TotalPostedCount": 1
  }
}

getBatchAchOrigPagedListSelectFields

post
Authorizations
Body
AccountNumberstringOptional
Responses
200

Successful operation.

application/json
post
/getBatchAchOrigPagedListSelectFields
POST /nexum/627/persistent/account/getBatchAchOrigPagedListSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 748

{
  "Credentials": {
    "UserNumberCredentials": {
      "UserNumber": 1995,
      "Password": "2dfKQYR!TeXJwe"
    }
  },
  "AccountNumber": "text",
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 1,
    "Token": "text"
  },
  "SelectableFields": {
    "IncludeAllBatchAchOrigFields": true,
    "BatchAchOrigFields": {
      "CompanyDiscretionaryData": true,
      "CompanyEntryDescription": true,
      "CompanyId": true,
      "CompanyName": true,
      "DepositSettlementDate": true,
      "EffectiveEntryDate": true,
      "Expiration": true,
      "GroupNumber": true,
      "Id": true,
      "IdType": true,
      "Locator": true,
      "OrigAmount": true,
      "PaySettlementDate": true,
      "PostMethod": true,
      "RecordChangeDate": true,
      "StandardEntryClassCode": true,
      "Status": true,
      "TotalOriginationCount": true,
      "TotalPostedCount": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "BatchAchOrig": [
    {
      "CompanyDiscretionaryData": "text",
      "CompanyEntryDescription": "text",
      "CompanyId": "text",
      "CompanyName": "text",
      "DepositSettlementDate": "2025-11-07",
      "EffectiveEntryDate": "2025-11-07",
      "Expiration": "2025-11-07",
      "GroupNumber": "text",
      "Id": "text",
      "IdType": 1,
      "Locator": 1,
      "OrigAmount": 1,
      "PaySettlementDate": "2025-11-07",
      "PostMethod": 1,
      "RecordChangeDate": "2025-11-07",
      "StandardEntryClassCode": "text",
      "Status": 1,
      "TotalOriginationCount": 1,
      "TotalPostedCount": 1
    }
  ],
  "Token": "text"
}

searchBatchAchOrigPagedSelectFields

post
Authorizations
Body
AccountNumberstringOptional
Responses
200

Successful operation.

application/json
post
/searchBatchAchOrigPagedSelectFields
POST /nexum/627/persistent/account/searchBatchAchOrigPagedSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 780

{
  "Credentials": {
    "UserNumberCredentials": {
      "UserNumber": 1995,
      "Password": "2dfKQYR!TeXJwe"
    }
  },
  "AccountNumber": "text",
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 1,
    "Token": "text"
  },
  "SelectableFields": {
    "IncludeAllBatchAchOrigFields": true,
    "BatchAchOrigFields": {
      "CompanyDiscretionaryData": true,
      "CompanyEntryDescription": true,
      "CompanyId": true,
      "CompanyName": true,
      "DepositSettlementDate": true,
      "EffectiveEntryDate": true,
      "Expiration": true,
      "GroupNumber": true,
      "Id": true,
      "IdType": true,
      "Locator": true,
      "OrigAmount": true,
      "PaySettlementDate": true,
      "PostMethod": true,
      "RecordChangeDate": true,
      "StandardEntryClassCode": true,
      "Status": true,
      "TotalOriginationCount": true,
      "TotalPostedCount": true
    }
  },
  "SearchFilter": {
    "Query": "text"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "BatchAchOrig": [
    {
      "CompanyDiscretionaryData": "text",
      "CompanyEntryDescription": "text",
      "CompanyId": "text",
      "CompanyName": "text",
      "DepositSettlementDate": "2025-11-07",
      "EffectiveEntryDate": "2025-11-07",
      "Expiration": "2025-11-07",
      "GroupNumber": "text",
      "Id": "text",
      "IdType": 1,
      "Locator": 1,
      "OrigAmount": 1,
      "PaySettlementDate": "2025-11-07",
      "PostMethod": 1,
      "RecordChangeDate": "2025-11-07",
      "StandardEntryClassCode": "text",
      "Status": 1,
      "TotalOriginationCount": 1,
      "TotalPostedCount": 1
    }
  ],
  "Token": "text"
}

updateBatchAchOrigByID

post
Authorizations
Body
AccountNumberstringOptional
BatchAchOrigLocatorintegerOptional
Responses
200

Successful operation.

application/json
post
/updateBatchAchOrigByID
POST /nexum/627/persistent/account/updateBatchAchOrigByID HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 654

{
  "Credentials": {
    "UserNumberCredentials": {
      "UserNumber": 1995,
      "Password": "2dfKQYR!TeXJwe"
    }
  },
  "AccountNumber": "text",
  "BatchAchOrigLocator": 1,
  "BatchAchOrigFields": {
    "CompanyDiscretionaryData": "text",
    "CompanyEntryDescription": "text",
    "CompanyId": "text",
    "CompanyName": "text",
    "DepositSettlementDate": "2025-11-07",
    "EffectiveEntryDate": "2025-11-07",
    "Expiration": "2025-11-07",
    "GroupNumber": "text",
    "Id": "text",
    "IdType": 1,
    "Locator": 1,
    "OrigAmount": 1,
    "PaySettlementDate": "2025-11-07",
    "PostMethod": 1,
    "RecordChangeDate": "2025-11-07",
    "StandardEntryClassCode": "text",
    "Status": 1,
    "TotalOriginationCount": 1,
    "TotalPostedCount": 1
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "UpdateStatus": {
    "isAllFieldsUpdateSuccess": true,
    "FailedUpdateStatus": {
      "Record": "text",
      "ErrorCode": "text",
      "ErrorMessage": "text",
      "PrimaryKeyField": [
        {
          "Name": "text",
          "Value": "text"
        }
      ]
    }
  }
}

createBatchAchOrig

post
Authorizations
Body
AccountNumberstringOptional
Responses
200

Successful operation.

application/json
post
/createBatchAchOrig
POST /nexum/627/persistent/account/createBatchAchOrig HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 630

{
  "Credentials": {
    "UserNumberCredentials": {
      "UserNumber": 1995,
      "Password": "2dfKQYR!TeXJwe"
    }
  },
  "AccountNumber": "text",
  "BatchAchOrigFields": {
    "CompanyDiscretionaryData": "text",
    "CompanyEntryDescription": "text",
    "CompanyId": "text",
    "CompanyName": "text",
    "DepositSettlementDate": "2025-11-07",
    "EffectiveEntryDate": "2025-11-07",
    "Expiration": "2025-11-07",
    "GroupNumber": "text",
    "Id": "text",
    "IdType": 1,
    "Locator": 1,
    "OrigAmount": 1,
    "PaySettlementDate": "2025-11-07",
    "PostMethod": 1,
    "RecordChangeDate": "2025-11-07",
    "StandardEntryClassCode": "text",
    "Status": 1,
    "TotalOriginationCount": 1,
    "TotalPostedCount": 1
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "BatchAchOrigLocator": 1
}

deleteBatchAchOrig

post
Authorizations
Body
AccountNumberstringOptional
BatchAchOrigLocatorintegerOptional
Responses
200

Successful operation.

application/json
post
/deleteBatchAchOrig
POST /nexum/627/persistent/account/deleteBatchAchOrig HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 186

{
  "Credentials": {
    "UserNumberCredentials": {
      "UserNumber": 1995,
      "Password": "2dfKQYR!TeXJwe"
    }
  },
  "AccountNumber": "text",
  "BatchAchOrigLocator": 1,
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "nxAttributes": {}
}

Last updated

Was this helpful?