Documents

Retrieves a list of voided checks

get

This endpoint uses the eDoc service to retrieve details of all documents in the voided check category for a specified merchant number. The response provides information such as the Document ID, file name, description, and category details.

Path parameters

merchantNumberstringRequired

Merchant Number used to filter voided checks.

Header parameters

exchangeIdstringOptional

Correlation Id for the request

Responses

200

Returns a collection of voided checks successfully.

application/json

204

No Content

400

Bad Request: Returns when merchantNumber is null or empty.

application/json

401

Unauthorized: User does not have the required role or access.

application/json

403

Forbidden: The user does not have the necessary permissions to access this resource.

application/json

500

Internal Server Error: This could be due to system errors. Please contact support for assistance

application/json

get

/api/demographics/v1/Documents/{merchantNumber}/VoidedChecks

GET /api/demographics/v1/Documents/{merchantNumber}/VoidedChecks HTTP/1.1
Host: localhost:5000
Accept: */*

{
  "content": [
    {
      "category": 1,
      "categoryDescription": "Voided Check",
      "description": "VoidedCheck",
      "documentId": "2f934e9e-ac8c-48e6-b1ec-77baa3e5c247",
      "fileName": "test",
      "merchantNumber": "345685697696",
      "metaData": [
        {
          "metadataKey": "dateuploaded",
          "metadataValue": "01/16/2025 14:25:52"
        }
      ],
      "fileExtension": ".png",
      "dateUploaded": "2025-01-16T14:32:25.3992399Z"
    }
  ]
}

Upload Voided Check

post

Path parameters

merchantNumberstringRequired

Query parameters

fileNamestringRequired

The name of the file to upload.

bankAccountIdstringRequired

The bankAccountId of the account for which the voided check is being provided. This value will be returned when creating, updating, or retreiving a bank account.

Header parameters

exchangeIdstringOptional

Correlation Id for the request

Body

string · byteOptional

Responses

200

Success

application/json

stringOptional

400

Bad Request

application/json

500

Server Error

application/json

post

/api/demographics/v1/Documents/{merchantNumber}/VoidedChecks

POST /api/demographics/v1/Documents/{merchantNumber}/VoidedChecks?fileName=text&bankAccountId=text HTTP/1.1
Host: localhost:5000
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 10

"Ynl0ZXM="

text

Upload Voided Check

post

Path parameters

merchantNumberstringRequired

Query parameters

fileNamestringRequired

The name of the file to upload.

bankAccountIdstringRequired

The bankAccountId of the account for which the voided check is being provided. This value will be returned when creating, updating, or retreiving a bank account.

Header parameters

exchangeIdstringOptional

Correlation Id for the request

Body

stringOptional

Responses

200

Success

application/json

stringOptional

400

Bad Request

application/json

500

Server Error

application/json

post

/api/demographics/v1/Documents/{merchantNumber}/VoidedChecks/Base64Format

POST /api/demographics/v1/Documents/{merchantNumber}/VoidedChecks/Base64Format?fileName=text&bankAccountId=text HTTP/1.1
Host: localhost:5000
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 6

"text"

text

Upload Document with count. Used if you have a single file that contains multiple documents of the same type. This allows you to attach metadata indicating that the number of files of that type which are included. An example would be a PDF containing statements multiple months worth of statements.

post

Path parameters

merchantNumberstringRequired

Query parameters

fileNamestringRequired

The name of the file to upload.

documentCategoryinteger · enumOptional

The document category of the documents in the provided file.

Possible values:

countinteger · int32Optional

The number of documents provided in this file

Header parameters

exchangeIdstringOptional

Correlation Id for the request

Body

stringOptional

Responses

200

Success

application/json

stringOptional

400

Bad Request

application/json

500

Server Error

application/json

post

/api/demographics/v1/Documents/{merchantNumber}/MultipleDocuments/Base64Format

POST /api/demographics/v1/Documents/{merchantNumber}/MultipleDocuments/Base64Format?fileName=text HTTP/1.1
Host: localhost:5000
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 6

"text"

text

Upload Document with count. Used if you have a single file that contains multiple documents of the same type. This allows you to attach metadata indicating that the number of files of that type which are included. An example would be a PDF containing statements multiple months worth of statements.

post

Path parameters

merchantNumberstringRequired

Query parameters

fileNamestringRequired

The name of the file to upload.

documentCategoryinteger · enumOptional

The document category of the documents in the provided file.

Possible values:

countinteger · int32Optional

The number of documents provided in this file

Header parameters

exchangeIdstringOptional

Correlation Id for the request

Body

string · byteOptional

Responses

200

Success

application/json

stringOptional

400

Bad Request

application/json

500

Server Error

application/json

post

/api/demographics/v1/Documents/{merchantNumber}/MultipleDocuments

POST /api/demographics/v1/Documents/{merchantNumber}/MultipleDocuments?fileName=text HTTP/1.1
Host: localhost:5000
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 10

"Ynl0ZXM="

text

Upload Document

post

Path parameters

merchantNumberstringRequired

Merchant Number

Query parameters

fileNamestringRequired

The name of the file to upload.

documentCategoryinteger · enumRequired

The document category of the provided document.

Possible values:

Header parameters

exchangeIdstringOptional

Correlation Id for the request

Body

stringOptional

Responses

200

Success

application/json

stringOptional

404

Not Found

application/json

post

/api/demographics/v1/Documents/{merchantNumber}/Base64Format

POST /api/demographics/v1/Documents/{merchantNumber}/Base64Format?fileName=text&documentCategory=0 HTTP/1.1
Host: localhost:5000
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 6

"text"

text

Retrieves a list of Documents By Category

get

This endpoint retrieves documents based on the provided merchant ID and document category ID (like Financial = 1, IRS = 2, etc). The document category is validated against a predefined whitelist. If the category is not present in the whitelist, an error is generated, and the process is halted.

Path parameters

merchantNumberstringRequired

MerchantNumber used to find particular merchant.

Query parameters

documentCategoryinteger · enumRequired

The document category for filtering particular document type.

Possible values:

Header parameters

exchangeIdstringOptional

Correlation Id for the request

Responses

200

Returns a collection of documents successfully.

application/json

400

Bad Request: Returns when merchantNumber or documentCategory is null or empty or Invalid.

application/json

401

Unauthorized: User does not have the required role or access.

application/json

403

Forbidden: The user does not have the necessary permissions to access this resource.

application/json

500

Internal Server Error: This could be due to system errors. Please contact support for assistance

application/json

get

/api/demographics/v1/Documents/{merchantNumber}

GET /api/demographics/v1/Documents/{merchantNumber}?documentCategory=0 HTTP/1.1
Host: localhost:5000
Accept: */*

{
  "content": [
    {
      "category": 1,
      "categoryDescription": "Voided Check",
      "description": "VoidedCheck",
      "documentId": "2f934e9e-ac8c-48e6-b1ec-77baa3e5c247",
      "fileName": "test",
      "merchantNumber": "345685697696",
      "metaData": [
        {
          "metadataKey": "dateuploaded",
          "metadataValue": "01/16/2025 14:25:52"
        }
      ],
      "fileExtension": ".png",
      "dateUploaded": "2025-01-16T14:32:25.3992399Z"
    }
  ]
}

Upload Document

post

Path parameters

merchantNumberstringRequired

Merchant Number

Query parameters

fileNamestringRequired

The name of the file to upload.

documentCategoryinteger · enumRequired

The document category of the provided document.

Possible values:

Header parameters

exchangeIdstringOptional

Correlation Id for the request

Body

string · byteOptional

Responses

200

Success

application/json

stringOptional

404

Not Found

application/json

post

/api/demographics/v1/Documents/{merchantNumber}

POST /api/demographics/v1/Documents/{merchantNumber}?fileName=text&documentCategory=0 HTTP/1.1
Host: localhost:5000
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 10

"Ynl0ZXM="

text

Upload Signed Application Base 64

post

Path parameters

merchantNumberstringRequired

Query parameters

fileNamestringRequired

The name of the file to upload.

Header parameters

exchangeIdstringOptional

Correlation Id for the request

Body

filestring · nullableOptional

Responses

200

Success

application/json

stringOptional

400

Bad Request

application/json

500

Server Error

application/json

post

/api/demographics/v1/Documents/{merchantNumber}/SignedApplication/Base64Format

POST /api/demographics/v1/Documents/{merchantNumber}/SignedApplication/Base64Format?fileName=text HTTP/1.1
Host: localhost:5000
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 73

{
  "mapping": [
    {
      "businessContactId": 1,
      "documentType": "text"
    }
  ],
  "file": "text"
}

text

Upload Signed Application

post

Path parameters

merchantNumberstringRequired

Query parameters

fileNamestringRequired

The name of the file to upload.

Header parameters

exchangeIdstringOptional

Correlation Id for the request

Body

filestring · byte · nullableOptional

Responses

200

Success

application/json

stringOptional

400

Bad Request

application/json

500

Server Error

application/json

post

/api/demographics/v1/Documents/{merchantNumber}/SignedApplication

POST /api/demographics/v1/Documents/{merchantNumber}/SignedApplication?fileName=text HTTP/1.1
Host: localhost:5000
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 77

{
  "mapping": [
    {
      "businessContactId": 1,
      "documentType": "text"
    }
  ],
  "file": "Ynl0ZXM="
}

text

Retrieves a list of Documents

get

This endpoint retrieves a list of all documents for a specified merchant number. The documents are categorized into different groups, and the response includes comprehensive details about each document within these categories.

Path parameters

merchantNumberstringRequired

MerchantNumber used to filter documents.

Header parameters

exchangeIdstringOptional

Correlation Id for the request

Responses

200

Returns a collection of documents successfully.

application/json

400

Bad Request: Returns when merchantNumber is null or empty.

application/json

401

Unauthorized: User does not have the required role or access.

application/json

403

Forbidden: The user does not have the necessary permissions to access this resource.

application/json

500

Internal Server Error: This could be due to system errors. Please contact support for assistance

application/json

get

/api/demographics/v1/Documents/{merchantNumber}/List

GET /api/demographics/v1/Documents/{merchantNumber}/List HTTP/1.1
Host: localhost:5000
Accept: */*

{
  "content": [
    {
      "category": 1,
      "categoryDescription": "Voided Check",
      "description": "VoidedCheck",
      "documentId": "2f934e9e-ac8c-48e6-b1ec-77baa3e5c247",
      "fileName": "test",
      "merchantNumber": "345685697696",
      "metaData": [
        {
          "metadataKey": "dateuploaded",
          "metadataValue": "01/16/2025 14:25:52"
        }
      ],
      "fileExtension": ".png",
      "dateUploaded": "2025-01-16T14:32:25.3992399Z"
    }
  ]
}

Get Document By DocumentId

get

Path parameters

merchantNumberstringRequired

documentIdstring · uuidRequired

The documentId of the document to retrieve. This value is returned when the document is initially uploaded.

Header parameters

exchangeIdstringOptional

Correlation Id for the request

Responses

200

Success

application/json

string · binaryOptional

404

Not Found

application/json

get

/api/demographics/v1/Documents/{merchantNumber}/{documentId}

GET /api/demographics/v1/Documents/{merchantNumber}/{documentId} HTTP/1.1
Host: localhost:5000
Accept: */*

binary

Deletes a Document for a Merchant

delete

This endpoint deletes a document associated with the specified merchantNumber and documentId. The documentId represents the unique identifier assigned to the document during the upload process. The request requires proper authorization based on the MID policy.

Path parameters

merchantNumberstringRequired

MerchantNumber used to find a merchant.

documentIdstring · uuidRequired

The Id associated with a document. This was returned when the document is initially uploaded.

Header parameters

exchangeIdstringOptional

Correlation Id for the request

Responses

200

Document is deleted successfully.

No content

400

Bad Request: Returns when either the Merchant number or the Document ID provided is null or invalid.

application/json

401

Unauthorized: User does not have the required role or access.

application/json

403

Forbidden: The user does not have the necessary permissions to access this resource.

application/json

500

Internal Server Error: This could be due to system errors. Please contact support for assistance

application/json

delete

/api/demographics/v1/Documents/{merchantNumber}/{documentId}

DELETE /api/demographics/v1/Documents/{merchantNumber}/{documentId} HTTP/1.1
Host: localhost:5000
Accept: */*

No content

Update voidedCheck's bank account number

post

Path parameters

merchantNumberstringRequired

Merchant Number

documentIdstring · uuidRequired

Query parameters

bankAccountIdstringRequired

Header parameters

exchangeIdstringOptional

Correlation Id for the request

Responses

200

Success

application/json

stringOptional

404

Not Found

application/json

post

/api/demographics/v1/Documents/{merchantNumber}/{documentId}/VoidedChecks

POST /api/demographics/v1/Documents/{merchantNumber}/{documentId}/VoidedChecks?bankAccountId=text HTTP/1.1
Host: localhost:5000
Accept: */*

text

Deletes a Voided Check

delete

This endpoint deletes a voided check document from the document storage associated with a given bank account. It also updates the associated bank account to remove the reference to the deleted voided check. The request requires proper authorization based on the MID policy.

Path parameters

documentIdstring · uuidRequired

The documentId of the document to delete. This value is returned when the document is initially uploaded.

merchantNumberstringRequired

Query parameters

bankAccountIdstringRequired

The bankAccountId of the account for which this voided check was provided. This value will be returned when creating, updating, or retreiving a bank account.

Header parameters

exchangeIdstringOptional

Correlation Id for the request

Responses

200

Document is deleted successfully.

No content

400

Bad Request: Returns when any of the input parameters like the Merchant number, DocumentId or the BankAccountID provided is null or invalid.

application/json

401

Unauthorized: User does not have the required role or access.

application/json

403

Forbidden: The user does not have the necessary permissions to access this resource.

application/json

500

Internal Server Error: This could be due to system errors. Please contact support for assistance

application/json

delete

/api/demographics/v1/Documents/{merchantNumber}/{documentId}/VoidedChecks

DELETE /api/demographics/v1/Documents/{merchantNumber}/{documentId}/VoidedChecks?bankAccountId=text HTTP/1.1
Host: localhost:5000
Accept: */*

No content

Last updated 8 months ago

Was this helpful?

hashtagRetrieves a list of voided checks

hashtagUpload Voided Check

hashtagUpload Voided Check

hashtagUpload Document

hashtagRetrieves a list of Documents By Category

hashtagUpload Document

hashtagUpload Signed Application Base 64

hashtagUpload Signed Application

hashtagRetrieves a list of Documents

hashtagGet Document By DocumentId

hashtagDeletes a Document for a Merchant

hashtagUpdate voidedCheck's bank account number

hashtagDeletes a Voided Check

Retrieves a list of voided checks

Upload Voided Check

Upload Voided Check

Upload Document

Retrieves a list of Documents By Category

Upload Document

Upload Signed Application Base 64

Upload Signed Application

Retrieves a list of Documents

Get Document By DocumentId

Deletes a Document for a Merchant

Update voidedCheck's bank account number

Deletes a Voided Check