fluxa

Account

The account endpoint returns your own merchant profile — useful to confirm which key you're authenticated as and to read your settlement, fee and webhook configuration.

The merchant model

Sensitive material (password hash, encrypted secrets) is never returned.

  • Name
    id
    Type
    string
    Description

    Your merchant id, prefixed mch_.

  • Name
    name
    Type
    string
    Description

    Your account name.

  • Name
    email
    Type
    string
    Description

    Account email.

  • Name
    status
    Type
    string
    Description

    active, suspended, pending, or rejected.

  • Name
    webhook_url
    Type
    string
    Description

    Your configured webhook endpoint, or empty.

  • Name
    webhook_events
    Type
    string
    Description

    Comma-separated event subscription. Empty means all events.

  • Name
    email_on_payment
    Type
    boolean
    Description

    Whether a "payment received" email is sent on payment.succeeded.

  • Name
    slug
    Type
    string
    Description

    Your tenant subdomain slug, or empty.

  • Name
    custom_domain
    Type
    string
    Description

    A bound custom domain, or empty.

  • Name
    settlement_address
    Type
    string
    Description

    Your EVM (0x) settlement address for non-custodial on-chain settlement.

  • Name
    settlement_addresses
    Type
    object
    Description

    Per-chain-kind settlement addresses, keyed by evm / tron.

  • Name
    fee_override
    Type
    boolean
    Description

    Whether fee_percent/fee_fixed override the channel-level fee.

  • Name
    fee_percent
    Type
    string
    Description

    Your negotiated percentage fee, as a fraction (0.01 = 1%).

  • Name
    fee_fixed
    Type
    string
    Description

    Your fixed per-transaction fee.

  • Name
    min_payout
    Type
    string
    Description

    Minimum single-payout amount, applicable only to custodial balances (operator-internal). Under non-custodial direct settlement your funds settle on-chain straight to your own settlement_address, so there is no payout step and this field is effectively unused — typically 0.

  • Name
    totp_enabled
    Type
    boolean
    Description

    Whether portal two-factor auth is enabled.

  • Name
    kyc_status
    Type
    string
    Description

    Your identity-verification state.

  • Name
    created_at
    Type
    timestamp
    Description

    When the account was created.

GET/api/v1/me

Get your account

Signed locally — your secret stays in this browser and is never sent or stored.

No keys yet? Create an API key pair in the merchant portal — the secret is shown only once. Open the merchant portal →

Return the merchant account the request is authenticated as.

Request

GET
/api/v1/me
curl "$BASE/api/v1/me" \
  -H "X-Api-Key: $KEY_ID" \
  -H "X-Timestamp: $TS" \
  -H "X-Signature: $SIG"

Response

{
  "id": "mch_7Q2m",
  "name": "Acme Inc.",
  "email": "ops@acme.example",
  "status": "active",
  "webhook_url": "https://acme.example/webhooks/fluxa",
  "webhook_events": "",
  "email_on_payment": true,
  "slug": "acme",
  "settlement_address": "0xYourAddress",
  "settlement_addresses": { "evm": "0xYourAddress" },
  "fee_override": false,
  "min_payout": "0",
  "totp_enabled": true,
  "kyc_status": "approved",
  "created_at": "2026-01-04T12:00:00Z"
}