Update a Merchant

Overview

Update Merchant settings and features including Level 2/3 data processing, partial authorizations, buyer charges, and settlement queue mode. You can also terminate a Merchant account using this endpoint.

Resource Access

• User Permissions: Admin users only
• Endpoint: PUT /merchants/\{merchant_id}

Arguments

Parameter	Type	Required	Description
merchant_id	string	Yes	The unique ID of the Merchant to update
processing_enabled	boolean	No	Enable or disable payment processing
settlement_enabled	boolean	No	Enable or disable settlements
convenience_charges_enabled	boolean	No	Enable buyer charges (convenience fees/surcharges)
level_two_level_three_data_enabled	boolean	No	Enable Level 2/3 data processing for B2B/B2G transactions
loan_repayment	boolean	No	Enable loan repayment functionality
default_partial_authorization_enabled	boolean	No	Enable partial authorizations by default
settlement_queue_mode	string	No	Control settlement queueing (UNSET or MANUAL)
is_terminated	boolean	No	Terminate the Merchant account
termination_details	object	No	Details about the termination (reason and description)
disbursements_same_day_ach_pull_enabled	boolean	No	Enable Same-Day ACH pull disbursements
disbursements_same_day_ach_push_enabled	boolean	No	Enable Same-Day ACH push disbursements

Example Request

curl -X PUT \
  'https://api.ahrvo.network/payments/na/merchants/MUmerchantExample123' \
  -u username:password \
  -H 'Content-Type: application/json' \
  -d '{
    "level_two_level_three_data_enabled": true,
    "convenience_charges_enabled": true,
    "settlement_queue_mode": "MANUAL",
    "disbursements_same_day_ach_push_enabled": true
  }'

Example Response

{
  "id": "MUmerchantExample123",
  "created_at": "2023-06-15T10:30:00Z",
  "updated_at": "2023-09-20T14:45:30Z",
  "application": "APapplicationExample123",
  "identity": "IDentityExample123",
  "processor": "DUMMY_V1",
  "gateway": "DATACAP_V1",
  "mid": "987654321",
  "merchant_name": "Acme Retail Store",
  "mcc": "5411",
  "country": "USA",
  "currencies": ["USD"],
  "onboarding_state": "APPROVED",
  "processing_enabled": true,
  "settlement_enabled": true,
  "is_terminated": false,
  "loan_repayment": false,
  "level_two_level_three_data_enabled": true,
  "convenience_charges_enabled": true,
  "settlement_queue_mode": "MANUAL",
  "tags": {
    "business_type": "retail"
  },
  "termination_details": null,
  "_links": {
    "self": {
      "href": "https://api.ahrvo.network/payments/na/merchants/MUmerchantExample123"
    }
  }
}

Termination Example

curl -X PUT \
  'https://api.ahrvo.network/payments/na/merchants/MUmerchantExample123' \
  -u username:password \
  -H 'Content-Type: application/json' \
  -d '{
    "is_terminated": true,
    "termination_details": {
      "reason": "CHURNED",
      "description": "Merchant has moved to another payment provider"
    }
  }'

Additional Information

• Level 2/3 Data: When enabled, allows submission of enhanced transaction data for lower interchange rates on B2B and B2G transactions
• Convenience Charges: Enables adding surcharges or convenience fees to transactions (must comply with card network and state regulations)
• Settlement Queue Mode:
  • UNSET: Automatic settlement queueing based on payout profile
  • MANUAL: Settlements must be manually queued
• Partial Authorizations: When enabled, allows transactions to be approved for amounts less than requested (useful for prepaid cards)
• Same-Day ACH: Enables faster disbursements through same-day ACH processing
• Termination Reasons:
  • FRAUD: Fraudulent activity detected
  • COMPLIANCE: Compliance violations
  • CHURNED: Merchant left for another provider
  • EXCESSIVE_CHARGEBACKS: Too many chargebacks
• Immediate Effect: Most settings take effect immediately for new transactions
• Permanent Action: Terminating a Merchant account is permanent and cannot be reversed