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

# Generate metadata for Native Token Transfer application

> Creates metadata configuration for transferring native tokens (like AVAX, ETH, MATIC) on a single blockchain network.



## OpenAPI

````yaml /api-reference/openapi.json post /action/builders/transfer-native
openapi: 3.0.0
info:
  title: Relayer
  description: >-
    Relayer API — Kit-based crypto infrastructure for OTC exchange, wallet
    signing, payouts, and widget actions.
  version: '1.0'
  contact: {}
servers:
  - url: https://testnet.relayer.fi/v1
    description: Sandbox (testnet wallets, no real fiat)
  - url: https://api.relayer.fi/v1
    description: Production (mainnet wallets, regulated fiat rails)
security:
  - api-key: []
tags:
  - name: 'Action: Builders'
    description: Transaction metadata builders
  - name: 'Action: Directory'
    description: Widget directory
  - name: 'Action: Execute'
  - name: 'Action: Tokens'
    description: Token lists per chain/protocol
  - name: Addresses
  - name: Agents
  - name: App
    description: Application endpoints
  - name: 'Payout: Accounts'
    description: Payment execution
  - name: 'Payout: Off-ramp'
  - name: 'Payout: On-ramp'
  - name: 'Payout: Orders'
  - name: 'Payout: Recipients'
    description: Beneficiary management
  - name: Signing - Passkeys
  - name: Signing - Recovery
  - name: Signing Approvals
    description: Transaction signing approvals
  - name: Signing Policies
    description: Signing policy management
  - name: Transactions
    description: Transaction signing and broadcasting
  - name: Wallets
    description: Wallet and address management
paths:
  /action/builders/transfer-native:
    post:
      tags:
        - 'Action: Builders'
      summary: Generate metadata for Native Token Transfer application
      description: >-
        Creates metadata configuration for transferring native tokens (like
        AVAX, ETH, MATIC) on a single blockchain network.
      operationId: WidgetMetadataController_generateTransferNativeMetadata
      parameters: []
      requestBody:
        required: true
        description: Parameters for generating native token transfer metadata
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TransferMetadataDto'
            examples:
              AVAX Transfer on Avalanche:
                value:
                  title: Transfer AVAX
                  description: Send AVAX to another address on Avalanche network
                  icon: https://example.com/avax-icon.png
                  url: https://example.com/transfer
                  address: '0xb00D916688FEE4aB6646994104E1441446947fc9'
                  chainId: 43114
                description: Transfer AVAX on Avalanche C-Chain (43114)
              ETH Transfer on Ethereum:
                value:
                  title: Transfer ETH
                  description: Send ETH to another address on Ethereum network
                  icon: https://example.com/eth-icon.png
                  url: https://example.com/transfer-eth
                  address: '0xb00D916688FEE4aB6646994104E1441446947fc9'
                  chainId: 1
                description: Transfer ETH on Ethereum mainnet (1)
      responses:
        '200':
          description: Native token transfer metadata generated successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                  metadata:
                    type: object
                    description: Generated metadata for native token transfer
        '400':
          description: >-
            Bad Request - Invalid parameters provided (e.g., invalid chain ID,
            invalid address format)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponseDto'
        '401':
          description: Unauthorized - Invalid or missing API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponseDto'
        '403':
          description: >-
            Forbidden - Insufficient permissions. Requires INTERNAL or
            INTEGRATOR scope (ADMIN scope also allowed)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponseDto'
        '500':
          description: Internal Server Error - Failed to generate metadata
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponseDto'
      security:
        - api-key: []
      x-codeSamples:
        - lang: bash
          label: cURL
          source: >-
            curl -X POST
            https://api.relayer.fi/v1/action/builders/transfer-native \
              -H "Authorization: ApiKey $RELAYER_API_KEY" \
              -H "Content-Type: application/json" \
              -d '{
                "chain":  "base",
                "to":     "0xRecipient...",
                "amount": "0.05"
              }'
        - lang: TypeScript
          label: Node.js
          source: >-
            const response = await
            fetch("https://api.relayer.fi/v1/action/builders/transfer-native", {
              method: "POST",
              headers: {
                Authorization: `ApiKey ${process.env.RELAYER_API_KEY}`,
                "Content-Type": "application/json",
              },
              body: JSON.stringify({ chain: "base", to: recipientAddress, amount: "0.05" }),
            });

            // Returns metadata for a native-token transfer widget (ETH, MATIC,
            etc.).
components:
  schemas:
    TransferMetadataDto:
      type: object
      properties:
        title:
          type: string
          description: The name of the blockchain network (e.g., ethereum, polygon).
        description:
          type: string
          description: The name of the blockchain network (e.g., ethereum, polygon).
        icon:
          type: string
          description: The Twitter handle of the recipient (without @).
        url:
          type: string
          description: The name of the blockchain network (e.g., ethereum, polygon).
        address:
          type: string
          description: The name of the blockchain network (e.g., ethereum, polygon).
        chainId:
          type: number
          description: The name of the blockchain network (e.g., ethereum, polygon).
      required:
        - title
        - description
        - url
        - address
        - chainId
    ApiResponseDto:
      type: object
      properties:
        success:
          type: boolean
        message:
          type: string
        data:
          type: object
        statusCode:
          type: number
        timestamp:
          type: string
        path:
          type: string
        traceId:
          type: string
      required:
        - success
        - message
        - statusCode
        - timestamp
  securitySchemes:
    api-key:
      type: apiKey
      in: header
      name: Authorization
      description: 'Use this format: `ApiKey <your_api_key>`'

````