xrp

XRP (XRP)

Method: POST channel_authorize

dropdown
POST

channel_authorize

channel_authorize 方法创建一个签名,可用于从支付渠道兑换特定数量的 XRP。

Parameters

channel_id - 细绳

要使用的支付渠道的唯一 ID。

secret - 细绳

(可选)用于签署声明的密钥。

这必须是与通道中指定的公钥相同的密钥对。

不能与种子、seed_hex 或密码一起使用。

seed - 细绳

(可选)用于签署声明的秘密种子。

这必须是与通道中指定的公钥相同的密钥对。

必须采用 XRP Ledger 的 base58 格式。

如果提供,您还必须指定 key_type。

不能与 secret、seed_hex 或密码短语一起使用。

seed_hex - 细绳

(可选)用于签署声明的秘密种子。

这必须是与通道中指定的公钥相同的密钥对。

必须是十六进制格式。如果提供,您还必须指定 key_type。

不能与秘密、种子或密码一起使用。

passphrase - 细绳

(可选)用于签署声明的字符串密码。

这必须是与通道中指定的公钥相同的密钥对。

从此密码短语派生的密钥必须与通道中指定的公钥匹配。

如果提供,您还必须指定 key_type。

不能与 secret、seed 或 seed_hex 一起使用。

key_type - 细绳

(可选)提供的加密密钥对的签名算法。

有效类型为 secp256k1 或 ed25519。默认值为 secp256k1。

amount - 细绳

授权的 XRP 累积量(以滴计)。

如果目的地已经从该渠道收到较少数量的 XRP,则可以用此方法创建的签名来弥补差额。

Request

curl --location --request POST 'https://xrp.getblock.io/mainnet/' 
--header 'x-api-key: YOUR-API-KEY' 
--header 'Content-Type: application/json' 
--data-raw '{"jsonrpc": "2.0",
"method": "channel_authorize",
"params": [{"channel_id": "5DB01B7FFED6B67E6B0414DED11E051D2EE2B7619CE0EAA6286D67A3A4D5BDB3", "amount": 1000000}],
"id": "getblock.io"}'


Response

{
    "result": {
        "error": "invalidParams",
        "error_code": 31,
        "error_message": "Missing field 'secret'.",
        "request": {
            "amount": 1000000,
            "channel_id": "5DB01B7FFED6B67E6B0414DED11E051D2EE2B7619CE0EAA6286D67A3A4D5BDB3",
            "command": "channel_authorize"
        },
        "status": "error"
    }
}