Jump to

• Request
• Response

Create Wallet Transfer

post

/walletservice/v1/wallets/{walletAddress}/transfers

Submit a native or token transfer from the specified wallet.

Request

Path Parameters

• walletAddress(required): string
  Wallet address in hex format (0x + 40 hex chars).

  Example:

  0xFE3B557E8Fb62b89F4916B721be55cEb828dBd73

Query Parameters

• chainId: string
• rpcUrl: string(uri)
• submissionMode: string
  Submission behavior for wallet transfers.

  Default Value: async

  Allowed Values: [ "async", "sync", "callback" ]

  Example:

  sync

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• amount(required): string
  Example: 90000000000000
• contractAddress: string
  Optional contract address (used for token transfers).

  Example: 0x9a626f29784501056687dc267966dae6414cc91f
• kind: string
  Allowed Values: [ "native", "erc20" ]

  Example: native
• memo: string
  Example: {{$randomCatchPhrase}}
• priority: string
  Example: Standard
• to(required): string
  Example: 0x14d5382e4c0D0707715822Bc0cfAF99d309D5584

{
    "type":"object",
    "properties":{
        "to":{
            "type":"string",
            "example":"0x14d5382e4c0D0707715822Bc0cfAF99d309D5584"
        },
        "amount":{
            "type":"string",
            "example":"90000000000000"
        },
        "memo":{
            "type":"string",
            "example":"{{$randomCatchPhrase}}"
        },
        "priority":{
            "type":"string",
            "example":"Standard"
        },
        "kind":{
            "type":"string",
            "enum":[
                "native",
                "erc20"
            ],
            "example":"native"
        },
        "contractAddress":{
            "type":"string",
            "description":"Optional contract address (used for token transfers).",
            "example":"0x9a626f29784501056687dc267966dae6414cc91f"
        }
    },
    "required":[
        "to",
        "amount"
    ]
}

Examples

Select an example nativeTransfer erc20Transfer erc20AlternativeContract

Security

• bearerAuth: http
  Type: http

Back to Top

Response

Supported Media Types

• application/json

200 Response

Transfer submitted successfully.

Body ()

Root Schema : TransferSubmissionResponse

Type: object

Additional Properties Allowed: true

Transfer submission response returned by wallet service provider.

400 Response

Bad request.

Body ()

Root Schema : Error

Type: object

Show Source

• code: string
  Example: bad_request
• details: array details
• message(required): string
  Example: The request could not be processed.

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "example":"bad_request"
        },
        "message":{
            "type":"string",
            "example":"The request could not be processed."
        },
        "details":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    },
    "required":[
        "message"
    ]
}

Nested Schema : details

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

500 Response

Internal server error.

Body ()

Root Schema : Error

Type: object

Show Source

• code: string
  Example: bad_request
• details: array details
• message(required): string
  Example: The request could not be processed.

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "example":"bad_request"
        },
        "message":{
            "type":"string",
            "example":"The request could not be processed."
        },
        "details":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    },
    "required":[
        "message"
    ]
}

Nested Schema : details

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Back to Top