Skip to content
NexumAPI Docs

BatchAchOrig⁠

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

Operations⁠

getBatchAchOrig⁠

POST
Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json
AccountNumberstringoptional
BatchAchOrigLocatorintegeroptional
Path Parameters
symstringrequired
Sym number
Responses
POST/nexum/{sym}/2022.01/account/getBatchAchOrig
POST /nexum/627/2022.01/account/getBatchAchOrig HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "AccountNumber": "0000000000",
  "BatchAchOrigLocator": 0,
  "nxAttributes": {
    "customFields": {
      "appId": "string"
    }
  }
}

getBatchAchOrigSelectFields⁠

POST
Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json
AccountNumberstringoptional
BatchAchOrigLocatorintegeroptional
Path Parameters
symstringrequired
Sym number
Responses
POST/nexum/{sym}/2022.01/account/getBatchAchOrigSelectFields
POST /nexum/627/2022.01/account/getBatchAchOrigSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "AccountNumber": "0000000000",
  "BatchAchOrigLocator": 0,
  "SelectableFields": {
    "IncludeAllBatchAchOrigFields": true
  },
  "nxAttributes": {
    "customFields": {
      "appId": "string"
    }
  }
}

getBatchAchOrigPagedList⁠

POST
Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json
AccountNumberstringoptional
Path Parameters
symstringrequired
Sym number
Responses
Tokenstringoptional
POST/nexum/{sym}/2022.01/account/getBatchAchOrigPagedList
POST /nexum/627/2022.01/account/getBatchAchOrigPagedList HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "AccountNumber": "0000000000",
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 0,
    "NumberOfRecordsToSkip": 0
  },
  "nxAttributes": {
    "customFields": {
      "appId": "string"
    }
  }
}

getBatchAchOrigListSelectFields⁠

POST
Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json
AccountNumberstringoptional
Path Parameters
symstringrequired
Sym number
Responses
POST/nexum/{sym}/2022.01/account/getBatchAchOrigListSelectFields
POST /nexum/627/2022.01/account/getBatchAchOrigListSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "AccountNumber": "0000000000",
  "SelectableFields": {
    "IncludeAllBatchAchOrigFields": true
  },
  "nxAttributes": {
    "customFields": {
      "appId": "string"
    }
  }
}

searchBatchAchOrigSelectFields⁠

POST
Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json
AccountNumberstringoptional
Path Parameters
symstringrequired
Sym number
Responses
POST/nexum/{sym}/2022.01/account/searchBatchAchOrigSelectFields
POST /nexum/627/2022.01/account/searchBatchAchOrigSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "AccountNumber": "0000000000",
  "SelectableFields": {
    "IncludeAllBatchAchOrigFields": true
  },
  "SearchFilter": {
    "Query": "string"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "string"
    }
  }
}

getBatchAchOrigPagedListSelectFields⁠

POST
Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json
AccountNumberstringoptional
Path Parameters
symstringrequired
Sym number
Responses
Tokenstringoptional
POST/nexum/{sym}/2022.01/account/getBatchAchOrigPagedListSelectFields
POST /nexum/627/2022.01/account/getBatchAchOrigPagedListSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "AccountNumber": "0000000000",
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 0,
    "NumberOfRecordsToSkip": 0
  },
  "SelectableFields": {
    "IncludeAllBatchAchOrigFields": false,
    "BatchAchOrigFields": {
      "Locator": true,
      "CompanyName": true,
      "CompanyId": true,
      "StandardEntryClassCode": true,
      "Status": true,
      "RecordChangeDate": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "string"
    }
  }
}

searchBatchAchOrigPagedSelectFields⁠

POST
Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json
AccountNumberstringoptional
Querystringoptional
Path Parameters
symstringrequired
Sym number
Responses
Tokenstringoptional
POST/nexum/{sym}/2022.01/account/searchBatchAchOrigPagedSelectFields
POST /nexum/627/2022.01/account/searchBatchAchOrigPagedSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "AccountNumber": "0000000000",
  "Query": "string",
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 0,
    "NumberOfRecordsToSkip": 0
  },
  "SelectableFields": {
    "IncludeAllBatchAchOrigFields": false,
    "BatchAchOrigFields": {
      "Locator": true,
      "CompanyName": true,
      "CompanyId": true,
      "StandardEntryClassCode": true,
      "Status": true,
      "RecordChangeDate": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "string"
    }
  }
}

updateBatchAchOrigByID⁠

POST
Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json
BatchAchOrigLocatorintegeroptional
AccountNumberstringoptional
Path Parameters
symstringrequired
Sym number
Responses
POST/nexum/{sym}/2022.01/account/updateBatchAchOrigByID
POST /nexum/627/2022.01/account/updateBatchAchOrigByID HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "AccountNumber": "0000000000",
  "BatchAchOrigLocator": 0,
  "BatchAchOrigUpdatableFields": {
    "CompanyName": "string",
    "CompanyEntryDescription": "string"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "string"
    }
  }
}

createBatchAchOrig⁠

POST
Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json
AccountNumberstringoptional
Path Parameters
symstringrequired
Sym number
Responses
BatchAchOrigLocatorintegeroptional
POST/nexum/{sym}/2022.01/account/createBatchAchOrig
POST /nexum/627/2022.01/account/createBatchAchOrig HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "AccountNumber": "0000000000",
  "BatchAchOrigCreatableFields": {
    "Status": 0,
    "CompanyName": "string",
    "CompanyId": "0",
    "CompanyEntryDescription": "string",
    "StandardEntryClassCode": "string",
    "EffectiveEntryDate": "2026-01-01"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "string"
    }
  }
}

deleteBatchAchOrig⁠

POST
Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json
AccountNumberstringoptional
BatchAchOrigLocatorintegeroptional
Path Parameters
symstringrequired
Sym number
Responses
nxAttributesobjectoptionalThe custom object for NexumAPI response attributes.
POST/nexum/{sym}/2022.01/account/deleteBatchAchOrig
POST /nexum/627/2022.01/account/deleteBatchAchOrig HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "AccountNumber": "0000000000",
  "BatchAchOrigLocator": 0,
  "nxAttributes": {
    "customFields": {
      "appId": "string"
    }
  }
}