Upsert merchant | Welcome to cash-app Documentation

curl -X PUT https://api.cash.app/network/v1/merchants \
     -H "Content-Type: application/json" \
     -d '{
  "merchant": {
    "name": "merchant name",
    "brand_id": "brand ID",
    "country": "US",
    "currency": "USD",
    "category": "5432",
    "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": "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"
    }
  }
}'

{
  "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"
    }
  }
}

Creates or updates a merchant based on the merchant’s reference_id.

If a merchant with a matching reference_id is found, it will be updated. If no matching merchant is found, a new one will be created.

The HTTP response code (200 OK or 201 Created) indicates whether the resource was updated or created, respectively.

merchant_id is the primary unique identifier for all Merchant APIs. Be cautious when using reference_id as a unique identifier.

Merchants must have an address or site_url set.

This endpoint is not rate limited.

Scopes: MERCHANTS_WRITE

Request

This endpoint expects an object.

merchantobjectRequired

Details about the merchant to create or update.

Response

merchantobject

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

Upsert Merchant Request Bad Request Error

Headers

Request

Response

Errors