Merchant Legal Documents

The Merchant Legal Documents API is used to manage legal documents that may require signature collection during the onboarding process. This includes both the Merchant Application and various addendums. The service provides endpoints that can be used to retrieve the most recent versions of each legal document for display, as well as a set of endpoints that can be used to provide evidence that signatures have been collected.

Note: Changes to the signature collection process need to be reviewed with Xplor stakeholders before implementation in production.

Base URLs

Environment	URL
Sandbox	https://boarding-sb.clearent.net/api/
Production	https://boarding.clearent.net/api/

Headers

Content-Type: application/json
Accept: application/json
AccessKey: Secret access key issued by Xplor Pay

Available Endpoints:

Legal Documents:

• Get a Specific Legal Document:

  • GET /api/legaldocuments/v2/documents/{merchantNumber}/{legalDocumentId}

• Update an Existing Legal Document:

  • PUT /api/legaldocuments/v2/documents/{merchantNumber}/{legalDocumentId}

• Delete a Legal Document:

  • DELETE /api/legaldocuments/v2/documents/{merchantNumber}/{legalDocumentId}

• List All Legal Documents for a Merchant:

  • GET /api/legaldocuments/v2/documents/{merchantNumber}

• Get All Legal Document Settings:

  • GET /api/legaldocuments/v2/documents/settings

• Get Settings for a Specific Document Type:

  • GET /api/legaldocuments/v2/documents/settings/{legalDocumentTypeName}

• Create a New Legal Document Record:

  • POST /api/legaldocuments/v3/documents/{merchantNumber}

Terms and Conditions:

• List Terms & Conditions Types:

  • GET /api/legaldocuments/v1/TermsAndConditions/Types

• Get Terms & Conditions for a Merchant:

  • GET /api/legaldocuments/v1/TermsAndConditions/{merchantNumber}

• Get Terms & Conditions for a Merchant and Type:

  • GET /api/legaldocuments/v1/TermsAndConditions/{merchantNumber}/{typeID}

Important: Xplor Pay does not currently offer an endpoint that determines which legal documents are required for a given application. To automate that decision, you must implement the necessary logic within your own system.

Note:

• The Legal Documents endpoints have been introduced to replace the deprecated Signature endpoints. While the previous Signature endpoints remain functional for backward compatibility, developers should migrate to the Legal Documents endpoints for all new implementations.

• Early versions of the Legal Documents endpoints supported alternative routing through /api/demographics/ in addition to the standard /api/legaldocuments/ path. This dual-route support was maintained through application versions V1 and V2 but was removed in V3. All requests should now use the /api/legaldocuments/ route.

Path Parameters

Name	Data Type	Required?	Description
merchantNumber	String	Required	Merchant identifier
legalDocumentId	Integer	Required	Identifier of the specific legal document record
legalDocumentTypeName	String	Required	Document type key (for settings lookup)
typeID	Integer	Required	Terms & Conditions type identifier

Additional Information

Currently Configured Legal Documents

• Merchant Application - Required for all new merchants.

• PAYA Consent to Share - Required for merchants with one or more PAYA equipment orders.

• PAYA ACH Addendum - Required for merchants with one or more PAYA equipment orders.

• Xplor Pay TOS Addendum - Required for merchants with one or more Xplor Pay POS equipment orders.

• CBD Attestation - Required for merchants who sell CBD.

• Sporting Goods and Firearms Addendum - Required for merchants who sell either firearms or firearms accessories.

• Empower Attestation - Required for merchants participating in the Empower program.

Sample Usage Workflow

A potential workflow for the integrator is detailed below:

1. Integrator retrieves the list of legal documents and their settings

2. Determines which legal documents to show to the signer

3. Retrieves the terms and conditions for those legal documents and displays them to the signer

4. Sends information about the signed documents back to Xplor Pay.