BatchAchOrig

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

Symitar eDocs References: Coming soon.

Operations

getBatchAchOrig

post

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

AccountNumberstringOptional

BatchAchOrigLocatorintegerOptional

Responses

200

Successful operation.

application/json

post/getBatchAchOrig

HTTPcURLJavaScriptPython

POST /nexum/627/2022.01/account/getBatchAchOrig HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 212

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "AccountNumber": "0000013454",
  "BatchAchOrigLocator": 295,
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

{
  "BatchAchOrig": {
    "Locator": 295,
    "RecordChangeDate": "2010-05-08"
  },
  "MessageId": "getBatchAchOrig"
}

getBatchAchOrigSelectFields

post

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

AccountNumberstringOptional

BatchAchOrigLocatorintegerOptional

Responses

200

Successful operation.

application/json

post/getBatchAchOrigSelectFields

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "AccountNumber": "0000013454",
  "BatchAchOrigLocator": 295,
  "SelectableFields": {
    "IncludeAllBatchAchOrigFields": true
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

{
  "BatchAchOrig": {
    "Locator": 295,
    "RecordChangeDate": "2010-05-08"
  },
  "MessageId": "getBatchAchOrigSelectFields"
}

getBatchAchOrigPagedList

post

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

AccountNumberstringOptional

Responses

200

Successful operation.

application/json

TokenstringOptional

post/getBatchAchOrigPagedList

HTTPcURLJavaScriptPython

POST /nexum/627/2022.01/account/getBatchAchOrigPagedList HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 265

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "AccountNumber": "0000013454",
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 5,
    "NumberOfRecordsToSkip": 0
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

{
  "BatchAchOrig": [],
  "Token": null,
  "MessageId": "getBatchAchOrigPagedList"
}

getBatchAchOrigListSelectFields

post

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

AccountNumberstringOptional

Responses

200

Successful operation.

application/json

post/getBatchAchOrigListSelectFields

HTTPcURLJavaScriptPython

POST /nexum/627/2022.01/account/getBatchAchOrigListSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 243

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "AccountNumber": "0000013454",
  "SelectableFields": {
    "IncludeAllBatchAchOrigFields": true
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

{
  "BatchAchOrigList": [],
  "MessageId": "getBatchAchOrigListSelectFields"
}

searchBatchAchOrigSelectFields

post

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

AccountNumberstringOptional

Responses

200

Successful operation.

application/json

post/searchBatchAchOrigSelectFields

HTTPcURLJavaScriptPython

POST /nexum/627/2022.01/account/searchBatchAchOrigSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 284

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "AccountNumber": "0000013454",
  "SelectableFields": {
    "IncludeAllBatchAchOrigFields": true
  },
  "SearchFilter": {
    "Query": "example-query"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

{
  "BatchAchOrigList": [],
  "MessageId": "searchBatchAchOrigSelectFields"
}

getBatchAchOrigPagedListSelectFields

post

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

AccountNumberstringOptional

Responses

200

Successful operation.

application/json

TokenstringOptional

post/getBatchAchOrigPagedListSelectFields

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "AccountNumber": "0000013454",
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 5,
    "NumberOfRecordsToSkip": 0
  },
  "SelectableFields": {
    "IncludeAllBatchAchOrigFields": false,
    "BatchAchOrigFields": {
      "Locator": true,
      "CompanyName": true,
      "CompanyId": true,
      "StandardEntryClassCode": true,
      "Status": true,
      "RecordChangeDate": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

{
  "BatchAchOrig": [],
  "Token": null,
  "MessageId": "getBatchAchOrigPagedListSelectFields"
}

searchBatchAchOrigPagedSelectFields

post

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

AccountNumberstringOptional

QuerystringOptional

Responses

200

Successful operation.

application/json

TokenstringOptional

post/searchBatchAchOrigPagedSelectFields

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "AccountNumber": "0000013454",
  "Query": "LOCATOR=0",
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 5,
    "NumberOfRecordsToSkip": 0
  },
  "SelectableFields": {
    "IncludeAllBatchAchOrigFields": false,
    "BatchAchOrigFields": {
      "Locator": true,
      "CompanyName": true,
      "CompanyId": true,
      "StandardEntryClassCode": true,
      "Status": true,
      "RecordChangeDate": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

{
  "BatchAchOrig": [],
  "Token": null,
  "MessageId": "searchBatchAchOrigPagedSelectFields"
}

updateBatchAchOrigByID

post

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

BatchAchOrigLocatorintegerOptional

AccountNumberstringOptional

Responses

200

Successful operation.

application/json

post/updateBatchAchOrigByID

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "AccountNumber": "0000013824",
  "BatchAchOrigLocator": 295,
  "BatchAchOrigUpdatableFields": {
    "CompanyName": "NEXUM UPDATED",
    "CompanyEntryDescription": "UPD"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

{
  "UpdateStatus": {
    "isAllFieldsUpdateSuccess": true,
    "FailedUpdateStatus": []
  },
  "MessageId": "updateBatchAchOrigByID"
}

createBatchAchOrig

post

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

AccountNumberstringOptional

Responses

200

Successful operation.

application/json

BatchAchOrigLocatorintegerOptional

post/createBatchAchOrig

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "AccountNumber": "0000013824",
  "BatchAchOrigCreatableFields": {
    "Status": 0,
    "CompanyName": "NEXUM TEST",
    "CompanyId": "1234567890",
    "CompanyEntryDescription": "TEST",
    "StandardEntryClassCode": "PPD",
    "EffectiveEntryDate": "2026-06-29"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

{
  "BatchAchOrigLocator": 295,
  "MessageId": "createBatchAchOrig"
}

deleteBatchAchOrig

post

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

AccountNumberstringOptional

BatchAchOrigLocatorintegerOptional

Responses

200

Successful operation.

application/json

nxAttributesobjectOptional

The custom object for NexumAPI response attributes.

post/deleteBatchAchOrig

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "AccountNumber": "0000013824",
  "BatchAchOrigLocator": 295,
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

{
  "MessageId": "deleteBatchAchOrig"
}