Update merchant | Welcome to cash-app Documentation

curl -X PATCH https://api.cash.app/network/v1/merchants/MMI_4vxs5egfk7hmta3qx2h6rp91x \
     -H "Content-Type: application/json" \
     -d '{
  "merchant": {
    "brand_id": "brand ID",
    "category": "5432",
    "country": "US",
    "currency": "USD",
    "name": "merchant name",
    "reference_id": "reference ID",
    "address": {
      "country": "US",
      "address_line_1": "1215 4th Ave",
      "address_line_2": "Suite 2300",
      "locality": "Seattle",
      "postal_code": "98161-1001",
      "administrative_district_level_1": "Washington"
    },
    "site_url": "https://example.com",
    "status": "ACTIVE",
    "metadata": {
      "key": "value"
    },
    "default_fee_plans": {
      "in_app_fee_plan_id": "FEE_kewjsmjt35t8qhzyjeqcst5me",
      "in_person_fee_plan_id": "FEE_kewjsmjt35t8qhzyjeqcst5me",
      "online_fee_plan_id": "FEE_kewjsmjt35t8qhzyjeqcst5me"
    }
  }
}'

{
  "merchant": {
    "id": "MMI_4vxs5egfk7hmta3qx2h6rp91x",
    "brand_id": "BRAND_8ereg0tug2yiik8vx24xpe5br",
    "name": "Example Business Name",
    "country": "US",
    "currency": "USD",
    "category": "5432",
    "reference_id": "external-id",
    "status": "ACTIVE",
    "created_at": "2022-01-01T12:00:00Z",
    "updated_at": "2022-01-05T12:00:00Z",
    "address": {
      "country": "US",
      "address_line_1": "1215 4th Ave",
      "address_line_2": "Suite 2300",
      "locality": "Seattle",
      "postal_code": "98161-1001",
      "administrative_district_level_1": "Washington"
    },
    "site_url": "http://example.com",
    "metadata": {
      "key": "value"
    },
    "default_fee_plans": {
      "in_app_fee_plan_id": "FEE_kewjsmjt35t8qhzyjeqcst5me",
      "in_person_fee_plan_id": "FEE_kewjsmjt35t8qhzyjeqcst5me",
      "online_fee_plan_id": "FEE_kewjsmjt35t8qhzyjeqcst5me"
    }
  }
}

Updates a merchant matching the provided merchant_id with the given attributes.

To clear a field, set it to null. Fields that are not provided in the request will not be changed.

This endpoint is not rate limited.

Scopes: MERCHANTS_WRITE

Path parameters

merchant_idstringRequired

ID of the merchant.

Request

This endpoint expects an object.

merchantobjectRequired

Details about the merchant to update.

Response

merchantobjectOptional

A merchant represents a depository account when processing payments from Cash App customers. Merchants do not have direct access to Cash App, so processed payments are stored in this account until they are ready for settlement.

Errors

400

Update Merchant Request Bad Request Error

Path parameters

Headers

Request

Response

Errors