Get Profile

GET /merchant/get

Get Profile

cURL

curl --request GET \
  --url https://api.unibee.dev/merchant/get \
  --header 'Authorization: Bearer <token>'

200

{
  "code": 123,
  "data": {
    "Currency": [
      {
        "Currency": "<string>",
        "Scale": 123,
        "Symbol": "<string>"
      }
    ],
    "MemberRoles": [
      {
        "createTime": 123,
        "id": 123,
        "merchantId": 123,
        "permissions": [
          {
            "group": "<string>",
            "permissions": [
              "<string>"
            ]
          }
        ],
        "role": "<string>"
      }
    ],
    "TimeZone": [
      "<string>"
    ],
    "analyticsHost": "<string>",
    "cloudFeatureAnalyticsEnabled": true,
    "cname": "<string>",
    "cnameDomain": "<string>",
    "defaultCurrency": "<string>",
    "defaultEmailGateway": "<string>",
    "emailGateways": {},
    "emailSender": {
      "address": "<string>",
      "name": "<string>"
    },
    "env": "<string>",
    "exchangeRateApiKey": "<string>",
    "gateways": [
      {
        "IsSetupFinished": true,
        "archive": true,
        "autoChargeEnabled": true,
        "bank": {
          "accountHolder": "<string>",
          "address": "<string>",
          "ABARoutingNumber": "<string>",
          "CNAPS": "<string>",
          "Remarks": "<string>",
          "accountNumber": "<string>",
          "bankName": "<string>",
          "bic": "<string>",
          "bsbCode": "<string>",
          "iban": "<string>",
          "swiftCode": "<string>"
        },
        "companyIssuer": {
          "issueAddress": "<string>",
          "issueCompanyName": "<string>",
          "issueLogo": "<string>",
          "issueRegNumber": "<string>",
          "issueVatNumber": "<string>"
        },
        "countryConfig": {},
        "createTime": 123,
        "currency": "<string>",
        "currencyExchange": [
          {
            "exchange_rate": 123,
            "from_currency": "<string>",
            "to_currency": "<string>"
          }
        ],
        "currencyExchangeEnabled": true,
        "defaultGatewayPaymentType": {
          "autoCharge": true,
          "category": "<string>",
          "countryName": "<string>",
          "name": "<string>",
          "paymentType": "<string>",
          "supportCurrencies": [
            "<string>"
          ]
        },
        "description": "<string>",
        "displayName": "<string>",
        "gatewayIcons": [
          "<string>"
        ],
        "gatewayId": 123,
        "gatewayKey": "<string>",
        "gatewayLogo": "<string>",
        "gatewayName": "<string>",
        "gatewayPaymentTypes": [
          {
            "autoCharge": true,
            "category": "<string>",
            "countryName": "<string>",
            "name": "<string>",
            "paymentType": "<string>",
            "supportCurrencies": [
              "<string>"
            ]
          }
        ],
        "gatewaySecret": "<string>",
        "gatewayType": 123,
        "gatewayWebhookIntegrationLink": "<string>",
        "gatewayWebsiteLink": "<string>",
        "isDefault": true,
        "metadata": {},
        "minimumAmount": 123,
        "name": "<string>",
        "privateSecretName": "<string>",
        "publicKeyName": "<string>",
        "setupGatewayPaymentTypes": [
          {
            "autoCharge": true,
            "category": "<string>",
            "countryName": "<string>",
            "name": "<string>",
            "paymentType": "<string>",
            "supportCurrencies": [
              "<string>"
            ]
          }
        ],
        "sort": 123,
        "subGateway": "<string>",
        "subGatewayName": "<string>",
        "webhookEndpointUrl": "<string>",
        "webhookSecret": "<string>"
      }
    ],
    "globalTOPTEnabled": true,
    "globalUSVATConfig": {
      "active": true,
      "availableGatewayNames": [
        "<string>"
      ],
      "checkAddressViaGateway": true,
      "defaultGatewayName": "<string>",
      "fromAddress": {
        "address": "<string>",
        "city": "<string>",
        "countryCode": "<string>",
        "state": "<string>",
        "verified": true,
        "zipCode": "<string>"
      },
      "nexusAddresses": [
        {
          "address": "<string>",
          "city": "<string>",
          "countryCode": "<string>",
          "state": "<string>",
          "verified": true,
          "zipCode": "<string>"
        }
      ],
      "taxCode": "<string>",
      "toAddress": {
        "address": "<string>",
        "city": "<string>",
        "countryCode": "<string>",
        "state": "<string>",
        "verified": true,
        "zipCode": "<string>"
      },
      "uploadInvoiceToGateway": true
    },
    "isOwner": true,
    "isProd": true,
    "merchant": {
      "address": "<string>",
      "companyLogo": "<string>",
      "companyName": "<string>",
      "companyRegistryCode": "<string>",
      "companyVatNumber": "<string>",
      "countryCode": "<string>",
      "countryName": "<string>",
      "createTime": 123,
      "email": "<string>",
      "homeUrl": "<string>",
      "host": "<string>",
      "id": 123,
      "location": "<string>",
      "name": "<string>",
      "phone": "<string>",
      "timeZone": "<string>",
      "type": 123,
      "userId": 123
    },
    "merchantMember": {
      "MemberGroupPermission": {},
      "MemberRoles": [
        {
          "createTime": 123,
          "id": 123,
          "merchantId": 123,
          "permissions": [
            {
              "group": "<string>",
              "permissions": [
                "<string>"
              ]
            }
          ],
          "role": "<string>"
        }
      ],
      "createTime": 123,
      "currentDeviceIdentity": "<string>",
      "deviceList": [
        {
          "currentDevice": true,
          "identity": "<string>",
          "ipAddress": "<string>",
          "lastActiveTime": 123,
          "lastLoginTime": 123,
          "lastTotpVerificationTime": 123,
          "name": "<string>",
          "status": true
        }
      ],
      "email": "<string>",
      "firstName": "<string>",
      "id": 123,
      "isBlankPasswd": true,
      "isOwner": true,
      "lastName": "<string>",
      "merchantId": 123,
      "mobile": "<string>",
      "oauthAccounts": [
        {
          "email": "<string>",
          "emailVerified": true,
          "image": "<string>",
          "name": "<string>",
          "provider": "<string>",
          "providerId": "<string>"
        }
      ],
      "status": 123,
      "totpType": 123
    },
    "multiCurrencyConfigs": [
      {
        "currencyConfigs": [
          {
            "autoExchange": true,
            "currency": "<string>",
            "exchangeRate": 123
          }
        ],
        "defaultCurrency": "<string>",
        "lastUpdateTime": 123,
        "name": "<string>"
      }
    ],
    "openApiHost": "<string>",
    "openApiKey": "<string>",
    "quickBooksCompanyName": "<string>",
    "quickBooksLastSyncError": "<string>",
    "quickBooksLastSynchronized": "<string>",
    "segmentServerSideKey": "<string>",
    "segmentUserPortalKey": "<string>",
    "sendGridKey": "<string>",
    "taxJarApiKeys": {
      "apiKey": "<string>",
      "apiSecret": "<string>"
    },
    "vatSenseKey": "<string>"
  },
  "merchantId": 123,
  "message": "<string>",
  "redirect": "<string>",
  "requestId": "<string>"
}

Endpoint Overview

GET https://api.unibee.dev/merchant/get

Get Profile

---

Authorization

All UniBee Merchant API requests require authentication via API key.

Header	Required	Description
Authorization	Yes	Bearer <your_api_key>
Content-Type	Yes	application/json (for request body)

---

Parameters

Path, query, and request body parameters are defined in the schema below. Use the interactive Try it panel to see the full request structure.

Path, query, and request body parameters are defined in the schema below. Use the interactive Try it panel to see the full request structure.

---

Request examples

cURL

curl -X GET "https://api.unibee.dev/merchant/get" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

Sandbox

curl -X GET "https://api-sandbox.unibee.top/merchant/get" \
  -H "Authorization: Bearer YOUR_SANDBOX_API_KEY" \
  -H "Content-Type: application/json"

---

Response

Success responses return a JSON envelope with code, data, message, redirect, and requestId. code 0 indicates success.

Field	Type	Description
code	integer	Response code. 0 = success
data	object	Response payload
data.Currency	array	Currency List
data.MemberRoles	array	The member role list’
data.TimeZone	array	TimeZone List
data.analyticsHost	string	Analytics Host
data.cloudFeatureAnalyticsEnabled	boolean	Analytics Feature Enabled For Cloud Version
data.cname	string	CNAME value for merchant to configure
data.cnameDomain	string	Merchant CNAME Domain
data.defaultCurrency	string	Default Currency
data.defaultEmailGateway	string	Default Email Gateway
data.emailGateways	object	Email Gateway Map
data.emailSender	object
data.env	string	System Env, em: daily|stage|local|prod
data.exchangeRateApiKey	string	ExchangeRateApiKey
data.gateways	array	Gateway List
data.globalTOPTEnabled	boolean	GlobalTOPTEnabled
data.globalUSVATConfig	object
data.isOwner	boolean	Check Member is Owner
data.isProd	boolean	Check System Env Is Prod, true|false
data.merchant	object
data.merchantMember	object
data.multiCurrencyConfigs	array	Merchant’s MultiCurrency Configs
data.openApiHost	string	OpenApi Host
data.openApiKey	string	OpenAPIKey
data.quickBooksCompanyName	string	QuickBooksCompanyName
data.quickBooksLastSyncError	string	QuickBooksLastSyncError
data.quickBooksLastSynchronized	string	QuickBooksLastSynchronized
data.segmentServerSideKey	string	SegmentServerSideKey
data.segmentUserPortalKey	string	SegmentUserPortalKey
data.sendGridKey	string	SendGridKey
data.taxJarApiKeys	object
data.vatSenseKey	string	VatSenseKey
message	string	Human-readable message
requestId	string	Request ID for support

---

Error handling

HTTP status	Meaning
400	Bad request — invalid or missing parameters. Check message in the body.
401	Unauthorized — missing or invalid API key.
404	Not found — invalid path or resource.
500	Server error — retry with backoff.

When code in the response body is non-zero, check message for details. Use requestId when contacting support.

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

200 - application/json

code · integer<int>

data · object

Show child attributes

merchantId · integer<int64>

message · string<string>

redirect · string<string>

requestId · string<string>