Documents

Get a Document

get

Retrieve a specific document for the specified merchant by document ID. The value provided in the MerchantId header must match the merchantNumber specified in the URL.

Path parameters

merchantNumberstringRequired

The merchant's unique identification number.

documentIdstring · uuidRequired

Document ID of the document to be retrieved.

Responses

200

Returns the document as a file stream.

No content

500

Error occurred retrieving the document.

application/octet-stream

get

/api/documents/v1.0/document/{merchantNumber}/{documentId}

HTTPcURLJavaScriptPython

GET /api/documents/v1.0/document/{merchantNumber}/{documentId} HTTP/1.1
Accept: */*

No content

Get Document Types

get

Retrieve a list of available document types for the specified merchant. The MerchantId value provided in the request header must match the merchantNumber specified in the URL

Path parameters

merchantNumberstringRequired

The merchant's unique identification number.

Responses

200

Returns a list of document types.

application/json

500

Error occurred retrieving document types.

application/json

get

/api/documents/v1.0/document/{merchantNumber}/DocumentTypes

HTTPcURLJavaScriptPython

GET /api/documents/v1.0/document/{merchantNumber}/DocumentTypes HTTP/1.1
Accept: */*

{
  "types": [
    {
      "id": 4,
      "name": "Merchant Statements",
      "description": "Merchant Statements"
    }
  ]
}

Get Documents by Type

get

Retrieve a list of documents associated with the specified merchant, filtered by document type. You can use either the documentTypeName or documentTypeId query parameter, but not both. If you use documentTypeName, make sure it is URL-encoded before including it in the request. The MerchantId value provided in the request header must match the merchantNumber specified in the URL.

Path parameters

merchantNumberstringRequired

The merchant's unique identification number.

Query parameters

documentTypeIdstringOptional

A unique identifier of the document type.

documentTypeNamestringOptional

A name of the document type.

Responses

200

Returns a list of documents filtered by type.

application/json

400

Both documentTypeId and documentTypeName were passed.

application/json

500

Error occurred retrieving documents.

application/json

get

/api/documents/v1.0/document/{merchantNumber}/Documents

HTTPcURLJavaScriptPython

GET /api/documents/v1.0/document/{merchantNumber}/Documents HTTP/1.1
Accept: */*

{
  "documents": [
    {
      "documentId": "89d6c2f6-3ea9-45bc-9a32-e33059a72328",
      "merchantNumber": "6588000000009998",
      "name": "stmt_20220831_6588000000009998.pdf",
      "description": "Includes statements from March of 2022.",
      "category": {
        "id": 4,
        "name": "Merchant Statements",
        "description": "Merchant Statements"
      },
      "additionalProperties": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "documentURL": "https://reporting.clearent.net/api/documents/v1.0/document/6588000000009998/89d6c2f6-3ea9-45bc-9a32-e33059a72328"
    }
  ]
}

Get Statements by Year

get

Retrieve all statements for the specified merchant for the given year.

Path parameters

merchantNumberstringRequired

The merchant's unique identification number.

yearstringRequired

A year for which to retrieve statements.

Responses

200

Returns a list of statements for the given year.

application/json

400

Returned when an invalid year was passed.

application/json

500

Returned when an error occurred retrieving statements.

application/json

get

/api/documents/v1.0/document/{merchantNumber}/Statements/{year}

HTTPcURLJavaScriptPython

GET /api/documents/v1.0/document/{merchantNumber}/Statements/{year} HTTP/1.1
Accept: */*

{
  "documents": [
    {
      "documentId": "89d6c2f6-3ea9-45bc-9a32-e33059a72328",
      "merchantNumber": "6588000000009998",
      "name": "stmt_20220831_6588000000009998.pdf",
      "description": "Includes statements from March of 2022.",
      "category": {
        "id": 4,
        "name": "Merchant Statements",
        "description": "Merchant Statements"
      },
      "additionalProperties": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "documentURL": "https://reporting.clearent.net/api/documents/v1.0/document/6588000000009998/89d6c2f6-3ea9-45bc-9a32-e33059a72328"
    }
  ]
}

Get Statements by Year and Month

get

Retrieves all statements for the specified merchant for a given year and month. The MerchantId value provided in the request header must match the merchantNumber specified in the URL.

Path parameters

merchantNumberstringRequired

The merchant's unique identification number.

yearstringRequired

A year for which to retrieve statements.

monthstringRequired

A month for which to retrieve statements.

Responses

200

Returns a list of statements for the given year and month.

application/json

400

Returned when an invalid year or month was passed.

application/json

500

Returned when an error occurred retrieving statements.

application/json

get

/api/documents/v1.0/document/{merchantNumber}/Statements/{year}/{month}

HTTPcURLJavaScriptPython

GET /api/documents/v1.0/document/{merchantNumber}/Statements/{year}/{month} HTTP/1.1
Accept: */*

{
  "documents": [
    {
      "documentId": "89d6c2f6-3ea9-45bc-9a32-e33059a72328",
      "merchantNumber": "6588000000009998",
      "name": "stmt_20220831_6588000000009998.pdf",
      "description": "Includes statements from March of 2022.",
      "category": {
        "id": 4,
        "name": "Merchant Statements",
        "description": "Merchant Statements"
      },
      "additionalProperties": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "documentURL": "https://reporting.clearent.net/api/documents/v1.0/document/6588000000009998/89d6c2f6-3ea9-45bc-9a32-e33059a72328"
    }
  ]
}