The channel_authorize method requires the request to include one of the following parameters: 'secret', 'seed', 'seed_hex', or 'passphrase', specifying the necessary authentication information. Please refrain from transmitting secret keys to untrusted servers or via unsecured network connections (This includes the secret, seed, seed_hex, or passphrase fields of this request). You should only use this method on a secure, encrypted network connection to a server you run or fully trust with your funds. Failure to do so may expose your secret key to eavesdroppers, enabling them to sign claims and access all funds within the payment channel and any other systems utilizing the same key pair. For detailed instructions, refer to the Set Up Secure Signing guidelines.

Parameters

object

object

REQUIRED

The channel_authorize request object.

channel_id

string

REQUIRED

The payment channel identified by its unique ID

seed

string

The secret key used to sign the claim

key_type

string

The signing algorithm for the provided cryptographic key pair. It can be either 'secp256k1' or 'ed25519'. The default signing algorithm is 'secp256k1'

amount

string

REQUIRED

The cumulative amount of XRP, expressed in drops, used for authorization in the payment channel

Returns

result

object

An object which contains the following fields:

signature

string

The signature for the claim, provided as a hexadecimal value

status

string

The authorization status

warnings

array

An array of warning objects, each containing the following fields:

id

integer

The ID of the warning

message

string

The warning message

Request

1
curl -X POST "https://docs-demo.xrp-mainnet.quiknode.pro/" \
2
  -H "Content-Type: application/json" \
3
  -d '{
4
  "jsonrpc": "2.0",
5
  "method": "channel_authorize",
6
  "params": [
7
    {
8
      "channel_id": "5DB01B7FFED6B67E6B0414DED11E051D2EE2B7619CE0EAA6286D67A3A4D5BDB3",
9
      "seed": "SECRET_SEED",
10
      "key_type": "secp256k1",
11
      "amount": "1000000"
12
    }
13
  ],
14
  "id": 1
15
}'

1
curl -X POST "https://docs-demo.xrp-mainnet.quiknode.pro/" \
2
  -H "Content-Type: application/json" \
3
  -d '{
4
  "jsonrpc": "2.0",
5
  "method": "channel_authorize",
6
  "params": [
7
    {
8
      "channel_id": "5DB01B7FFED6B67E6B0414DED11E051D2EE2B7619CE0EAA6286D67A3A4D5BDB3",
9
      "seed": "SECRET_SEED",
10
      "key_type": "secp256k1",
11
      "amount": "1000000"
12
    }
13
  ],
14
  "id": 1
15
}'

1
const body = {
2
    jsonrpc: '2.0',
3
    method: 'channel_authorize',
4
    params: [{"channel_id":"5DB01B7FFED6B67E6B0414DED11E051D2EE2B7619CE0EAA6286D67A3A4D5BDB3","seed":"SECRET_SEED","key_type":"secp256k1","amount":"1000000"}],
5
    id: 1
6
}
7

8
async function main() {
9
    const response = await fetch('https://docs-demo.xrp-mainnet.quiknode.pro/', {
10
        method: 'POST',
11
        headers: {'Content-Type': 'application/json'},
12
        body: JSON.stringify(body)
13
    })
14
    const data = await response.json()
15
    console.log(data)
16
}
17

18
main()

1
const body = {
2
    jsonrpc: '2.0',
3
    method: 'channel_authorize',
4
    params: [{"channel_id":"5DB01B7FFED6B67E6B0414DED11E051D2EE2B7619CE0EAA6286D67A3A4D5BDB3","seed":"SECRET_SEED","key_type":"secp256k1","amount":"1000000"}],
5
    id: 1
6
}
7

8
async function main() {
9
    const response = await fetch('https://docs-demo.xrp-mainnet.quiknode.pro/', {
10
        method: 'POST',
11
        headers: {'Content-Type': 'application/json'},
12
        body: JSON.stringify(body)
13
    })
14
    const data = await response.json()
15
    console.log(data)
16
}
17

18
main()

1
import requests
2
import json
3

4
url = "https://docs-demo.xrp-mainnet.quiknode.pro/"
5

6
payload = json.dumps({
7
  "jsonrpc": "2.0",
8
  "method": "channel_authorize",
9
  "params": [
10
    {
11
      "channel_id": "5DB01B7FFED6B67E6B0414DED11E051D2EE2B7619CE0EAA6286D67A3A4D5BDB3",
12
      "seed": "SECRET_SEED",
13
      "key_type": "secp256k1",
14
      "amount": "1000000"
15
    }
16
  ],
17
  "id": 1
18
})
19
headers = {
20
  'Content-Type': 'application/json'
21
}
22

23
response = requests.request("POST", url, headers=headers, data=payload)
24

25
print(response.text)

1
import requests
2
import json
3

4
url = "https://docs-demo.xrp-mainnet.quiknode.pro/"
5

6
payload = json.dumps({
7
  "jsonrpc": "2.0",
8
  "method": "channel_authorize",
9
  "params": [
10
    {
11
      "channel_id": "5DB01B7FFED6B67E6B0414DED11E051D2EE2B7619CE0EAA6286D67A3A4D5BDB3",
12
      "seed": "SECRET_SEED",
13
      "key_type": "secp256k1",
14
      "amount": "1000000"
15
    }
16
  ],
17
  "id": 1
18
})
19
headers = {
20
  'Content-Type': 'application/json'
21
}
22

23
response = requests.request("POST", url, headers=headers, data=payload)
24

25
print(response.text)

1
require "uri"
2
require "json"
3
require "net/http"
4

5
uri = URI("https://docs-demo.xrp-mainnet.quiknode.pro/")
6

7
payload = {
8
  jsonrpc: "2.0",
9
  id: 1,
10
  method: "channel_authorize",
11
  params: [{"channel_id":"5DB01B7FFED6B67E6B0414DED11E051D2EE2B7619CE0EAA6286D67A3A4D5BDB3","seed":"SECRET_SEED","key_type":"secp256k1","amount":"1000000"}]
12
}
13

14
request = Net::HTTP::Post.new(uri)
15
request["Content-Type"] = "application/json"
16
request.body = JSON.generate(payload)
17

18
response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) do |http|
19
  http.request(request)
20
end
21

22
puts response.body

1
require "uri"
2
require "json"
3
require "net/http"
4

5
uri = URI("https://docs-demo.xrp-mainnet.quiknode.pro/")
6

7
payload = {
8
  jsonrpc: "2.0",
9
  id: 1,
10
  method: "channel_authorize",
11
  params: [{"channel_id":"5DB01B7FFED6B67E6B0414DED11E051D2EE2B7619CE0EAA6286D67A3A4D5BDB3","seed":"SECRET_SEED","key_type":"secp256k1","amount":"1000000"}]
12
}
13

14
request = Net::HTTP::Post.new(uri)
15
request["Content-Type"] = "application/json"
16
request.body = JSON.generate(payload)
17

18
response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) do |http|
19
  http.request(request)
20
end
21

22
puts response.body

Response

1
{
2
  "jsonrpc": "2.0",
3
  "id": 1,
4
  "result": {
5
    "result": {
6
      "signature": "example_value",
7
      "status": "example_value"
8
    },
9
    "warnings": [
10
      {
11
        "id": 1,
12
        "message": "example_value"
13
      }
14
    ]
15
  }
16
}

1
{
2
  "jsonrpc": "2.0",
3
  "id": 1,
4
  "result": {
5
    "result": {
6
      "signature": "example_value",
7
      "status": "example_value"
8
    },
9
    "warnings": [
10
      {
11
        "id": 1,
12
        "message": "example_value"
13
      }
14
    ]
15
  }
16
}

Don't have an account yet?

Create your Quicknode endpoint in seconds and start building

Get started for free