> ## Documentation Index
> Fetch the complete documentation index at: https://docs.zbx.boomfi.xyz/llms.txt
> Use this file to discover all available pages before exploring further.

# Create Payout

> Create a payout to a crypto wallet address. Requires request signature headers. When authenticated with a Bearer session, also requires X-Step-Up-Token.



## OpenAPI

````yaml /openapi.yaml post /accounts/virtual/payout/address
openapi: 3.1.0
info:
  contact:
    email: support@boomfi.xyz
    name: API Support
  description: >-
    The BoomFi Merchants API provides a set of endpoints for merchants to manage
    their accounts, transactions, and more. Hosts differ per brand/environment;
    use the brand-specific base URL from the docs.
  title: ZBX Merchants API
  version: '1.0'
servers:
  - url: https://mapi.zbx.boomfi.xyz/v1
    description: Production
security: []
tags:
  - description: Payment links
    name: Paylinks
  - description: Billing plans
    name: Plans
  - description: Subscriptions
    name: Subscriptions
  - description: Customer records
    name: Customers
  - description: Invoices
    name: Invoices
  - description: Payments
    name: Payments
  - description: Organisation events
    name: Events
  - description: Organisation profile and display settings
    name: Organisation
  - description: Webhook and request-signing secrets
    name: Secrets
  - description: Settlement accounts
    name: Accounts
  - name: Bank Address Book
  - description: Managed virtual accounts, balances, pay-in, and payout
    name: Virtual Accounts
  - description: Partner-managed accounts, virtual accounts, pay-in, and payout
    name: Partners
  - description: Partner virtual account automations and run history
    name: Partner Automations
  - description: Partner maintain-balance automations
    name: Partner Balance Monitoring
  - description: Tradeable currencies, instruments, and swap targets
    name: Instruments
  - description: RFQ quotes
    name: Quotes
  - description: RFQ orders and one-click trades
    name: Orders
  - description: Executed trades
    name: Trades
paths:
  /accounts/virtual/payout/address:
    post:
      tags:
        - Virtual Accounts
      summary: Create Payout
      description: >-
        Create a payout to a crypto wallet address. Requires request signature
        headers. When authenticated with a Bearer session, also requires
        X-Step-Up-Token.
      parameters:
        - description: >-
            Step-up token required for Bearer/session auth (ignored for API-key
            auth)
          in: header
          name: X-Step-Up-Token
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/accounts.CreatePayoutToWalletAddressRequest'
        description: body
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/internal.Response-accounts_PaymentResponse
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/internal.ErrorResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/internal.ErrorResponse'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/internal.ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/internal.ErrorResponse'
      security:
        - ApiKeyAuth: []
          ApiNonce: []
          ApiSignature: []
components:
  schemas:
    accounts.CreatePayoutToWalletAddressRequest:
      properties:
        amount:
          description: Amount to send (token units as a decimal string).
          example: '10.5'
          type: string
        ccy:
          description: Token/currency symbol to send.
          example: USDC
          type: string
        chain_id:
          description: Destination chain ID.
          example: 8453
          type: integer
        metadata:
          additionalProperties: {}
          description: Optional payout metadata returned on the payment record.
          type: object
        reference:
          description: Optional client reference (max 1024 chars).
          maxLength: 1024
          type: string
        token_address:
          description: Token contract address when not the native asset.
          type: string
        wallet_address:
          description: Destination wallet address.
          type: string
      required:
        - amount
        - ccy
        - chain_id
        - wallet_address
      type: object
    internal.Response-accounts_PaymentResponse:
      properties:
        data:
          allOf:
            - $ref: '#/components/schemas/accounts.PaymentResponse'
          description: Response payload when the request succeeded.
        error:
          description: True when the request failed.
          type: boolean
        message:
          description: Human-readable status or error message.
          type: string
      type: object
    internal.ErrorResponse:
      properties:
        error:
          allOf:
            - $ref: '#/components/schemas/internal.ErrorStruct'
          description: Error details including HTTP-style code and message.
      type: object
    accounts.PaymentResponse:
      properties:
        amount:
          description: Amount as a decimal string in major units.
          type: string
        created_at:
          description: When the resource was created (RFC3339).
          type: string
        currency:
          description: Currency symbol (for example USDC or USD).
          type: string
        customer:
          allOf:
            - $ref: '#/components/schemas/models.Customer'
          description: Customer associated with this resource.
        customer_id:
          description: Unique identifier of the customer linked to this resource.
          type: string
        id:
          description: Unique resource identifier.
          type: string
        invoice_id:
          description: Unique identifier of the invoice linked to this resource.
          type: string
        next_action:
          description: Next client action required to continue the flow.
          type: string
        org_id:
          description: Organisation ID that owns this resource.
          type: string
        parent_id:
          description: Identifier of the parent resource, when nested.
          type: string
        payment_method:
          allOf:
            - $ref: '#/components/schemas/docenums.PaymentMethod'
          description: Payment method used for this deposit or settlement.
        properties:
          additionalProperties: {}
          description: Additional properties as a key-value map.
          type: object
        reference:
          description: Merchant-defined reference string.
          type: string
        scheduled_time:
          description: When the action is scheduled to run (RFC3339).
          type: integer
        source:
          allOf:
            - $ref: '#/components/schemas/docenums.BillingSource'
          description: Origin system or integration that created this resource.
        status:
          allOf:
            - $ref: '#/components/schemas/docenums.PaymentStatus'
          description: Status of this resource.
        updated_at:
          description: When the resource was last updated (RFC3339).
          type: string
      type: object
    internal.ErrorStruct:
      properties:
        code:
          description: |-
            Error code
            Example: 400
          example: 400
          type: integer
        errors:
          description: List of errors
          items:
            $ref: '#/components/schemas/internal.SingleError'
          type: array
        message:
          description: |-
            Error message
            Example: Insufficient quantity
          example: Insufficient quantity
          type: string
      type: object
    models.Customer:
      properties:
        created_at:
          description: When the resource was created (RFC3339).
          type: string
        deleted_at:
          description: When the resource was soft-deleted (RFC3339), if applicable.
          type: string
        email:
          description: Email address.
          type: string
        id:
          description: Unique resource identifier.
          type: string
        metadata:
          description: Arbitrary merchant-defined metadata.
          items:
            type: integer
          type: array
        name:
          description: Display name.
          type: string
        org_id:
          description: Organisation ID that owns this resource.
          type: string
        phone:
          description: Phone number.
          type: string
        properties:
          description: Additional properties as a key-value map.
          items:
            type: integer
          type: array
        reference:
          description: Merchant-defined reference string.
          type: string
        updated_at:
          description: When the resource was last updated (RFC3339).
          type: string
        wallet_address:
          description: Blockchain wallet address.
          type: string
      type: object
    docenums.PaymentMethod:
      enum:
        - Unknown
        - MerchantContract
        - ProxyWallet
        - Unblock
        - Payout
        - Card
        - GooglePay
        - ApplePay
        - Paypal
        - DirectDebit
        - Ramp
        - RampCryptoSettlement
        - Refund
        - Deposit
      type: string
      x-enum-varnames:
        - PaymentMethodUnknown
        - PaymentMethodMerchantContract
        - PaymentMethodProxyWallet
        - PaymentMethodUnblock
        - PaymentMethodPayout
        - PaymentMethodCard
        - PaymentMethodGooglePay
        - PaymentMethodApplePay
        - PaymentMethodPaypal
        - PaymentMethodDirectDebit
        - PaymentMethodRamp
        - PaymentMethodRampCryptoSettlement
        - PaymentMethodRefund
        - PaymentMethodDeposit
    docenums.BillingSource:
      enum:
        - Lago
        - BoomFi
        - Stripe
        - Chargebee
        - QuickBooks
      type: string
      x-enum-varnames:
        - BillingSourceLago
        - BillingSourceBoomFi
        - BillingSourceStripe
        - BillingSourceChargebee
        - BillingSourceQuickBooks
    docenums.PaymentStatus:
      enum:
        - Unknown
        - RequiresPaymentMethod
        - RequiresConfirmation
        - RequiresAction
        - Processing
        - Succeeded
        - Canceled
        - Failed
      type: string
      x-enum-varnames:
        - PaymentStatusUnknown
        - PaymentStatusRequiresPaymentMethod
        - PaymentStatusRequiresConfirmation
        - PaymentStatusRequiresAction
        - PaymentStatusProcessing
        - PaymentStatusSucceeded
        - PaymentStatusCanceled
        - PaymentStatusFailed
    internal.SingleError:
      properties:
        domain:
          description: |-
            Domain
            Example: orders
          example: orders
          type: string
        reason:
          description: |-
            Error Reason
            Example: InsufficientQuantity
          example: InsufficientQuantity
          type: string
      type: object
  securitySchemes:
    ApiKeyAuth:
      in: header
      name: X-API-KEY
      type: apiKey
    ApiNonce:
      in: header
      name: X-API-Nonce
      type: apiKey
    ApiSignature:
      in: header
      name: X-API-Signature
      type: apiKey

````