> ## Documentation Index > Fetch the complete documentation index at: https://docs.unibee.dev/llms.txt > Use this file to discover all available pages before exploring further. # Get Profile ## 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 `` | | `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 ```bash theme={null} curl -X GET "https://api.unibee.dev/merchant/get" \ -H "Authorization: Bearer YOUR_API_KEY" \ -H "Content-Type: application/json" ``` ### Sandbox ```bash theme={null} 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. ## OpenAPI ````yaml get /merchant/get openapi: 3.0.0 info: description: UniBee Api Server license: name: Apache-2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html title: OpenAPI UniBee version: daily,buildtime:202603161017 servers: - url: https://api.unibee.dev - url: https://api-sandbox.unibee.top security: - Authorization: [] paths: /merchant/get: get: tags: - Merchant summary: Get Profile responses: '200': content: application/json: schema: properties: code: format: int properties: {} type: integer data: properties: Currency: description: Currency List format: '[]*bean.Currency' items: $ref: '#/components/schemas/unibee.api.bean.Currency' properties: {} type: array MemberRoles: description: The member role list' format: '[]*bean.MerchantRole' items: $ref: '#/components/schemas/unibee.api.bean.MerchantRole' properties: {} type: array TimeZone: description: TimeZone List format: '[]string' items: format: string properties: {} type: string properties: {} type: array analyticsHost: description: Analytics Host format: string properties: {} type: string cloudFeatureAnalyticsEnabled: description: Analytics Feature Enabled For Cloud Version format: bool properties: {} type: boolean cname: description: CNAME value for merchant to configure format: string properties: {} type: string cnameDomain: description: Merchant CNAME Domain format: string properties: {} type: string defaultCurrency: description: Default Currency format: string properties: {} type: string defaultEmailGateway: description: Default Email Gateway format: string properties: {} type: string emailGateways: additionalProperties: $ref: >- #/components/schemas/unibee.api.bean.EmailGatewayConnectionAPIKeys description: Email Gateway Map format: map[string]*bean.EmailGatewayConnectionAPIKeys properties: {} type: object emailSender: $ref: '#/components/schemas/unibee.api.bean.Sender' env: description: 'System Env, em: daily|stage|local|prod' format: string properties: {} type: string exchangeRateApiKey: description: ExchangeRateApiKey format: string properties: {} type: string gateways: description: Gateway List format: '[]*detail.Gateway' items: $ref: '#/components/schemas/unibee.api.bean.detail.Gateway' properties: {} type: array globalTOPTEnabled: description: GlobalTOPTEnabled format: bool properties: {} type: boolean globalUSVATConfig: $ref: '#/components/schemas/unibee.api.bean.USVATGlobalConfig' isOwner: description: Check Member is Owner format: bool properties: {} type: boolean isProd: description: Check System Env Is Prod, true|false format: bool properties: {} type: boolean merchant: $ref: '#/components/schemas/unibee.api.bean.Merchant' merchantMember: $ref: >- #/components/schemas/unibee.api.bean.detail.MerchantMemberDetail multiCurrencyConfigs: description: Merchant's MultiCurrency Configs format: '[]*bean.MerchantMultiCurrencyConfig' items: $ref: >- #/components/schemas/unibee.api.bean.MerchantMultiCurrencyConfig properties: {} type: array openApiHost: description: OpenApi Host format: string properties: {} type: string openApiKey: description: OpenAPIKey format: string properties: {} type: string quickBooksCompanyName: description: QuickBooksCompanyName format: string properties: {} type: string quickBooksLastSyncError: description: QuickBooksLastSyncError format: string properties: {} type: string quickBooksLastSynchronized: description: QuickBooksLastSynchronized format: string properties: {} type: string segmentServerSideKey: description: SegmentServerSideKey format: string properties: {} type: string segmentUserPortalKey: description: SegmentUserPortalKey format: string properties: {} type: string sendGridKey: description: SendGridKey format: string properties: {} type: string taxJarApiKeys: $ref: >- #/components/schemas/unibee.api.bean.USVATGatewayConnectionAPIKeys vatSenseKey: description: VatSenseKey format: string properties: {} type: string type: object merchantId: format: int64 properties: {} type: integer message: format: string properties: {} type: string redirect: format: string properties: {} type: string requestId: format: string properties: {} type: string type: object description: '' components: schemas: unibee.api.bean.Currency: properties: Currency: format: string properties: {} type: string Scale: format: int properties: {} type: integer Symbol: format: string properties: {} type: string type: object unibee.api.bean.MerchantRole: properties: createTime: description: create utc time format: int64 properties: {} type: integer id: description: id format: int64 properties: {} type: integer merchantId: description: merchant id format: int64 properties: {} type: integer permissions: description: permissions format: '[]*bean.MerchantRolePermission' items: $ref: '#/components/schemas/unibee.api.bean.MerchantRolePermission' properties: {} type: array role: description: role format: string properties: {} type: string type: object unibee.api.bean.EmailGatewayConnectionAPIKeys: properties: apiKey: description: The API key of Email Gateway, used for sendgrid format: string properties: {} type: string apiSecret: description: The API key of Email Gateway format: string properties: {} type: string authType: description: The auth type format: string properties: {} type: string oauthToken: description: The OAuth token of Email Gateway format: string properties: {} type: string password: description: The password of Email Gateway format: string properties: {} type: string skipTLSVerify: description: Skip TLS verification format: bool properties: {} type: boolean smtpHost: description: The SMTP host format: string properties: {} type: string smtpPort: description: The SMTP port format: int properties: {} type: integer useTLS: description: The use TLS format: bool properties: {} type: boolean username: description: The username of Email Gateway format: string properties: {} type: string type: object unibee.api.bean.Sender: properties: address: description: address format: string properties: {} type: string name: description: name format: string properties: {} type: string type: object unibee.api.bean.detail.Gateway: properties: IsSetupFinished: description: Whether the gateway finished setup process format: bool properties: {} type: boolean archive: format: bool properties: {} type: boolean autoChargeEnabled: format: bool properties: {} type: boolean bank: $ref: '#/components/schemas/unibee.api.bean.detail.GatewayBank' companyIssuer: $ref: '#/components/schemas/unibee.api.bean.detail.GatewayCompanyIssuer' countryConfig: additionalProperties: format: bool properties: {} type: boolean format: map[string]bool properties: {} type: object createTime: description: create utc time format: int64 properties: {} type: integer currency: description: 'The currency of wire transfer ' format: string properties: {} type: string currencyExchange: description: >- The currency exchange for gateway payment, effect at start of payment creation when currency matched format: '[]*detail.GatewayCurrencyExchange' items: $ref: >- #/components/schemas/unibee.api.bean.detail.GatewayCurrencyExchange properties: {} type: array currencyExchangeEnabled: description: whether to enable currency exchange format: bool properties: {} type: boolean defaultGatewayPaymentType: $ref: '#/components/schemas/unibee.internal.interface.GatewayPaymentType' description: description: The description of gateway format: string properties: {} type: string displayName: description: The gateway display name, used at user portal format: string properties: {} type: string gatewayIcons: description: The gateway display name, used at user portal format: '[]string' items: format: string properties: {} type: string properties: {} type: array gatewayId: format: int64 properties: {} type: integer gatewayKey: format: string properties: {} type: string gatewayLogo: format: string properties: {} type: string gatewayName: description: >- The gateway name, stripe|paypal|changelly|unitpay|payssion|cryptadium format: string properties: {} type: string gatewayPaymentTypes: description: gatewayPaymentTypes format: '[]*_interface.GatewayPaymentType' items: $ref: '#/components/schemas/unibee.internal.interface.GatewayPaymentType' properties: {} type: array gatewaySecret: format: string properties: {} type: string gatewayType: description: >- gateway type: 1-Card | 2-Crypto | 3-Wire Transfer | 4-PayPal | 5-Credit | 6-Alipay+ | 7-Hyperswitch | 8-External format: int64 properties: {} type: integer gatewayWebhookIntegrationLink: description: >- The gateway webhook integration guide link, gateway webhook need setup if not blank format: string properties: {} type: string gatewayWebsiteLink: description: The gateway website link format: string properties: {} type: string isDefault: format: bool properties: {} type: boolean metadata: additionalProperties: $ref: '#/components/schemas/interface' format: map[string]interface {} properties: {} type: object minimumAmount: description: The minimum amount of wire transfer format: int64 properties: {} type: integer name: description: The name of gateway format: string properties: {} type: string privateSecretName: format: string properties: {} type: string publicKeyName: format: string properties: {} type: string setupGatewayPaymentTypes: description: The total list of gateway payment types, used for setup format: '[]*_interface.GatewayPaymentType' items: $ref: '#/components/schemas/unibee.internal.interface.GatewayPaymentType' properties: {} type: array sort: description: >- The sort value of payment gateway, The higher the value, the lower the ranking format: int64 properties: {} type: integer subGateway: format: string properties: {} type: string subGatewayName: format: string properties: {} type: string webhookEndpointUrl: description: 'The endpoint url of gateway webhook ' format: string properties: {} type: string webhookSecret: description: The secret of gateway webhook format: string properties: {} type: string type: object unibee.api.bean.USVATGlobalConfig: properties: active: format: bool properties: {} type: boolean availableGatewayNames: description: Used for response format: '[]string' items: format: string properties: {} type: string properties: {} type: array checkAddressViaGateway: format: bool properties: {} type: boolean defaultGatewayName: format: string properties: {} type: string fromAddress: $ref: '#/components/schemas/unibee.api.bean.USAddress' nexusAddresses: format: '[]*bean.USAddress' items: $ref: '#/components/schemas/unibee.api.bean.USAddress' properties: {} type: array taxCode: format: string properties: {} type: string toAddress: $ref: '#/components/schemas/unibee.api.bean.USAddress' uploadInvoiceToGateway: format: bool properties: {} type: boolean type: object unibee.api.bean.Merchant: properties: address: description: address format: string properties: {} type: string companyLogo: description: company_logo format: string properties: {} type: string companyName: description: company_name format: string properties: {} type: string companyRegistryCode: description: Country Registry Code format: string properties: {} type: string companyVatNumber: description: Country Vat Number format: string properties: {} type: string countryCode: description: Country Code format: string properties: {} type: string countryName: description: Country Name format: string properties: {} type: string createTime: description: create utc time format: int64 properties: {} type: integer email: description: email format: string properties: {} type: string homeUrl: format: string properties: {} type: string host: description: merchant user portal host format: string properties: {} type: string id: description: merchant_id format: int64 properties: {} type: integer location: description: location format: string properties: {} type: string name: description: name format: string properties: {} type: string phone: description: phone format: string properties: {} type: string timeZone: description: merchant default time zone format: string properties: {} type: string type: description: type format: int properties: {} type: integer userId: description: create_user_id format: int64 properties: {} type: integer type: object unibee.api.bean.detail.MerchantMemberDetail: properties: MemberGroupPermission: additionalProperties: $ref: '#/components/schemas/unibee.api.bean.MerchantRolePermission' description: The member group permission map' format: map[string]*bean.MerchantRolePermission properties: {} type: object MemberRoles: description: The member role list' format: '[]*bean.MerchantRole' items: $ref: '#/components/schemas/unibee.api.bean.MerchantRole' properties: {} type: array createTime: description: create utc time format: int64 properties: {} type: integer currentDeviceIdentity: description: The Current DeviceIdentity' format: string properties: {} type: string deviceList: description: The devices list' format: '[]*bean.MerchantMemberDevice' items: $ref: '#/components/schemas/unibee.api.bean.MerchantMemberDevice' properties: {} type: array email: description: email format: string properties: {} type: string firstName: description: first name format: string properties: {} type: string id: description: userId format: int64 properties: {} type: integer isBlankPasswd: description: is blank password format: bool properties: {} type: boolean isOwner: description: Check Member is Owner format: bool properties: {} type: boolean lastName: description: last name format: string properties: {} type: string merchantId: description: merchant id format: int64 properties: {} type: integer mobile: description: mobile format: string properties: {} type: string oauthAccounts: description: List of connected OAuth accounts format: '[]*bean.Oauth' items: $ref: '#/components/schemas/unibee.api.bean.Oauth' properties: {} type: array status: description: 0-Active, 2-Suspend format: int properties: {} type: integer totpType: description: >- 0-Inactive, 1-General, Google Authenticator | 2-Microsoft Authenticator | 3-Authy | 4-1Password | 5-LastPass | 6-FreeOTP | 7-Other TOTP format: int properties: {} type: integer type: object unibee.api.bean.MerchantMultiCurrencyConfig: properties: currencyConfigs: format: '[]*bean.MerchantCurrencyConfig' items: $ref: '#/components/schemas/unibee.api.bean.MerchantCurrencyConfig' properties: {} type: array defaultCurrency: format: string properties: {} type: string lastUpdateTime: description: Last Update UTC Time format: int64 properties: {} type: integer name: format: string properties: {} type: string type: object unibee.api.bean.USVATGatewayConnectionAPIKeys: properties: apiKey: format: string properties: {} type: string apiSecret: format: string properties: {} type: string type: object unibee.api.bean.MerchantRolePermission: properties: group: description: Group format: string properties: {} type: string permissions: description: Permissions format: '[]string' items: format: string properties: {} type: string properties: {} type: array type: object unibee.api.bean.detail.GatewayBank: properties: ABARoutingNumber: description: 'The ABARoutingNumber of wire transfer ' format: string properties: {} type: string CNAPS: description: 'The CNAPS of wire transfer ' format: string properties: {} type: string Remarks: description: 'The Remarks additional content ' format: string properties: {} type: string accountHolder: description: 'The AccountHolder of wire transfer ' format: string properties: {} type: string accountNumber: description: The Account Number format: string properties: {} type: string address: description: 'The address of wire transfer ' format: string properties: {} type: string bankName: description: The Bank Name format: string properties: {} type: string bic: description: 'The BIC of wire transfer ' format: string properties: {} type: string bsbCode: description: The BSB Code format: string properties: {} type: string iban: description: 'The IBAN of wire transfer ' format: string properties: {} type: string swiftCode: description: The Swift Code format: string properties: {} type: string required: - accountHolder - address type: object unibee.api.bean.detail.GatewayCompanyIssuer: properties: issueAddress: format: string properties: {} type: string issueCompanyName: format: string properties: {} type: string issueLogo: format: string properties: {} type: string issueRegNumber: format: string properties: {} type: string issueVatNumber: format: string properties: {} type: string type: object unibee.api.bean.detail.GatewayCurrencyExchange: properties: exchange_rate: description: >- the exchange rate of gateway, set to 0 if using https://app.exchangerate-api.com/ instead of fixed exchange rate format: float64 properties: {} type: number from_currency: description: the currency of gateway exchange from format: string properties: {} type: string to_currency: description: the currency of gateway exchange to format: string properties: {} type: string type: object unibee.internal.interface.GatewayPaymentType: properties: autoCharge: format: bool properties: {} type: boolean category: format: string properties: {} type: string countryName: format: string properties: {} type: string name: format: string properties: {} type: string paymentType: format: string properties: {} type: string supportCurrencies: format: '[]string' items: format: string properties: {} type: string properties: {} type: array type: object interface: properties: {} type: object unibee.api.bean.USAddress: properties: address: format: string properties: {} type: string city: format: string properties: {} type: string countryCode: format: string properties: {} type: string state: format: string properties: {} type: string verified: format: bool properties: {} type: boolean zipCode: format: string properties: {} type: string type: object unibee.api.bean.MerchantMemberDevice: properties: currentDevice: description: Is CurrentDevice format: bool properties: {} type: boolean identity: description: Identity format: string properties: {} type: string ipAddress: description: IP Address format: string properties: {} type: string lastActiveTime: description: Last Active Time format: int64 properties: {} type: integer lastLoginTime: description: Last Login Time format: int64 properties: {} type: integer lastTotpVerificationTime: description: Last Totp Verification Time format: int64 properties: {} type: integer name: description: Name format: string properties: {} type: string status: description: true-Active, false-Offline format: bool properties: {} type: boolean type: object unibee.api.bean.Oauth: properties: email: format: string properties: {} type: string emailVerified: format: bool properties: {} type: boolean image: format: string properties: {} type: string name: format: string properties: {} type: string provider: format: string properties: {} type: string providerId: format: string properties: {} type: string type: object unibee.api.bean.MerchantCurrencyConfig: properties: autoExchange: description: >- using https://app.exchangerate-api.com/ to update exchange rate if true, the exchange APIKey need setup first format: bool properties: {} type: boolean currency: description: target currency format: string properties: {} type: string exchangeRate: description: >- the exchange rate of gateway, no setup required if AutoExchange is true format: float64 properties: {} type: number type: object securitySchemes: Authorization: bearerFormat: JWT scheme: bearer type: http ````