eDocs Reporting

The eDocs Reporting API retrieves merchant documents—monthly statements, tax forms, and more.

Base URLs

Environment
URL

Sandbox

https://boarding-sb.clearent.net/

Production

https://boarding.clearent.net/

Headers

Content-Type: application/json
Accept: application/json
AccessKey: Secret access key issued by Xplor Pay
MerchantId: Id of the merchant

Available Endpoints

  • Retrieve Document:

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

  • Retrieve Document Types:

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

  • Retrieve Documents By Type:

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

  • Retrieve Statements by Year:

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

  • Retrieve Statements by Year & Month:

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

Path Parameters

Name
Data Type
Required?
Description

merchantNumber

String

Required

Merchant identifier

documentId

String

Required

GUID of the document

year

String

Required

Year to retrieve statements from

month

String

Required

Month to retrieve statements from

Last updated

Was this helpful?