| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Get Merchant Compliance Link
Returns a URL linking to the Cash Discount Compliance page for the specified merchant. This page is used to ensure merchants enrolled in a cash discount program are meeting the regulatory and card brand requirements for displaying and communicating the program to customers. The link can be shared with the merchant or used by compliance staff for review.
Endpoint
GET /api/v1/merchant/getCashDiscountComplianceLink
Authentication
Basic HTTP Authentication required.
Encode username:password in Base64 and pass in the Authorization header:
Authorization: Basic {base64(username:password)}
When to use
Use this endpoint when a merchant is enrolled in a cash discount program (i.e., cashDiscount was set to Yes during merchant creation) and you need to direct the merchant or compliance staff to their compliance review page. This is typically called during onboarding after the merchant application is created, or during periodic compliance audits. The returned link provides access to guidelines, materials, and the current compliance status for the specific merchant.
Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer (int32) | Yes | The merchant profile ID for which to retrieve the compliance link |
Response
200 OK
| Field | Type | Description |
|---|---|---|
| complianceLink | string | URL to the merchant's Cash Discount Compliance page |
| requestId | integer | Unique identifier for this API request |
| success | boolean | true if the link was successfully retrieved |
| error | string | Error message if the retrieval failed |
| validationErrors | array | List of field-level validation errors with field and error properties |
{
"complianceLink": "https://hq.netevia.com/compliance/cash-discount/48291?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9",
"requestId": 92187,
"success": true,
"error": null,
"validationErrors": []
}Error Codes
| Code | When it happens |
|---|---|
| 400 | id parameter is missing or not a valid integer |
| 401 | Invalid or missing Basic Auth credentials |
| 403 | User does not have permission for this operation |
| 404 | No compliance link found for the merchant with the specified id |
| 500 | Internal server error |
Common Mistakes
- Calling this endpoint for merchants that are not enrolled in a cash discount program — a compliance link may not be available or meaningful if
cashDiscountwas set toNoat creation. - Assuming the returned link is permanent — compliance links may be time-limited or token-protected; generate a fresh link each time rather than storing it for later use.
- Not handling a
nullor emptycomplianceLinkin the response — if the merchant does not have an associated compliance record, the link field may be null even whensuccessistrue.
Related Endpoints
POST /api/v1/merchant/create— create a merchant withcashDiscount: "Yes"to enroll in the cash discount programGET /api/v1/merchant/status— check the merchant's current boarding and processing statusGET /api/v1/merchant/notes— review notes associated with the merchant's compliance or review history
Example
curl -X GET "https://hq.staging.netevia.dev/api/v1/merchant/getCashDiscountComplianceLink?id=48291" \
-H "Authorization: Basic $(echo -n 'username:password' | base64)"