/api/v1/merchant/info

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Update Merchant Info (v1)

⚠️

Deprecated — use boardingv2_updatemerchantinfo instead.

Updates the top-level merchant profile properties — including the associated agent profile, POS system, cash discount program status, and optional external reference IDs — for an existing merchant application. This endpoint targets the same data collected in the merchantProfile section of the initial submit request.

Endpoint

POST /api/v1/merchant/info

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 the agent profile, POS type, or cash discount setting needs to be changed after initial submission but before the merchant application is approved. For example, if a merchant switches from a standard terminal to a Clover POS after submission, this endpoint updates that configuration without requiring a full re-submission. For new integrations, use the v2 equivalent.

Request Body

FieldTypeRequiredDescription
idinteger (int32)YesMerchant profile ID to update (1–999999).
merchantobjectNoMerchant profile fields to update.
merchant.cashDiscountstringYes (if merchant provided)Cash discount program flag. Enum: No, Yes.
merchant.agentProfileIdintegerYes (if merchant provided)Agent profile ID to associate with this merchant.
merchant.posstringYes (if merchant provided)POS system type. Enum: None, Clover, PalomaPOS, PoyntPOS, CloverGo, UnifiedMpos, Aldelo, Restoactive, EHopper, FreedomPos, GretaPOS, and others.
merchant.boardingSettingsIdintegerNoBoarding settings template ID.
merchant.midstringNoMerchant ID (MID) override value.
merchant.externalClientIDstringNoExternal client reference identifier.
merchant.externalChainIDstringNoExternal chain reference identifier.
{
  "id": 10482,
  "merchant": {
    "cashDiscount": "No",
    "agentProfileId": 201,
    "pos": "Clover",
    "boardingSettingsId": 15
  }
}

Response

200 OK

FieldTypeDescription
dataobjectEmpty object on success.
statusstringHTTP status name (e.g., "OK").
errorstringError message if the update failed; otherwise null.
warningstringNon-fatal warning, if any.
validationResultsarrayField-level validation errors, if any.
requestIdintegerInternal request tracking ID.
{
  "data": {},
  "status": "OK",
  "error": null,
  "warning": null,
  "validationResults": [],
  "requestId": 55871
}

Error Codes

CodeWhen it happens
400id is missing or out of range, or a required merchant sub-field is invalid.
401Invalid or missing Basic Auth credentials.
403User does not have permission to update this merchant application.
404No merchant application found with the given ID.
500Internal server error.

Common Mistakes

  • Providing the merchant object but omitting its required fields (cashDiscount, agentProfileId, pos) will cause a 400 error.
  • Setting pos to a value not in the allowed enum list returns a validation error.
  • Attempting to change the agentProfileId to one that does not exist or belongs to a different ISO will be rejected.
  • This is a v1 deprecated endpoint — prefer the v2 merchant info endpoint for new integrations.

Related Endpoints

  • POST /api/v1/merchant/parameters — Update business and owner information.
  • POST /api/v1/merchant/account — Update the sales and business profile.
  • POST /api/v1/merchant/fees — Update the fee structure.

Example

curl -X POST https://hq.staging.netevia.dev/api/v1/merchant/info \
  -H "Authorization: Basic $(echo -n 'username:password' | base64)" \
  -H "Content-Type: application/json" \
  -d '{
    "id": 10482,
    "merchant": {
      "cashDiscount": "No",
      "agentProfileId": 201,
      "pos": "Clover",
      "boardingSettingsId": 15
    }
  }'
Body Params
merchant
object
int32
required
1 to 999999
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
string
enum
Defaults to application/json

Generated from available request content types

Allowed:
Response

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
text/json