Skip to main content

​
Merchant Trust Management Schemas

API endpoints for establishing and managing merchant trust levels and capabilities.

​
Endpoints

MethodEndpointDescription
PATCH/v1/provider/merchant/trustUpdate merchant trust settings
GET/v1/provider/merchant/trustVerify merchant trust status
GET/v1/provider/merchant/trust/multipleList merchants with trust filters
GET/v1/provider/merchant/trust/device-permissionCheck device lookup permission
POST/v1/provider/merchant/trust/validateValidate trust level for operation

​
PATCH /v1/provider/merchant/trust

Update trust settings for a merchant to enable advanced features.

​
Request Body

{
  "entityId": "string",
  "trusted": true,
  "trustLevel": "basic | enhanced | premium",
  "deviceLookupEnabled": true
}

​
Request Schema

FieldTypeRequiredDescription
entityIdstringYesMerchant entity identifier
trustedbooleanYesWhether merchant is trusted
trustLevelstringNoTrust level (basic, enhanced, premium)
deviceLookupEnabledbooleanNoEnable device lookup capability

​
Response Schema

{
  "statusCode": 200,
  "success": true,
  "message": "Merchant trust updated successfully",
  "data": {
    "trusted": true,
    "trustLevel": "premium",
    "deviceLookupEnabled": true
  }
}

​
GET /v1/provider/merchant/trust

Verify current trust status for a merchant.

​
Query Parameters

ParameterTypeRequiredDescription
entityIdstringYesMerchant entity identifier

​
Response Schema

{
  "statusCode": 200,
  "success": true,
  "data": {
    "entityId": "string",
    "trusted": true,
    "trustLevel": "premium",
    "deviceLookupEnabled": true,
    "lastVerified": "string"
  }
}

​
GET /v1/provider/merchant/trust/multiple

List merchants with trust level filters.

​
Query Parameters

ParameterTypeRequiredDescription
trustedbooleanNoFilter by trust status
trustLevelstringNoFilter by trust level
deviceLookupEnabledbooleanNoFilter by device lookup capability
limitnumberNoNumber of results to return
offsetnumberNoNumber of results to skip

​
Response Schema

{
  "statusCode": 200,
  "success": true,
  "data": [
    {
      "entityId": "string",
      "entityName": "string",
      "trusted": true,
      "trustLevel": "premium",
      "deviceLookupEnabled": true,
      "lastVerified": "string"
    }
  ],
  "total": 1
}

​
GET /v1/provider/merchant/trust/device-permission

Check if merchant has permission for device lookup operations.

​
Query Parameters

ParameterTypeRequiredDescription
entityIdstringYesMerchant entity identifier

​
Response Schema

{
  "statusCode": 200,
  "allowed": true,
  "reason": "string",
  "trustStatus": {
    "trusted": true,
    "trustLevel": "premium",
    "deviceLookupEnabled": true,
    "lastVerified": "string"
  }
}

​
POST /v1/provider/merchant/trust/validate

Validate if merchant meets required trust level for specific operations.

​
Request Body

{
  "entityId": "string",
  "requiredTrustLevel": "basic | enhanced | premium"
}

​
Request Schema

FieldTypeRequiredDescription
entityIdstringYesMerchant entity identifier
requiredTrustLevelstringYesRequired trust level for operation

​
Response Schema

{
  "statusCode": 200,
  "success": true,
  "data": {
    "currentTrustLevel": "premium",
    "valid": true
  }
}

​
Trust Levels

LevelDescriptionCapabilities
basicStandard payment processingBasic billing operations
enhancedAdditional capabilitiesDevice lookup, higher limits
premiumFull feature accessRecurring billing, priority support

​
Trust Status Schema

FieldTypeDescription
entityIdstringMerchant identifier
trustedbooleanWhether merchant is trusted
trustLevelstringCurrent trust level
deviceLookupEnabledbooleanDevice lookup capability
lastVerifiedstringLast verification timestamp

​
Error Responses

​
400 Bad Request

{
  "statusCode": 400,
  "success": false,
  "message": "Invalid trust level specified"
}

​
403 Forbidden

{
  "statusCode": 403,
  "success": false,
  "message": "Insufficient permissions to modify trust level"
}

​
404 Not Found

{
  "statusCode": 404,
  "success": false,
  "message": "Merchant not found"
}