NexumAPI Docs
NexumAPI Docs
  • Introduction
  • Authentication
  • Quickstart
  • NaaS Endpoints
  • Capabilities
  • Changelog
  • Links
    • NexumAPI
    • GitHub
  • Resources
    • Symitar Playground
    • Help & Feedback
  • SymXchange
    • API Reference
      • Persistent
        • AccountService
          • Account
          • BatchAchOrig
          • Card
            • createCard
            • deleteCard
            • getCard
            • searchCard
            • updateCard
          • Comment
          • CpWorkCard
          • CredRep
          • Eft
            • createEft
            • deleteEft
            • getEft
            • searchEft
            • updateEft
          • ExternalAccount
          • ExternalLoan
            • createExternalLoan
            • deleteExternalLoan
            • getExternalLoan
            • searchExternalLoan
            • updateExternalLoan
          • FmHistoryPagedList
          • Household
          • Irs
            • createIrs
            • deleteIrs
            • getIrs
            • searchIrs
            • updateIrs
          • Loan
            • createLoan
            • deleteLoan
            • getLoan
            • searchLoan
            • updateLoan
          • LoanApp
            • createLoanApp
            • deleteLoanApp
            • getLoanApp
            • searchLoanApp
            • updateLoanApp
          • Lookup
          • Name
          • Note
          • Pledge
          • Portfolio
            • createPortfolio
            • deletePortfolio
            • getPortfolio
            • searchPortfolio
            • updatePortfolio
          • Preference
          • Share
            • createShare
            • deleteShare
            • getShare
            • searchShare
            • updateShare
          • Site
          • Tracking
        • AccountsPayableService
        • BalancingService
        • BatchJobsService
        • CashLetterService
        • CheckService
        • CheckVerificationService
        • CollateralService
        • ContactEventMgmtService
        • CorpTransferService
        • CreditReportService
        • DealerService
        • EcaaService
        • ExceptionItemService
        • FileManagementService
        • FindByService
        • FinrepService
        • GeneralLedgerService
        • InformationService
        • InventoryService
        • MbraddressService
        • MemberService
        • NonAccountNameService
        • ParticipantService
        • PayeeService
        • PowerOnService
        • ProjectionService
        • ReceivedItemService
        • RemittanceService
        • TransactionsService
        • UserManagementService
        • UserService
        • WireService
          • Wire
          • WireBeneficiary
            • createWireBeneficiary
            • deleteWireBeneficiary
            • getWireBeneficiary
            • searchWireBeneficiary
            • updateWireBeneficiary
          • WireDrawdownDebit
          • WireFiToFiInfo
          • WireFmHistory
          • WireIntermedFi
          • WireOfacDetails
          • WireReceiverFiInfo
          • WireServiceMessage
          • WireUscAudit
      • v2022.01
        • AccountService
          • Account
          • BatchAchOrig
          • Card
            • createCard
            • deleteCard
            • getCard
            • searchCard
            • updateCard
          • Comment
          • CpWorkCard
          • CredRep
          • Eft
            • createEft
            • deleteEft
            • getEft
            • searchEft
            • updateEft
          • ExternalAccount
          • ExternalLoan
            • createExternalLoan
            • deleteExternalLoan
            • getExternalLoan
            • searchExternalLoan
            • updateExternalLoan
          • FmHistoryPagedList
          • Household
          • Irs
            • createIrs
            • deleteIrs
            • getIrs
            • searchIrs
            • updateIrs
          • Loan
            • createLoan
            • deleteLoan
            • getLoan
            • searchLoan
            • updateLoan
          • LoanApp
            • createLoanApp
            • deleteLoanApp
            • getLoanApp
            • searchLoanApp
            • updateLoanApp
          • Lookup
          • Name
          • Note
          • Pledge
          • Portfolio
            • createPortfolio
            • deletePortfolio
            • getPortfolio
            • searchPortfolio
            • updatePortfolio
          • Preference
          • Share
            • createShare
            • deleteShare
            • getShare
            • searchShare
            • updateShare
          • Site
          • Tracking
        • AccountsPayableService
        • BalancingService
        • BatchJobsService
        • CashLetterService
        • CashMachines
        • CheckService
        • CheckVerificationService
        • CollateralService
        • ContactEventMgmtService
        • CorpTransferService
        • CreditReportService
        • DealerService
        • EcaaService
        • EpisysInformationService
        • ExceptionItemService
        • FileManagementService
        • FindByService
        • FinrepService
        • GeneralLedgerService
        • InventoryService
        • MbraddressService
        • MemberService
        • NonAccountNameService
        • ParameterService
          • AccountDefault
          • AccountFieldName
          • AcctLimit
          • AcctMembGrpDesc
          • AcctRelCodeDesc
          • AcctTrackingType
          • AcctTypeName
          • AcsGlobal
          • AcsService
          • ActivityFm
          • AnalysisFloat
          • AnalysisGlobal
          • AnalysisPlan
          • ApPmtTermsTablePagedList
          • ApWorkFlow
          • Atm
          • Audio
          • BatchRc
          • CardDefault
          • CardWiz
          • CashOrderVendor
          • Cdm
          • CheckOrderDefault
          • CollateralType
          • CollatrlTrackingType
          • Comment
          • ConsoleFm
          • CorpTransfer
          • CpLetter
          • CpWorkCard
          • CreditReport
          • Crs
          • CurrencyCtrl
          • DailyPost
          • DealerStatement
          • DebtRatio
          • Disclosure
          • DivIndexGlobal
          • DivIndexLocal
          • DivTable
          • DocExcpNotice
          • DocTypeDefault
          • DocumentNumber
          • EpisysDbExtract
          • EscrowAnalysis
          • EscrowType
          • ExtLoan
          • GlCategory
          • GlCode
          • GlTable
          • GlTrackingType
          • GlxLate
          • IdentIdTypeDesc
          • Imaging
          • InqDefinition
          • InsTable
          • InsType
          • Institution
          • IntIndex
          • IntType
          • InventoryCopiedFlds
          • InventoryDefault
          • InventoryFieldName
          • InventoryType
          • IrsBkupWithhold
          • IrsContriLimit
          • ItcFraud
          • ItcInstallation
          • LateChg
          • LnSegmentDefault
          • LoanAppCopiedFlds
          • LoanAppDefault
          • LoanAppDenial
          • LoanAppFieldName
          • LoanAppFormPkt
          • LoanAppMisc
          • LoanAppPrintApp
          • LoanAppReusedFlds
          • LoanAppVerForm
          • LoanAppViewApp
          • LoanAppWorkFlow
          • LoanDefault
          • LoanFieldName
          • LoanTypeIdRange
          • LookupTypeName
          • Misc
          • MoProduct
          • NameFieldName
          • Ncua5300
          • NonRegCc
          • Notice
          • OnlineBlock
          • OnlineCard
          • OnlineFee
          • OnlineFile
          • OnlineMain
          • OnlineNet
          • OnlineOutlet
          • OnlineSbAddOn
          • OnlineSba
          • OnlineSbi
          • Param360View
          • Parameter
          • PartStatement
          • PartTrackingType
          • ParticipantFieldName
          • PayCalc
          • PeriodicMtg
          • PlanDefault
          • PlanFieldName
          • PmtAppMethod
          • PositivePay
          • PreferenceDefault
          • PrivGroup
          • RegCc
          • ScreenDefinition
          • SecField
          • Security
          • ShareDefault
          • ShareFieldName
          • Statement
          • StmtMailName
          • StmtMessages
          • Stock
          • SycClient
          • SycGeneral
          • SymXClient
          • SymXDeviceMap
          • SymXGeneral
          • SymXInstance
          • SynapsysMrm
          • TcProduct
          • TellerFee
          • TellerTranFee
          • TellerTranValidate
          • Tpt
          • TrackingCode
          • UserFm
          • UserTrackingFm
          • UserTrackingType
          • Warnings
          • WdFee
          • WestUnCommCode
          • WireBfc
          • WireCorpVer
          • WireIdCode
          • WireInCmtCode
          • WireMisc
          • WireOutCmtCode
          • WireTypeCode
          • WorkFlowRepGen
          • YellowHammer
        • ParticipantService
        • PayeeService
        • PowerOnService
        • ProjectionService
        • ReceivedItemService
        • RemittanceService
        • SymXchangeVerificationService
        • TransactionsService
        • UserManagementService
        • UserService
        • WireService
          • Wire
          • WireBeneficiary
            • createWireBeneficiary
            • deleteWireBeneficiary
            • getWireBeneficiary
            • searchWireBeneficiary
            • updateWireBeneficiary
          • WireDrawdownDebit
          • WireFiToFiInfo
          • WireFmHistory
          • WireIntermedFi
          • WireOfacDetails
          • WireReceiverFiInfo
          • WireServiceMessage
          • WireUscAudit
    • Credentials
    • Device Information
Powered by GitBook
On this page

Was this helpful?

  1. SymXchange
  2. API Reference
  3. Persistent
  4. AccountService

BatchAchOrig

PreviousAccountNextCard

Last updated 10 months ago

Was this helpful?

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

Symitar eDocs References: Coming soon.

Operations

  • Operations
  • POSTgetBatchAchOrigSelectFields
  • POSTgetBatchAchOrigPagedListSelectFields
  • POSTsearchBatchAchOrigPagedSelectFields
  • POSTupdateBatchAchOrigByID
  • POSTcreateBatchAchOrig
  • POSTdeleteBatchAchOrig

getBatchAchOrigSelectFields

post
Authorizations
Body
AccountNumberstringOptional
BatchAchOrigLocatorintegerOptional
Responses
200
Successful operation.
application/json
post
POST /nexum/627/persistent/account/getBatchAchOrigSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer JWT
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-05-21",
    "EffectiveEntryDate": "2025-05-21",
    "Expiration": "2025-05-21",
    "GroupNumber": "text",
    "Id": "text",
    "IdType": 1,
    "Locator": 1,
    "OrigAmount": 1,
    "PaySettlementDate": "2025-05-21",
    "PostMethod": 1,
    "RecordChangeDate": "2025-05-21",
    "StandardEntryClassCode": "text",
    "Status": 1,
    "TotalOriginationCount": 1,
    "TotalPostedCount": 1
  }
}

getBatchAchOrigPagedListSelectFields

post
Authorizations
Body
AccountNumberstringOptional
Responses
200
Successful operation.
application/json
post
POST /nexum/627/persistent/account/getBatchAchOrigPagedListSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer JWT
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-05-21",
      "EffectiveEntryDate": "2025-05-21",
      "Expiration": "2025-05-21",
      "GroupNumber": "text",
      "Id": "text",
      "IdType": 1,
      "Locator": 1,
      "OrigAmount": 1,
      "PaySettlementDate": "2025-05-21",
      "PostMethod": 1,
      "RecordChangeDate": "2025-05-21",
      "StandardEntryClassCode": "text",
      "Status": 1,
      "TotalOriginationCount": 1,
      "TotalPostedCount": 1
    }
  ],
  "Token": "text"
}

searchBatchAchOrigPagedSelectFields

post
Authorizations
Body
AccountNumberstringOptional
Responses
200
Successful operation.
application/json
post
POST /nexum/627/persistent/account/searchBatchAchOrigPagedSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer JWT
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-05-21",
      "EffectiveEntryDate": "2025-05-21",
      "Expiration": "2025-05-21",
      "GroupNumber": "text",
      "Id": "text",
      "IdType": 1,
      "Locator": 1,
      "OrigAmount": 1,
      "PaySettlementDate": "2025-05-21",
      "PostMethod": 1,
      "RecordChangeDate": "2025-05-21",
      "StandardEntryClassCode": "text",
      "Status": 1,
      "TotalOriginationCount": 1,
      "TotalPostedCount": 1
    }
  ],
  "Token": "text"
}

updateBatchAchOrigByID

post
Authorizations
Body
AccountNumberstringOptional
BatchAchOrigLocatorintegerOptional
Responses
200
Successful operation.
application/json
post
POST /nexum/627/persistent/account/updateBatchAchOrigByID HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer JWT
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-05-21",
    "EffectiveEntryDate": "2025-05-21",
    "Expiration": "2025-05-21",
    "GroupNumber": "text",
    "Id": "text",
    "IdType": 1,
    "Locator": 1,
    "OrigAmount": 1,
    "PaySettlementDate": "2025-05-21",
    "PostMethod": 1,
    "RecordChangeDate": "2025-05-21",
    "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
POST /nexum/627/persistent/account/createBatchAchOrig HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer JWT
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-05-21",
    "EffectiveEntryDate": "2025-05-21",
    "Expiration": "2025-05-21",
    "GroupNumber": "text",
    "Id": "text",
    "IdType": 1,
    "Locator": 1,
    "OrigAmount": 1,
    "PaySettlementDate": "2025-05-21",
    "PostMethod": 1,
    "RecordChangeDate": "2025-05-21",
    "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
POST /nexum/627/persistent/account/deleteBatchAchOrig HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer JWT
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": {}
}