Honeycluster Docs – Check if deposit is authorized

Checks whether a payment from one account to another would be authorized, considering deposit authorization settings.

{ "result": { "deposit_authorized": true, "destination_account": "rPT1Sjq2YGrBMTttX4GZHjKu9dyfzbpAYe", "ledger_index": 89012345, "source_account": "rG1QQv2nh2gr7RCZ1P8YYcBUKCCN633jCn" }, "status": "success", "type": "response", "id": 1 }

Field	Type	Description
`command` required	string	WebSocket command name
`id`	object	Client-supplied identifier to correlate requests with responses.
`source_account`	string	The account that would send a payment.
`destination_account`	string	The account that would receive a payment.
`ledger_index`	object	A ledger index (sequence number) or shortcut string identifying which ledger to use.
`ledger_hash`	string	256-bit hex hash identifying a specific ledger version.
`api_version`	object	API version for the response format. Version 2 is the default for rippled 2.0+.

Field

Type

Description

command

required

string

WebSocket command name

id

object

Client-supplied identifier to correlate requests with responses.

source_account

string

The account that would send a payment.

destination_account

string

The account that would receive a payment.

ledger_index

object

A ledger index (sequence number) or shortcut string identifying which ledger to use.

ledger_hash

string

256-bit hex hash identifying a specific ledger version.

api_version

object

API version for the response format. Version 2 is the default for rippled 2.0+.

{ "command": "deposit_authorized", "id": 1, "source_account": "rG1QQv2nh2gr7RCZ1P8YYcBUKCCN633jCn", "destination_account": "rPT1Sjq2YGrBMTttX4GZHjKu9dyfzbpAYe", "ledger_index": "validated" }

Field	Type	Description
`result`	object
`status`	enum<string>	Available `successerror`
`type`	string
`id`	stringnumber	Echo of the client-provided correlation ID

Field

Type

Description

result

object

status

enum<string>

Available

successerror

type

string

id

stringnumber

Echo of the client-provided correlation ID

const ws = new WebSocket('wss://honeycluster.io'); ws.addEventListener('open', () => { const request = { "command": "deposit_authorized", "id": 1, "source_account": "rG1QQv2nh2gr7RCZ1P8YYcBUKCCN633jCn", "destination_account": "rPT1Sjq2YGrBMTttX4GZHjKu9dyfzbpAYe", "ledger_index": "validated" }; ws.send(JSON.stringify(request)); }); ws.addEventListener('message', (event: MessageEvent<string>) => { const response: unknown = JSON.parse(event.data); console.log(response); ws.close(); });