UniBee

https://docs.unibee.dev/
Admin
UniBee is an advanced open-source billing software designed for SaaS businesses, offering...
Tokens:704,990
Snippets:1,273
Trust Score:9.2
Update:1 year ago
Show doc for...
Tokens:
Raw
### GET /merchant/gateway/setup_list

Source: https://docs.unibee.dev/api-reference/gateway/get-payment-gateway-setup-list

Retrieves a list of payment gateway setups. This endpoint provides details about configured payment gateways, including their setup status, associated bank information, and currency configurations.

```APIDOC
## GET /merchant/gateway/setup_list

### Description
Retrieves a list of payment gateway setups. This endpoint provides details about configured payment gateways, including their setup status, associated bank information, and currency configurations.

### Method
GET

### Endpoint
/merchant/gateway/setup_list

### Parameters
#### Query Parameters
None

#### Path Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **code** (integer) - Response code.
- **data** (object) - Data object containing the list of gateways.
  - **gateways** (array) - Payment Gateway Setup Object List.
    - **IsSetupFinished** (boolean) - Whether the gateway finished setup process.
    - **archive** (boolean)
    - **autoChargeEnabled** (boolean)
    - **bank** (object) - Bank details for the gateway.
    - **countryConfig** (object) - Country-specific configurations.
    - **createTime** (integer) - Create UTC time.
    - **currency** (string)
    - **currencyExchange** (array) - List of currency exchange rates.
    - **currencyExchangeEnabled** (boolean)
    - **description** (string)
    - **displayName** (string)
    - **gatewayIcons** (array of strings)
    - **gatewayId** (integer)
    - **gatewayKey** (string)
    - **gatewayLogo** (string)
    - **gatewayName** (string)
    - **gatewayPaymentTypes** (array) - Available payment types for the gateway.
    - **gatewaySecret** (string)
    - **gatewayType** (integer)
    - **gatewayWebhookIntegrationLink** (string)
    - **gatewayWebsiteLink** (string)
    - **minimumAmount** (integer)
    - **name** (string)
    - **privateSecretName** (string)
    - **publicKeyName** (string)
    - **setupGatewayPaymentTypes** (array) - Payment types configured for setup.
    - **sort** (integer)
    - **subGateway** (string)
    - **subGatewayName** (string)
    - **webhookEndpointUrl** (string)
    - **webhookSecret** (string)
- **message** (string) - Response message.
- **redirect** (string) - Redirect URL if applicable.
- **requestId** (string) - Unique request ID.

#### Response Example
```json
{
  "code": 123,
  "data": {
    "gateways": [
      {
        "IsSetupFinished": true,
        "archive": true,
        "autoChargeEnabled": true,
        "bank": {
          "accountHolder": "<string>",
          "accountNumber": "<string>",
          "address": "<string>",
          "bankName": "<string>",
          "bic": "<string>",
          "bsbCode": "<string>",
          "iban": "<string>",
          "swiftCode": "<string>"
        },
        "countryConfig": {},
        "createTime": 123,
        "currency": "<string>",
        "currencyExchange": [
          {
            "exchange_rate": 123,
            "from_currency": "<string>",
            "to_currency": "<string>"
          }
        ],
        "currencyExchangeEnabled": true,
        "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>"
          }
        ],
        "gatewaySecret": "<string>",
        "gatewayType": 123,
        "gatewayWebhookIntegrationLink": "<string>",
        "gatewayWebsiteLink": "<string>",
        "minimumAmount": 123,
        "name": "<string>",
        "privateSecretName": "<string>",
        "publicKeyName": "<string>",
        "setupGatewayPaymentTypes": [
          {
            "autoCharge": true,
            "category": "<string>",
            "countryName": "<string>",
            "name": "<string>",
            "paymentType": "<string>"
          }
        ],
        "sort": 123,
        "subGateway": "<string>",
        "subGatewayName": "<string>",
        "webhookEndpointUrl": "<string>",
        "webhookSecret": "<string>"
      }
    ]
  },
  "message": "<string>",
  "redirect": "<string>",
  "requestId": "<string>"
}
```

```

--------------------------------

### Unibee Plan Creation Example

Source: https://docs.unibee.dev/api-reference/plan/create-plan

Provides a concrete example of how to structure the data for creating a new Unibee plan. This example includes sample values for various optional fields such as addons, metrics, and trial configurations.

```json
{
  "addonIds": [
    123
  ],
  "amount": 123,
  "cancelAtTrialEnd": 123,
  "currency": "<string>",
  "description": "<string>",
  "externalPlanId": "<string>",
  "gasPayer": "<string>",
  "homeUrl": "<string>",
  "imageUrl": "<string>",
  "internalName": "<string>",
  "intervalCount": 123,
  "intervalUnit": "<string>",
  "metadata": {},
  "metricLimits": [
    {
      "metricId": 123,
      "metricLimit": 123
    }
  ],
  "metricMeteredCharge": [
    {
      "chargeType": 123,
      "graduatedAmounts": [
        {
          "endValue": 123,
          "flatAmount": 123,
          "perAmount": 123,
          "startValue": 123
        }
      ],
      "metricId": 123,
      "standardAmount": 123,
      "standardStartValue": 123
    }
  ],
  "metricRecurringCharge": [
    {
      "chargeType": 123,
      "graduatedAmounts": [
        {
          "endValue": 123,
          "flatAmount": 123,
          "perAmount": 123,
          "startValue": 123
        }
      ],
      "metricId": 123,
      "standardAmount": 123,
      "standardStartValue": 123
    }
  ],
  "onetimeAddonIds": [
    123
  ],
  "planName": "<string>",
  "productDescription": "<string>",
  "productId": 123,
  "productName": "<string>",
  "trialAmount": 123,
  "trialDemand": "<string>",
  "trialDurationTime": 123,
  "type": 1
}
```

--------------------------------

### Example Endpoint

Source: https://docs.unibee.dev/api-reference/session/new-checkout-session

This section describes an example endpoint, likely for retrieving or processing data related to the Unibee Dev project.

```APIDOC
## POST /websites/unibee_dev/example

### Description
This endpoint is an example demonstrating a potential API interaction. It is designed to return a structured response containing various data fields.

### Method
POST

### Endpoint
/websites/unibee_dev/example

### Parameters
#### Query Parameters
- **requestId** (string) - Optional - A unique identifier for the request.

#### Request Body
This endpoint does not explicitly define a request body in the provided schema.

### Request Example
```json
{
  "requestId": "example_request_123"
}
```

### Response
#### Success Response (200)
- **code** (integer) - The status code of the operation.
- **data** (object) - Contains detailed information returned by the API.
  - **clientSession** (string) - The client session identifier.
  - **clientToken** (string) - The client authentication token.
  - **email** (string) - The email address associated with the client.
  - **externalUserId** (string) - An external user identifier.
  - **url** (string) - A URL related to the response data.
  - **userId** (string) - The unique identifier for the user.
- **message** (string) - A human-readable message describing the outcome of the operation.
- **redirect** (string) - A URL to redirect the client to, if applicable.
- **requestId** (string) - The identifier for the request.

#### Response Example
```json
{
  "code": 123,
  "data": {
    "clientSession": "<string>",
    "clientToken": "<string>",
    "email": "<string>",
    "externalUserId": "<string>",
    "url": "<string>",
    "userId": "<string>"
  },
  "message": "<string>",
  "redirect": "<string>",
  "requestId": "<string>"
}
```
```

--------------------------------

### Example Subscription Response

Source: https://docs.unibee.dev/api-reference/subscription/get-subscription-list-1

An example of a subscription response, showcasing detailed subscription data including addons, discounts, and gateway information. This example illustrates the expected data format for API consumers.

```json
{
  "code": 123,
  "data": {
    "subscriptions": [
      {
        "addonParams": [
          {
            "addonPlanId": 123,
            "quantity": 123
          }
        ],
        "addons": [
          {
            "addonPlan": {
              "amount": 123,
              "bindingAddonIds": "<string>",
              "bindingOnetimeAddonIds": "<string>",
              "cancelAtTrialEnd": 123,
              "checkoutUrl": "<string>",
              "createTime": 123,
              "currency": "<string>",
              "description": "<string>",
              "disableAutoCharge": 123,
              "externalPlanId": "<string>",
              "extraMetricData": "<string>",
              "gasPayer": "<string>",
              "homeUrl": "<string>",
              "id": 123,
              "imageUrl": "<string>",
              "internalName": "<string>",
              "intervalCount": 123,
              "intervalUnit": "<string>",
              "merchantId": 123,
              "metadata": {},
              "metricLimits": [
                "<any>"
              ],
              "metricMeteredCharge": [
                "<any>"
              ],
              "metricRecurringCharge": [
                "<any>"
              ],
              "planName": "<string>",
              "productId": 123,
              "publishStatus": 123,
              "status": 123,
              "taxPercentage": 123,
              "trialAmount": 123,
              "trialDemand": "<string>",
              "trialDurationTime": 123,
              "type": 123
            },
            "quantity": 123
          }
        ],
        "dayLeft": 123,
        "discount": {
          "advance": true,
          "billingType": 123,
          "code": "<string>",
          "createTime": 123,
          "currency": "<string>",
          "cycleLimit": 123,
          "discountAmount": 123,
          "discountPercentage": 123,
          "discountType": 123,
          "endTime": 123,
          "id": 123,
          "isDeleted": 123,
          "merchantId": 123,
          "metadata": {},
          "name": "<string>",
          "planApplyGroup": {
            "currency": [
              "<string>"
            ],
            "groupPlanIntervalSelector": [
              {}
            ],
            "type": [
              123
            ]
          },
          "planApplyType": 123,
          "planIds": [
            123
          ],
          "quantity": 123,
          "startTime": 123,
          "status": 123,
          "upgradeLongerOnly": true,
          "upgradeOnly": true,
          "userLimit": 123,
          "userScope": 123
        },
        "gateway": {
          "IsSetupFinished": true,
          "archive": true,
          "autoChargeEnabled": true,
          "bank": {
            "accountHolder": "<string>",
            "accountNumber": "<string>",
            "address": "<string>",
            "bankName": "<string>",
            "bic": "<string>",
            "bsbCode": "<string>",
            "iban": "<string>",
            "swiftCode": "<string>"
          },
          "countryConfig": {},
          "createTime": 123,
          "currency": "<string>"
        }
      }
    ],
    "message": null,
    "redirect": null,
    "requestId": null
  }
}
```

--------------------------------

### Create Subscription Onetime Addon Purchase Request Example

Source: https://docs.unibee.dev/api-reference/subscription-payment/new-subscription-onetime-addon-payment

This example demonstrates the structure of a request to create a one-time addon purchase for a subscription. It includes optional parameters like promo credits, discount codes, and return URLs.

```json
{
  "addonId": 123,
  "applyPromoCredit": true,
  "applyPromoCreditAmount": 123,
  "cancelUrl": "<string>",
  "discountAmount": 123,
  "discountCode": "<string>",
  "discountPercentage": 123,
  "gatewayId": 123,
  "gatewayPaymentType": "<string>",
  "metadata": {},
  "quantity": 123,
  "returnUrl": "<string>",
  "subscriptionId": "<string>",
  "taxPercentage": 123,
  "userId": 123
}
```

--------------------------------

### Get VAT Country List (OpenAPI YAML)

Source: https://docs.unibee.dev/api-reference/vat-gateway/get-vat-country-list

This OpenAPI specification defines the GET request for the /merchant/vat/country_list endpoint. It outlines the request parameters, authentication methods (Bearer Token), and the structure of the JSON response, including a detailed schema for VatCountryRate objects. The example response demonstrates the expected data format for VAT country information.

```yaml
paths:
  path: /merchant/vat/country_list
  method: get
  servers:
    - url: https://api.unibee.top
    - url: http://127.0.0.1:8080
  request:
    security:
      - title: Authorization
        parameters:
          query: {}
          header:
            Authorization:
              type: http
              scheme: bearer
          cookie: {}
    parameters:
      path: {}
      query: {}
      header: {}
      cookie: {}
    body: {}
  response:
    '200':
      application/json:
        schemaArray:
          - type: object
            properties:
              code:
                allOf:
                  - format: int
                    properties: {}
                    type: integer
              data:
                allOf:
                  - properties:
                      vatCountryList:
                        description: VatCountryList
                        format: '[]*bean.VatCountryRate'
                        items:
                          $ref: '#/components/schemas/unibee.api.bean.VatCountryRate'
                        properties: {}
                        type: array
                    type: object
              message:
                allOf:
                  - format: string
                    properties: {}
                    type: string
              redirect:
                allOf:
                  - format: string
                    properties: {}
                    type: string
              requestId:
                allOf:
                  - format: string
                    properties: {}
                    type: string
        examples:
          example:
            value:
              code: 123
              data:
                vatCountryList:
                  - countryCode: <string>
                    countryName: <string>
                    gateway: <string>
                    id: 123
                    isEU: true
                    mamo: <string>
                    standardTaxPercentage: 123
                    vatSupport: true
              message: <string>
              redirect: <string>
              requestId: <string>
        description: ''
  deprecated: false
  type: path
components:
  schemas:
    unibee.api.bean.VatCountryRate:
      properties:
        countryCode:
          format: string
          properties: {}
          type: string
        countryName:
          format: string
          properties: {}
          type: string
        gateway:
          format: string
          properties: {}
          type: string
        id:
          format: int64
          properties: {}
          type: integer
        isEU:
          format: bool
          properties: {}
          type: boolean
        mamo:
          description: mamo
          format: string
          properties: {}
          type: string
        standardTaxPercentage:
          format: int64
          properties: {}
          type: integer
        vatSupport:
          format: bool
          properties: {}
          type: boolean
      type: object
```

--------------------------------

### Setup Payment Gateway (Bash)

Source: https://context7.com/context7/unibee_dev/llms.txt

Configures a new payment gateway. Requires essential details like gateway name, type, API credentials, currency, and webhook settings. Upon successful configuration, it returns gateway details.

```bash
curl --request POST \
  --url https://api.unibee.top/merchant/gateway/payment_gateway_setup \
  --header 'Authorization: Bearer sk_live_xxxxxxxxxxxxx' \
  --header 'Content-Type: application/json' \
  --data '{
    "gatewayName": "stripe",
    "gatewayType": 1,
    "gatewayKey": "pk_live_51xxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    "gatewaySecret": "sk_live_51xxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    "currency": "USD",
    "webhookSecret": "whsec_xxxxxxxxxxxxxxxxxxxxxxxxxx",
    "webhookUrl": "https://api.unibee.top/webhook/stripe/merchant_100",
    "metadata": {
      "environment": "production",
      "region": "us-east-1"
    }
  }'
```

--------------------------------

### POST /merchant/vat/setup_gateway

Source: https://docs.unibee.dev/api-reference/vat-gateway/vat-gateway-setup

Sets up a new VAT gateway with specified parameters. This endpoint allows merchants to integrate and configure their VAT handling systems.

```APIDOC
## POST /merchant/vat/setup_gateway

### Description
Sets up a new VAT gateway with specified parameters. This endpoint allows merchants to integrate and configure their VAT handling systems.

### Method
POST

### Endpoint
https://api.unibee.top/merchant/vat/setup_gateway

### Parameters
#### Query Parameters
(No query parameters defined)

#### Header Parameters
- **Authorization** (string) - Required - Bearer token for authentication.

#### Request Body
- **gatewayName** (string) - Required - The name of the gateway, e.g., vatsense.
- **data** (string) - Required - The data associated with the gateway configuration.
- **IsDefault** (boolean) - Optional - Specifies if this gateway is the default one. Defaults to true.

### Request Example
```json
{
  "gatewayName": "vatsense",
  "data": "<string>",
  "IsDefault": true
}
```

### Response
#### Success Response (200)
- **code** (integer) - The status code of the response.
- **data** (object) - Contains additional data, including:
  - **data** (string) - The hide star data.
- **message** (string) - A message describing the result of the operation.
- **redirect** (string) - A URL for redirection, if applicable.
- **requestId** (string) - The unique identifier for the request.

#### Response Example
```json
{
  "code": 123,
  "data": {
    "data": "<string>"
  },
  "message": "<string>",
  "redirect": "<string>",
  "requestId": "<string>"
}
```
```

--------------------------------

### Get Merchant Metric Event List (OpenAPI/YAML)

Source: https://docs.unibee.dev/api-reference/metric-event/metric-event-list

Defines the OpenAPI specification for the GET /merchant/metric/event_list endpoint. It includes server URLs, request parameters (query, header, security), and response structures for a 200 status code, along with an example.

```yaml
paths:
  path: /merchant/metric/event_list
  method: get
  servers:
    - url: https://api.unibee.top
    - url: http://127.0.0.1:8080
  request:
    security:
      - title: Authorization
        parameters:
          query: {}
          header:
            Authorization:
              type: http
              scheme: bearer
          cookie: {}
    parameters:
      path: {}
      query:
        userIds:
          schema:
            - type: array
              items:
                allOf:
                  - format: int64
                    properties: {}
                    type: integer
              description: Filter UserIds, Default All
        metricIds:
          schema:
            - type: array
              items:
                allOf:
                  - format: int64
                    properties: {}
                    type: integer
              description: Filter MetricIds, Default All
        sortField:
          schema:
            - type: string
              description: Sort，user_id|gmt_create，Default gmt_create
              format: string
        sortType:
          schema:
            - type: string
              description: Sort Type，asc|desc，Default desc
              format: string
        page:
          schema:
            - type: integer
              description: Page,Start 0
        count:
          schema:
            - type: integer
              description: Count OF Page
        createTimeStart:
          schema:
            - type: integer
              description: CreateTimeStart
        createTimeEnd:
          schema:
            - type: integer
              description: CreateTimeEnd
      header: {}
      cookie: {}
    body: {}
  response:
    '200':
      application/json:
        schemaArray:
          - type: object
            properties:
              code:
                allOf:
                  - format: int
                    properties: {}
                    type: integer
              data:
                allOf:
                  - properties:
                      events:
                        description: User Metric Event List
                        format: '[]*detail.MerchantMetricEventDetail'
                        items:
                          $ref: >-
                            #/components/schemas/unibee.api.bean.detail.MerchantMetricEventDetail
                        properties: {}
                        type: array
                      total:
                        description: Total
                        format: int
                        properties: {}
                        type: integer
                    type: object
              message:
                allOf:
                  - format: string
                    properties: {}
                    type: string
              redirect:
                allOf:
                  - format: string
                    properties: {}
                    type: string
              requestId:
                allOf:
                  - format: string
                    properties: {}
                    type: string
        examples:
          example:
            value:
              code: 123
              data:
                events:
                  - aggregationPropertyData: <string>
                    aggregationPropertyInt: 123
                    aggregationPropertyString: <string>
                    chargeInvoice:
                      PaymentMethodId: <string>
                      autoCharge: true
                      billingCycleAnchor: 123
                      bizType: 123
                      countryCode: <string>
                      createFrom: <string>
                      creditAccount:
                        amount: 123
                        createTime: 123
                        currency: <string>
                        currencyAmount: 123
                        exchangeRate: 123
                        id: 123
                        payoutEnable: 123
                        rechargeEnable: 123
                        totalDecrementAmount: 123
                        totalIncrementAmount: 123
                        type: 123
                        userId: 123
                      creditPayout:
                        creditAmount: 123
                        currencyAmount: 123
                        exchangeRate: 123
                      cryptoAmount: 123
                      cryptoCurrency: <string>
                      currency: <string>
                      data: <string>
                      dayUtilDue: 123
                      discount:
                        advance: true
                        billingType: 123
                        code: <string>
                        createTime: 123
                        currency: <string>
                        cycleLimit: 123
                        discountAmount: 123
                        discountPercentage: 123

```

--------------------------------

### Get Merchant Member Profile - OpenAPI Definition

Source: https://docs.unibee.dev/api-reference/admin-member/get-member-profile

This YAML snippet defines the OpenAPI 3.0 specification for the GET /merchant/member/profile endpoint. It details the path, method, servers, request parameters (including Authorization header), and the response structure for a successful '200' status code, including example data.

```yaml
paths:
  path: /merchant/member/profile
  method: get
  servers:
    - url: https://api.unibee.top
    - url: http://127.0.0.1:8080
  request:
    security:
      - title: Authorization
        parameters:
          query: {}
          header:
            Authorization:
              type: http
              scheme: bearer
          cookie: {}
    parameters:
      path: {}
      query: {}
      header: {}
      cookie: {}
    body: {}
  response:
    '200':
      application/json:
        schemaArray:
          - type: object
            properties:
              code:
                allOf:
                  - format: int
                    properties: {}
                    type: integer
              data:
                allOf:
                  - properties:
                      merchantMember:
                        $ref: >-
                          #/components/schemas/unibee.api.bean.detail.MerchantMemberDetail
                    type: object
              message:
                allOf:
                  - format: string
                    properties: {}
                    type: string
              redirect:
                allOf:
                  - format: string
                    properties: {}
                    type: string
              requestId:
                allOf:
                  - format: string
                    properties: {}
                    type: string
        examples:
          example:
            value:
              code: 123
              data:
                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
              message: <string>
              redirect: <string>
              requestId: <string>
        description: ''
  deprecated: false
  type: path
components:
  schemas:
    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.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'

```

--------------------------------

### POST /merchant/gateway/payment_gateway_setup

Source: https://context7.com/context7/unibee_dev/llms.txt

Configures a new payment gateway by providing its API credentials, currency support, and webhook settings.

```APIDOC
## POST /merchant/gateway/payment_gateway_setup

### Description
Configure a new payment gateway with API credentials and webhook settings.

### Method
POST

### Endpoint
`/merchant/gateway/payment_gateway_setup`

### Parameters
#### Request Body
- **gatewayName** (string) - Required - The name of the gateway to set up (e.g., `stripe`, `paypal`).
- **gatewayType** (integer) - Required - The type of the gateway (e.g., 1 for Bank Card, 2 for Cryptocurrency).
- **gatewayKey** (string) - Required - The public API key for the gateway.
- **gatewaySecret** (string) - Required - The secret API key for the gateway.
- **currency** (string) - Required - The primary currency supported by this gateway configuration (e.g., `USD`).
- **webhookSecret** (string) - Optional - A secret used for signing webhook events from this gateway.
- **webhookUrl** (string) - Optional - The URL where webhook events should be sent.
- **metadata** (object) - Optional - Additional metadata for the gateway configuration.
  - **environment** (string) - e.g., `production`, `test`.
  - **region** (string) - e.g., `us-east-1`.

### Request Example
```bash
curl --request POST \
  --url https://api.unibee.top/merchant/gateway/payment_gateway_setup \
  --header 'Authorization: Bearer sk_live_xxxxxxxxxxxxx' \
  --header 'Content-Type: application/json' \
  --data '{ \
    "gatewayName": "stripe", \
    "gatewayType": 1, \
    "gatewayKey": "pk_live_51xxxxxxxxxxxxxxxxxxxxxxxxxxxxx", \
    "gatewaySecret": "sk_live_51xxxxxxxxxxxxxxxxxxxxxxxxxxxxx", \
    "currency": "USD", \
    "webhookSecret": "whsec_xxxxxxxxxxxxxxxxxxxxxxxxxx", \
    "webhookUrl": "https://api.unibee.top/webhook/stripe/merchant_100", \
    "metadata": { \
      "environment": "production", \
      "region": "us-east-1" \
    } \
  }'
```

### Response
#### Success Response (200)
- **code** (integer) - Response status code (0 for success).
- **data** (object) - Contains details of the configured gateway.
  - **gateway** (object) - The configured gateway object.
    - **id** (integer) - The unique identifier of the newly configured gateway.
    - **gatewayName** (string) - The name of the gateway.
    - **status** (string) - The status of the gateway (e.g., `active`).
    - **webhookUrl** (string) - The configured webhook URL.
    - **createTime** (integer) - Unix timestamp when the gateway was configured.
- **message** (string) - A message describing the result of the operation (e.g., `Gateway configured successfully`).
- **requestId** (string) - A unique identifier for the request.

#### Response Example
```json
{
  "code": 0,
  "data": {
    "gateway": {
      "id": 123,
      "gatewayName": "stripe",
      "status": "active",
      "webhookUrl": "https://api.unibee.top/webhook/stripe/merchant_100",
      "createTime": 1699999999
    }
  },
  "message": "Gateway configured successfully",
  "requestId": "req_gateway_456"
}
```

### Supported Gateways
- stripe: Stripe payment processor
- paypal: PayPal payments
- changelly: Cryptocurrency via Changelly
- wire_transfer: Manual wire transfers
```

--------------------------------

### OpenAPI Specification for Merchant Search

Source: https://docs.unibee.dev/api-reference/search/search

This OpenAPI specification defines the GET endpoint for searching merchants. It includes details on request parameters (searchKey), authentication (Bearer token), and the structure of the JSON response, which can contain matched invoices, user accounts, and precision match objects. The specification also provides an example response.

```yaml
paths:
  path: /merchant/search/key_search
  method: get
  servers:
    - url: https://api.unibee.top
    - url: http://127.0.0.1:8080
  request:
    security:
      - title: Authorization
        parameters:
          query: {}
          header:
            Authorization:
              type: http
              scheme: bearer
          cookie: {}
    parameters:
      path: {}
      query:
        searchKey:
          schema:
            - type: string
              description: >-
                SearchKey, Will Search
                UserId|Email|UserName|CompanyName|SubscriptionId|VatNumber|InvoiceId||PaymentId
              format: string
      header: {}
      cookie: {}
    body: {}
  response:
    '200':
      application/json:
        schemaArray:
          - type: object
            properties:
              code:
                allOf:
                  - format: int
                    properties: {}
                    type: integer
              data:
                allOf:
                  - properties:
                      matchInvoice:
                        description: MatchInvoice
                        format: '[]*bean.Invoice'
                        items:
                          $ref: '#/components/schemas/unibee.api.bean.Invoice'
                        properties: {}
                        type: array
                      matchUserAccounts:
                        description: MatchUserAccounts
                        format: '[]*detail.UserAccountDetail'
                        items:
                          $ref: >-
                            #/components/schemas/unibee.api.bean.detail.UserAccountDetail
                        properties: {}
                        type: array
                      precisionMatchObject:
                        $ref: >-
                          #/components/schemas/unibee.api.merchant.search.PrecisionMatchObject
                    type: object
              message:
                allOf:
                  - format: string
                    properties: {}
                    type: string
              redirect:
                allOf:
                  - format: string
                    properties: {}
                    type: string
              requestId:
                allOf:
                  - format: string
                    properties: {}
                    type: string
        examples:
          example:
            value:
              code: 123
              data:
                matchInvoice:
                  - PaymentMethodId: <string>
                    autoCharge: true
                    billingCycleAnchor: 123
                    bizType: 123
                    countryCode: <string>
                    createFrom: <string>
                    creditAccount:
                      amount: 123
                      createTime: 123
                      currency: <string>
                      currencyAmount: 123
                      exchangeRate: 123
                      id: 123
                      payoutEnable: 123
                      rechargeEnable: 123
                      totalDecrementAmount: 123
                      totalIncrementAmount: 123
                      type: 123
                      userId: 123
                    creditPayout:
                      creditAmount: 123
                      currencyAmount: 123
                      exchangeRate: 123
                    cryptoAmount: 123
                    cryptoCurrency: <string>
                    currency: <string>
                    data: <string>
                    dayUtilDue: 123
                    discount:
                      advance: true
                      billingType: 123
                      code: <string>
                      createTime: 123
                      currency: <string>
                      cycleLimit: 123
                      discountAmount: 123
                      discountPercentage: 123
                      discountType: 123
                      endTime: 123
                      id: 123
                      isDeleted: 123
                      merchantId: 123
                      metadata: {}
                      name: <string>
                      planApplyGroup:
                        currency:
                          - <string>
                        groupPlanIntervalSelector:
                          - intervalCount: 123
                            intervalUnit: <string>
                        type:
                          - 123
                      planApplyType: 123
                      planIds:
                        - 123
                      quantity: 123
                      startTime: 123
                      status: 123
                      upgradeLongerOnly: true
                      upgradeOnly: true
                      userLimit: 123
                      userScope: 123

```

--------------------------------

### Create Product using cURL

Source: https://context7.com/context7/unibee_dev/llms.txt

Creates a product container used for organizing subscription plans and one-time purchases. Requires product name, description, and optionally home URL, image URL, and status. The response includes the created product details.

```bash
curl --request POST \
  --url https://api.unibee.top/merchant/product/new \
  --header 'Authorization: Bearer sk_live_xxxxxxxxxxxxx' \
  --header 'Content-Type: application/json' \
  --data '{ \
    "productName": "Premium Software Suite", \
    "description": "Complete business software solution with advanced analytics and automation", \
    "homeUrl": "https://yoursite.com/products/premium", \
    "imageUrl": "https://yoursite.com/images/premium-suite.png", \
    "status": 1, \
    "metadata": { \
      "category": "software", \
      "target_audience": "enterprise", \
      "feature_tier": "premium" \
    } \
  }'
```

--------------------------------

### Get Merchant Gateway Detail OpenAPI Spec

Source: https://docs.unibee.dev/api-reference/gateway/payment-gateway-1

This OpenAPI specification defines the POST /merchant/gateway/detail endpoint. It allows merchants to retrieve detailed information about a specific payment gateway by providing either its ID or name. The response includes gateway configuration, supported currencies, and setup status. It requires an 'Authorization' header with a Bearer token.

```yaml
paths:
  path: /merchant/gateway/detail
  method: post
  servers:
    - url: https://api.unibee.top
    - url: http://127.0.0.1:8080
  request:
    security:
      - title: Authorization
        parameters:
          query: {}
          header:
            Authorization:
              type: http
              scheme: bearer
          cookie: {}
    parameters:
      path: {}
      query: {}
      header: {}
      cookie: {}
    body:
      application/json:
        schemaArray:
          - type: object
            properties:
              gatewayId:
                allOf:
                  - description: The id of payment gateway, either gatewayId or gatewayName
                    format: '*int64'
                    properties: {}
                    type: integer
              gatewayName:
                allOf:
                  - description: >-
                      The name of payment gateway, , either gatewayId or
                      gatewayName,
                      stripe|paypal|changelly|unitpay|payssion|cryptadium
                    format: '*string'
                    properties: {}
                    type: string
            required: true
            description: Get Payment Gateway Detail
            refIdentifier: '#/components/schemas/unibee.api.merchant.gateway.DetailReq'
        examples:
          example:
            value:
              gatewayId: 123
              gatewayName: <string>
  response:
    '200':
      application/json:
        schemaArray:
          - type: object
            properties:
              code:
                allOf:
                  - format: int
                    properties: {}
                    type: integer
              data:
                allOf:
                  - properties:
                      gateway:
                        $ref: '#/components/schemas/unibee.api.bean.detail.Gateway'
                    type: object
              message:
                allOf:
                  - format: string
                    properties: {}
                    type: string
              redirect:
                allOf:
                  - format: string
                    properties: {}
                    type: string
              requestId:
                allOf:
                  - format: string
                    properties: {}
                    type: string
        examples:
          example:
            value:
              code: 123
              data:
                gateway:
                  IsSetupFinished: true
                  archive: true
                  autoChargeEnabled: true
                  bank:
                    accountHolder: <string>
                    accountNumber: <string>
                    address: <string>
                    bankName: <string>
                    bic: <string>
                    bsbCode: <string>
                    iban: <string>
                    swiftCode: <string>
                  countryConfig: {}
                  createTime: 123
                  currency: <string>
                  currencyExchange:
                    - exchange_rate: 123
                      from_currency: <string>
                      to_currency: <string>
                  currencyExchangeEnabled: true
                  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>
                  gatewaySecret: <string>
                  gatewayType: 123
                  gatewayWebhookIntegrationLink: <string>
                  gatewayWebsiteLink: <string>
                  minimumAmount: 123
                  name: <string>
                  privateSecretName: <string>
                  publicKeyName: <string>
                  setupGatewayPaymentTypes:
                    - autoCharge: true
                      category: <string>
                      countryName: <string>
                      name: <string>
                      paymentType: <string>
                  sort: 123
                  subGateway: <string>
                  subGatewayName: <string>
                  webhookEndpointUrl: <string>
                  webhookSecret: <string>
              message: <string>
              redirect: <string>
              requestId: <string>
        description: ''
  deprecated: false
  type: path
components:
  schemas:
    unibee.api.bean.detail.Gateway:
      properties:
        IsSetupFinished:
          description: Whether the gateway finished setup process
          format: bool

```

--------------------------------

### POST /merchant/gateway/setup_exchange_rate_api

Source: https://docs.unibee.dev/api-reference/gateway/exchange-rate-api-setup

Sets up the exchange rate API by providing the necessary API key. This endpoint allows merchants to integrate with a third-party exchange rate service.

```APIDOC
## POST /merchant/gateway/setup_exchange_rate_api

### Description
Sets up the exchange rate API by providing the necessary API key. This endpoint allows merchants to integrate with a third-party exchange rate service.

### Method
POST

### Endpoint
/merchant/gateway/setup_exchange_rate_api

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **exchangeRateApiKey** (string) - Required - The key of the exchange rate API.

### Request Example
```json
{
  "exchangeRateApiKey": "<string>"
}
```

### Response
#### Success Response (200)
- **code** (integer) - The status code of the response.
- **data** (object) - Contains the response data.
  - **data** (string) - The hide star key of the exchange rate API.
- **message** (string) - The message associated with the response.
- **redirect** (string) - A URL for redirection, if applicable.
- **requestId** (string) - A unique identifier for the request.

#### Response Example
```json
{
  "code": 123,
  "data": {
    "data": "<string>"
  },
  "message": "<string>",
  "redirect": "<string>",
  "requestId": "<string>"
}
```
```
Tokens:
Raw