Get Merchant Profile — GET /api/merchant/me

The profile endpoint returns the currently authenticated merchant’s account details, wallet configuration, aggregate payment statistics, and a list of recent payments. Use it to render the merchant dashboard, show wallet status, and surface a masked API key hint.

Endpoint

GET https://flarehq.xyz/api/merchant/me

Request

Headers

Header	Value
`Cookie`	`merchant_token=...` — required

This is a browser/dashboard route. Authentication comes from the merchant_token cookie set at login; the browser sends it automatically. An x-api-key header is not accepted here.

Response

boolean

true on a successful profile fetch.

object

The authenticated merchant’s profile.

Show merchant fields

string

Unique merchant identifier.

string

The merchant’s email address.

string

The merchant’s registered display name.

string

ISO timestamp of account creation.

string

Payout wallet provider, e.g. "CIRCLE" or an external kind.

string

The configured payout wallet address.

string

The first 16 characters of the API key followed by ... — e.g. "arc_live_1a2b3c4d...". The full key is never returned.

object

Payment aggregates computed from the merchant’s payment log.

Show stats fields

number

Total number of payments matched to this merchant (capped at the 50 most recent).

number

Count of payments with status "SUCCESS".

number

Sum of amount across successful payments, rounded to 4 decimal places.

number

Percentage of successful payments, rounded to 1 decimal place. 0 when there are no payments.

array

The 20 most recent payments, newest first.

Show recentPayments fields

string

Unique payment reference (e.g. arc_ref_...).

number

Payment amount.

string

Currency code, e.g. "USDC".

string

Payment status, e.g. "SUCCESS" / "FAILED" / "PENDING".

string

ISO timestamp of the payment.

string

Hosted checkout URL for this payment, e.g. https://flarehq.xyz/checkout/{reference}.

Examples

curl https://flarehq.xyz/api/merchant/me \
  -b cookies.txt

const res = await fetch('https://flarehq.xyz/api/merchant/me', {
  credentials: 'include', // sends the merchant_token cookie
});

const { success, merchant, stats, recentPayments } = await res.json();

Success Response

{
  "success": true,
  "merchant": {
    "id": "8f2c9a41-9d07-4c3e-b2a6-5f1e0c8b7d99",
    "email": "merchant@example.com",
    "businessName": "Acme Store",
    "createdAt": "2026-08-16T10:00:00.000Z",
    "walletProvider": "CIRCLE",
    "walletAddress": "0x4a2F1b9c7dE03A6b8C5f2e9D1a4c7B6e3F9d2A8",
    "apiKeyHint": "arc_live_1a2b3c4d..."
  },
  "stats": {
    "totalPayments": 12,
    "successfulPayments": 10,
    "totalVolume": 2540.5,
    "successRate": 83.3
  },
  "recentPayments": [
    {
      "reference": "arc_ref_k7x2m9lp4d8f1q2z",
      "amount": 25,
      "currency": "USDC",
      "status": "SUCCESS",
      "timestamp": "2026-08-16T09:30:00.000Z",
      "checkoutUrl": "https://flarehq.xyz/checkout/arc_ref_k7x2m9lp4d8f1q2z"
    }
  ]
}

Error Responses

{
  "success": false,
  "error": "Not authenticated."
}

{
  "success": false,
  "error": "Merchant not found."
}

{
  "success": false,
  "error": "Invalid session."
}

Notes

The same path also hosts the logout endpoint: DELETE /api/merchant/me clears the merchant_token cookie. See Login.

The full API key is intentionally never returned here. If you lost your key, generate a replacement from the dashboard — the masked apiKeyHint is only for display, not recovery.

Overview

Payments

Escrow

Streaming

CCTP Bridge

Checkout

x402

Agents

Jobs

Merchant

Consumer

Payroll

Get Merchant Profile — GET /api/merchant/me

Endpoint

Request

Headers

Response

Examples

Success Response

Error Responses

Notes

​Endpoint

​Request

​Headers

​Response

​Examples

​Success Response

​Error Responses

​Notes

Endpoint

Request

Headers

Response

Examples

Success Response

Error Responses

Notes