Jump to

• Request
• Response

Initialize Deposit Token

post

{baseUrl}/v1/{tokenizedDepositContractAddress}/initializeDepositToken

Initializes the deposit token with its token address, currency, and conversion rate.

Request

Path Parameters

• tokenizedDepositContractAddress(required): string
  Path parameter derived from Postman variable tokenizedDepositContractAddress

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• conversionRate: integer
  Example: 0
• currency: string
  Example: currency value
• token: string
  Example: {"tokenId":"tokenId value","tokenName":"tokenName value","tokenDesc":"tokenDesc value","tokenStandard":"tokenStandard value","tokenType":"tokenType value","tokenUnit":"tokenUnit value","behaviors":["behaviors value"],"decimals":"decimals value","mintable":{"maxMintQuantity":"maxMintQuantity value","mintApprovalRequired":"mintApprovalRequired value"},"burnable":{"burnApprovalRequired":"burnApprovalRequired value"}}
• walletId: string
  Example: {{walletId}}

{
    "type":"object",
    "properties":{
        "walletId":{
            "type":"string",
            "example":"{{walletId}}"
        },
        "token":{
            "type":"string",
            "example":"{\"tokenId\":\"tokenId value\",\"tokenName\":\"tokenName value\",\"tokenDesc\":\"tokenDesc\nvalue\",\"tokenStandard\":\"tokenStandard value\",\"tokenType\":\"tokenType\nvalue\",\"tokenUnit\":\"tokenUnit value\",\"behaviors\":[\"behaviors value\"],\"decimals\":\"decimals\nvalue\",\"mintable\":{\"maxMintQuantity\":\"maxMintQuantity value\",\"mintApprovalRequired\":\"mintApprovalRequired\nvalue\"},\"burnable\":{\"burnApprovalRequired\":\"burnApprovalRequired\nvalue\"}}"
        },
        "currency":{
            "type":"string",
            "example":"currency value"
        },
        "conversionRate":{
            "type":"integer",
            "example":0
        }
    },
    "example":{
        "walletId":"{{walletId}}",
        "token":"{\"tokenId\":\"tokenId value\",\"tokenName\":\"tokenName value\",\"tokenDesc\":\"tokenDesc\nvalue\",\"tokenStandard\":\"tokenStandard value\",\"tokenType\":\"tokenType\nvalue\",\"tokenUnit\":\"tokenUnit value\",\"behaviors\":[\"behaviors value\"],\"decimals\":\"decimals\nvalue\",\"mintable\":{\"maxMintQuantity\":\"maxMintQuantity value\",\"mintApprovalRequired\":\"mintApprovalRequired\nvalue\"},\"burnable\":{\"burnApprovalRequired\":\"burnApprovalRequired\nvalue\"}}",
        "currency":"currency value",
        "conversionRate":0
    }
}

Example:

{
    "walletId":"{{walletId}}",
    "token":"{\"tokenId\":\"tokenId value\",\"tokenName\":\"tokenName value\",\"tokenDesc\":\"tokenDesc\nvalue\",\"tokenStandard\":\"tokenStandard value\",\"tokenType\":\"tokenType\nvalue\",\"tokenUnit\":\"tokenUnit value\",\"behaviors\":[\"behaviors value\"],\"decimals\":\"decimals\nvalue\",\"mintable\":{\"maxMintQuantity\":\"maxMintQuantity value\",\"mintApprovalRequired\":\"mintApprovalRequired\nvalue\"},\"burnable\":{\"burnApprovalRequired\":\"burnApprovalRequired\nvalue\"}}",
    "currency":"currency value",
    "conversionRate":0
}

Security

• OAuth2Password: oauth2
  Type: oauth2

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful rpc-proxy transaction response.

Body ()

Root Schema : RpcProxy_TransactionSuccessResponse

Type: object

Show Source

• data(required): string
  Pattern: ^0x[a-fA-F0-9]*$
• decoded: object decoded
• from(required): string
  Pattern: ^0x[a-fA-F0-9]{40}$
• nonce(required): string
• operation(required): string
• rawResult(required): string
  Pattern: ^0x[a-fA-F0-9]*$
• to(required): string
  Pattern: ^0x[a-fA-F0-9]{40}$
• txHash(required): string
  Pattern: ^0x[a-fA-F0-9]{64}$

{
    "type":"object",
    "required":[
        "operation",
        "from",
        "txHash",
        "rawResult",
        "to",
        "data",
        "nonce"
    ],
    "properties":{
        "operation":{
            "type":"string"
        },
        "from":{
            "type":"string",
            "pattern":"^0x[a-fA-F0-9]{40}$"
        },
        "txHash":{
            "type":"string",
            "pattern":"^0x[a-fA-F0-9]{64}$"
        },
        "rawResult":{
            "type":"string",
            "pattern":"^0x[a-fA-F0-9]*$"
        },
        "to":{
            "type":"string",
            "pattern":"^0x[a-fA-F0-9]{40}$"
        },
        "data":{
            "type":"string",
            "pattern":"^0x[a-fA-F0-9]*$"
        },
        "nonce":{
            "type":"string"
        },
        "decoded":{
            "type":"object",
            "properties":{
                "meta":{
                    "$ref":"#/components/schemas/RpcProxy_DecodedMeta"
                },
                "function":{
                    "$ref":"#/components/schemas/RpcProxy_DecodedFunction"
                },
                "events":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "name":{
                                "type":"string"
                            },
                            "signature":{
                                "type":"string"
                            },
                            "address":{
                                "type":"string"
                            },
                            "logIndex":{
                                "type":"integer"
                            },
                            "topics":{
                                "type":"array",
                                "items":{
                                    "type":"string"
                                }
                            },
                            "data":{
                                "type":"string"
                            },
                            "args":{
                                "type":"array",
                                "items":{
                                    "$ref":"#/components/schemas/RpcProxy_DecodedValue"
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : decoded

Type: object

Show Source

• events: array events
• function: object RpcProxy_DecodedFunction
• meta: object RpcProxy_DecodedMeta

{
    "type":"object",
    "properties":{
        "meta":{
            "$ref":"#/components/schemas/RpcProxy_DecodedMeta"
        },
        "function":{
            "$ref":"#/components/schemas/RpcProxy_DecodedFunction"
        },
        "events":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "name":{
                        "type":"string"
                    },
                    "signature":{
                        "type":"string"
                    },
                    "address":{
                        "type":"string"
                    },
                    "logIndex":{
                        "type":"integer"
                    },
                    "topics":{
                        "type":"array",
                        "items":{
                            "type":"string"
                        }
                    },
                    "data":{
                        "type":"string"
                    },
                    "args":{
                        "type":"array",
                        "items":{
                            "$ref":"#/components/schemas/RpcProxy_DecodedValue"
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : events

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "name":{
                "type":"string"
            },
            "signature":{
                "type":"string"
            },
            "address":{
                "type":"string"
            },
            "logIndex":{
                "type":"integer"
            },
            "topics":{
                "type":"array",
                "items":{
                    "type":"string"
                }
            },
            "data":{
                "type":"string"
            },
            "args":{
                "type":"array",
                "items":{
                    "$ref":"#/components/schemas/RpcProxy_DecodedValue"
                }
            }
        }
    }
}

Nested Schema : RpcProxy_DecodedFunction

Type: object

Show Source

• name: string
• selector: string
  Pattern: ^0x[a-fA-F0-9]{8}$
• signature: string

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "signature":{
            "type":"string"
        },
        "selector":{
            "type":"string",
            "pattern":"^0x[a-fA-F0-9]{8}$"
        }
    }
}

Nested Schema : RpcProxy_DecodedMeta

Type: object

Show Source

• abiSource: string
• issues: array issues

{
    "type":"object",
    "properties":{
        "abiSource":{
            "type":"string"
        },
        "issues":{
            "type":"array",
            "items":{
                "type":"object",
                "additionalProperties":true
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• address: string
• args: array args
• data: string
• logIndex: integer
• name: string
• signature: string
• topics: array topics

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "signature":{
            "type":"string"
        },
        "address":{
            "type":"string"
        },
        "logIndex":{
            "type":"integer"
        },
        "topics":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "data":{
            "type":"string"
        },
        "args":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/RpcProxy_DecodedValue"
            }
        }
    }
}

Nested Schema : args

Type: array

Show Source

• Array of: object RpcProxy_DecodedValue

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/RpcProxy_DecodedValue"
    }
}

Nested Schema : topics

Type: array

Show Source

• Array of: string

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

Nested Schema : RpcProxy_DecodedValue

Type: object

Show Source

• indexed: boolean
• name(required): string
• type(required): string
  Solidity ABI type.
• value(required):
  ABI-decoded value; representation varies by Solidity type.

{
    "type":"object",
    "required":[
        "name",
        "type",
        "value"
    ],
    "properties":{
        "name":{
            "type":"string"
        },
        "type":{
            "type":"string",
            "description":"Solidity ABI type."
        },
        "indexed":{
            "type":"boolean"
        },
        "value":{
            "description":"ABI-decoded value; representation varies by Solidity type."
        }
    }
}

Nested Schema : issues

Type: array

Show Source

• Array of: object items
  Additional Properties Allowed: true

{
    "type":"array",
    "items":{
        "type":"object",
        "additionalProperties":true
    }
}

Nested Schema : items

Type: object

Additional Properties Allowed: true

400 Response

Wrapper validation failure or rpc-proxy bad-request response.

404 Response

Unregistered endpoint or rpc-proxy not-found response.

502 Response

Wrapper-to-rpc-proxy failure or rpc-proxy gateway response.

Default Response

rpc-proxy status, content type, and response body are passed through unchanged.

Back to Top