Get a link to Cash Discount Compliance

API Method: GET /api/v1/merchant/getCashDiscountComplianceLink

Description:

This API endpoint retrieves a URL link to the Cash Discount Compliance page for a specific merchant. Cash discount programs allow merchants to offer discounts to customers who pay with cash, and this compliance page ensures that merchants follow regulatory guidelines for such programs. The link is provided based on the merchant’s unique identifier (id).

Request:

• HTTP Method: GET
• Endpoint: /api/v1/merchant/getCashDiscountComplianceLink

Query Parameters:

• id (required):
  A unique identifier for the merchant. The id is used to retrieve the specific compliance link associated with the merchant.
  • Type: String
  • Example: id=merchant_12345

Response:

• Status Code:

  • 200 OK: If the link to the Cash Discount Compliance page is successfully retrieved.
  • 400 Bad Request: If the id parameter is missing or invalid.
  • 404 Not Found: If no compliance link is found for the given id.
  • 500 Internal Server Error: If there is an issue processing the request.

• Response Body:
  The response contains the URL link to the Cash Discount Compliance page for the specified merchant.

Response Fields:

• id: The unique identifier for the merchant.
  • Type: String
  • Example: "id": "12345"
• complianceLink: The URL to the merchant’s Cash Discount Compliance page.
  • Type: String
  • Example: "complianceLink": "https://hq.netevia.com/12345/cash_discount"

Example Request:

GET /api/v1/merchant/getCashDiscountComplianceLink?id=12345

Example Response:

{
  "id": "merchant_12345",
  "complianceLink": "https://compliance.paymentservice.com/merchant_12345/cash_discount"
}

Use Case:

This API method is used by merchants or administrative teams to obtain the link to their Cash Discount Compliance page, ensuring they meet the legal and regulatory requirements for offering cash discounts. It allows merchants to easily access and review their compliance status.