Batch Contributions

Please refer to the Batch Enrollment process for more information about Batch Contributions. Similar to Member Batch Enrollment, Lynx offers clients batch specifications for JSON and CSV formats to provide contribution manifest files. Our batch contribution capabilities include:

File Options: Lynx provides specifications for JSON, CSV, and Delimited file formats. The formats prescribe the model for preparing the data.
Dedicated Client SFTP and S3 Storage Bucket: During client onboarding, Lynx establishes batch SFTP for each client. Client uploads the contribution files securely to an SFTP endpoint. Note: Clients have their own unique SFTP endpoints within the Lynx structure.
Batch Format Validation: Lynx evaluates the batch format once received from Client to verify compliance with the Lynx specification. If the batch format evaluation fails, the file is withheld and Client contacts are notified.
Data Validation: Lynx evaluates the record-level data, including verifying inclusion of mandatory data elements, conforming data types and sizing, date formats, and functional age validations. Lynx offers two options: (1) Partially process all passed records and return failed records; (2) Do not partially process and return failed records.
Contribution Notification: Our clients are notified when the contribution process is complete.
Process Manifest with Passed and Issue Records: Our clients receive a manifest containing processed member information and any issue records along with issue root cause.

File Name	Description	.json	.csv
postClientOrgContributionRequest	A client organization will use this batch file to initiate a contribution from the client organization's FBO account to a member account on the Lynx platform.
BatchControlFile	Used to separately validate the file contents of each batch file.

Please note, the process to ensure sufficient funds are present in your FBO is different in contribution batch file processing. When using the Contribution Batch File process, you will need to include a Batch Control file that denotes the total contribution records and the total contribution amount. This information is used by Lynx to prevent potential errors in the Contribution Batch File. If any discrepancies are identified between the Batch Control file and the Contribution Batch File, an error will be passed to you and the file will not be processed. If there are insufficient funds in your FBO account, the file will be processed, but an exception message will be returned, "There are Insufficient Funds in the Account ending with [XXXX]".

The data file format is as follows:

Field Names
/data/clientOrg/name
/data/clientOrgAccount/id
/data/clientOrgContribution/member/clientMemberId
/data/clientOrgContribution/account/accountType
/data/clientOrgContribution/product/name
/data/clientOrgContribution/type
/data/clientOrgContribution/shortMemo
/data/clientOrgContribution/amount
/data/clientOrgContribution/contributionDate
/data/clientOrgContribution/taxYear
/idempotency/idempotencyKey

The associated control file format is as follows - note that the control file needs to be a .json file with ""ControlFile"" text somewhere in the file name. For example: Acme_ControlFile_April2026.json

{          
    "clientOrgName": "Acme",          
    "processType": "CONTRIBUTIONS",          
    "validationOnlyIndicator": false,          
    "processAllOrNothingIndicator": false,         
    "count": 1,          
   "amount": 600.0,     
    "batchProcessDetail": {
        "fileName"": "AcmeContributionsForApril2024.txt", 
        "fileType": "PIPE_DELIMITED"        
    }
}"