Merchants

A merchant is a business you onboard under your organization. Every payment-facing resource in Tokeflow — customers, transactions, orders, catalog, connectors — belongs to exactly one merchant, so the merchant is the unit of isolation for data, routing configuration, and API key scoping.

This page covers the organization-level merchant surface: listing and onboarding merchants, updating their details, retiring them, reading their activity trail, and managing the members (dashboard users) of each merchant. Creating a merchant also provisions its first owner: you supply a primary_email, and Tokeflow sends that person an invitation to the merchant dashboard.

Merchant lifecycle

Two moments in the lifecycle deserve attention. First, once a merchant is enrolled with the card networks (for network token provisioning), the fields sent at enrollment — name, website, mcc, and the address — are fixed at the networks and can no longer be changed through PATCH. Second, deletion is reserved for merchants created in error: a merchant with any activity is kept for reporting and reconciliation, and DELETE refuses it with 409. Deactivate it instead.

The merchant object

Merchant status

The address object

The member object

Members are the users of a merchant's dashboard. A member is a membership: the link between a user identity (unique by email within your organization) and one merchant, with a role. The same person can hold memberships on several merchants.

Endpoints

GET/api/v1/merchants

Returns a paginated list of the merchants belonging to the authenticated organization. Supports filtering by status.

Query parameters

Example request

curl -G https://api.tokeflow.com/api/v1/merchants \
  -H "Authorization: Bearer sk_live_org_…" \
  --data-urlencode "status=active" \
  --data-urlencode "page=1" \
  --data-urlencode "limit=20"

Example response — 200 OK

{
  "data": [
    {
      "id": "mrc_123",
      "organization_id": "org_123",
      "name": "John's Store",
      "slug": "johns-store",
      "external_reference": "internal_id_99",
      "business_registration_number": "12345678000199",
      "mcc": "5732",
      "phone_number": "+5511999990000",
      "address": {
        "line_1": "Av Paulista, 1000",
        "line_2": "Conj 42",
        "zip_code": "01310-100",
        "city": "São Paulo",
        "state": "SP",
        "country": "BR"
      },
      "website": "https://johnsstore.com.br",
      "status": "active",
      "created_at": "2025-01-15T10:30:00Z",
      "updated_at": "2025-11-28T12:10:00Z"
    }
  ],
  "meta": {
    "pagination": {
      "page": 1,
      "limit": 20,
      "total": 6,
      "total_pages": 1,
      "has_next": false,
      "has_prev": false
    }
  }
}

See Pagination & filtering for how to iterate every page.

POST/api/v1/merchants

Onboards a new merchant under your organization. The merchant is created in active status, and the person at primary_email becomes its first owner: if a user with that email already exists in your organization, they gain a membership on the new merchant; otherwise an identity is provisioned and an invitation email is sent so they can set a password. Emails are matched case-insensitively.

Request fields

Example request

curl -X POST https://api.tokeflow.com/api/v1/merchants \
  -H "Authorization: Bearer sk_live_org_…" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "John'\''s Store",
    "primary_email": "owner@johnsstore.com",
    "primary_name": "John Smith",
    "external_reference": "internal_id_99",
    "business_registration_number": "12345678000199",
    "mcc": "5732",
    "website": "https://johnsstore.com.br",
    "phone_number": "+55 11 99999-0000",
    "address": {
      "line_1": "Av Paulista, 1000",
      "zip_code": "01310-100",
      "city": "São Paulo",
      "state": "SP",
      "country": "BR"
    }
  }'

Example response — 201 Created

{
  "id": "mrc_123",
  "organization_id": "org_123",
  "name": "John's Store",
  "slug": "johns-store",
  "external_reference": "internal_id_99",
  "status": "active",
  "created_at": "2025-11-28T12:10:00Z"
}

GET/api/v1/merchants/:id

Retrieves a single merchant belonging to the authenticated organization. Returns the full merchant object.

Example request

curl https://api.tokeflow.com/api/v1/merchants/mrc_123 \
  -H "Authorization: Bearer sk_live_org_…"

Example response — 200 OK

{
  "id": "mrc_123",
  "organization_id": "org_123",
  "name": "John's Store",
  "slug": "johns-store",
  "external_reference": "internal_id_99",
  "business_registration_number": "12345678000199",
  "mcc": "5732",
  "phone_number": "+5511999990000",
  "address": {
    "line_1": "Av Paulista, 1000",
    "line_2": "Conj 42",
    "zip_code": "01310-100",
    "city": "São Paulo",
    "state": "SP",
    "country": "BR"
  },
  "website": "https://johnsstore.com.br",
  "status": "active",
  "created_at": "2025-01-15T10:30:00Z",
  "updated_at": "2025-01-15T10:30:00Z"
}

A 404 (not_found_error) is returned if the merchant does not exist or does not belong to the authenticated organization.

PATCH/api/v1/merchants/:id

Updates a merchant. All body fields are optional; only the fields you send are changed.

Once the merchant is enrolled with the card networks, the fields sent at enrollment — name, website, mcc, and the address — are fixed at the networks and can no longer be changed; attempting to returns 409 (conflict_error). status, phone_number, business_registration_number, and external_reference remain editable for the merchant's whole life.

Request fields

Example request — deactivate a merchant

curl -X PATCH https://api.tokeflow.com/api/v1/merchants/mrc_123 \
  -H "Authorization: Bearer sk_live_org_…" \
  -H "Content-Type: application/json" \
  -d '{ "status": "inactive" }'

Example response — 200 OK

{
  "id": "mrc_123",
  "organization_id": "org_123",
  "name": "John's Store",
  "slug": "johns-store",
  "external_reference": "internal_id_99",
  "business_registration_number": "12345678000199",
  "mcc": "5732",
  "phone_number": "+5511999990000",
  "address": {
    "line_1": "Av Paulista, 1000",
    "line_2": "Conj 42",
    "zip_code": "01310-100",
    "city": "São Paulo",
    "state": "SP",
    "country": "BR"
  },
  "website": "https://johnsstore.com.br",
  "status": "inactive",
  "created_at": "2025-01-15T10:30:00Z",
  "updated_at": "2025-11-28T14:00:00Z"
}

DELETE/api/v1/merchants/:id

Permanently deletes a merchant that has never been used — no transactions, orders, customers, catalog, saved payment methods, live API keys, or card-network enrollment. Anything else is refused with 409, because merchants with activity are kept for reporting and reconciliation.

This endpoint exists for a merchant created in error — expect refusal to be the common outcome. To retire a merchant that has history, set its status to inactive with PATCH instead.

Example request

curl -X DELETE https://api.tokeflow.com/api/v1/merchants/mrc_123 \
  -H "Authorization: Bearer sk_live_org_…"

Response codes

GET/api/v1/merchants/:id/activity

Retrieves the paginated activity trail for a merchant belonging to the authenticated organization. Each record describes an administrative action taken on the merchant — what changed, by whom, and when — which makes this the audit companion to the endpoints above.

Query parameters

Example request

curl -G https://api.tokeflow.com/api/v1/merchants/mrc_123/activity \
  -H "Authorization: Bearer sk_live_org_…" \
  --data-urlencode "page=1" \
  --data-urlencode "limit=20"

Returns 200 OK with a paginated list of activity records, or 404 if the merchant does not exist or does not belong to your organization.

GET/api/v1/merchants/:merchant_id/members

Lists the users scoped to a specific merchant. Returns a paginated array of member objects, including pending invitations.

Query parameters

Example request

curl -G https://api.tokeflow.com/api/v1/merchants/mrc_123/members \
  -H "Authorization: Bearer sk_live_org_…" \
  --data-urlencode "page=1" \
  --data-urlencode "limit=20"

Example response — 200 OK

{
  "data": [
    {
      "membership_id": "mum_5e8d21",
      "user_id": "usr_3c9f10",
      "email": "owner@johnsstore.com",
      "name": "John Smith",
      "role": "owner",
      "joined_at": "2025-11-28T12:10:00Z",
      "status": "active",
      "invitation_expires_at": null
    },
    {
      "membership_id": "mum_7a4b90",
      "user_id": "usr_b81c22",
      "email": "team@johnsstore.com",
      "name": "team@johnsstore.com",
      "role": "admin",
      "joined_at": "2025-12-01T09:00:00Z",
      "status": "pending",
      "invitation_expires_at": "2025-12-08T09:00:00Z"
    }
  ],
  "meta": {
    "pagination": {
      "page": 1,
      "limit": 20,
      "total": 2,
      "total_pages": 1,
      "has_next": false,
      "has_prev": false
    }
  }
}

POST/api/v1/merchants/:merchant_id/members

Invites a user to a merchant by email. Tokeflow finds or creates the user identity within your organization and adds a membership on the merchant with the given role, then sends an invitation email so the recipient can set a password. If the person already has an identity in your organization (from another merchant, for example), that identity is reused — the email address is the identity.

Request fields

Example request

curl -X POST https://api.tokeflow.com/api/v1/merchants/mrc_123/members \
  -H "Authorization: Bearer sk_live_org_…" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "team@johnsstore.com",
    "name": "Store Team",
    "role": "admin"
  }'

Example response — 201 Created

{
  "membership_id": "mum_7a4b90",
  "user_id": "usr_b81c22",
  "email": "team@johnsstore.com",
  "name": "Store Team",
  "role": "admin",
  "joined_at": "2025-12-01T09:00:00Z",
  "status": "pending",
  "invitation_expires_at": "2025-12-08T09:00:00Z"
}

The member stays pending until the invitation is accepted. If it expires first, resend it.

PATCH/api/v1/merchants/:merchant_id/members/:membership_id

Updates the role of a user within a merchant.

Request fields

Example request

curl -X PATCH https://api.tokeflow.com/api/v1/merchants/mrc_123/members/mum_7a4b90 \
  -H "Authorization: Bearer sk_live_org_…" \
  -H "Content-Type: application/json" \
  -d '{ "role": "viewer" }'

Returns 204 No Content on success. No response body.

DELETE/api/v1/merchants/:merchant_id/members/:membership_id

Removes a user from a merchant. Only the membership is removed — the underlying user identity keeps any memberships it holds on other merchants in your organization.

Example request

curl -X DELETE https://api.tokeflow.com/api/v1/merchants/mrc_123/members/mum_7a4b90 \
  -H "Authorization: Bearer sk_live_org_…"

Returns 204 No Content on success. No response body.

POST/api/v1/merchants/:merchant_id/members/:membership_id/resend

Resends a pending merchant invitation. The invitation token and its expiry are rotated — the old email link stops working — and the invitation email is sent again. Returns 409 (conflict_error) if the user has already accepted.

Example request

curl -X POST https://api.tokeflow.com/api/v1/merchants/mrc_123/members/mum_7a4b90/resend \
  -H "Authorization: Bearer sk_live_org_…"

Example response — 200 OK

{
  "membership_id": "mum_7a4b90",
  "user_id": "usr_b81c22",
  "email": "team@johnsstore.com",
  "name": "Store Team",
  "role": "admin",
  "joined_at": "2025-12-01T09:00:00Z",
  "status": "pending",
  "invitation_expires_at": "2025-12-15T10:00:00Z"
}

Note the refreshed invitation_expires_at — the countdown restarts from the resend.

Errors

Every error uses the standard envelope. The most common cases for this resource:

See Errors for the full envelope and type catalog.

Related

• Authentication — Organization vs. Merchant keys and scopes.
• Pagination & filtering — iterate list endpoints safely.
• Customers — buyer records scoped to a merchant.
• Transactions — charges processed on behalf of a merchant.