GET/api/v1/psbt

Get a transaction proposal

Returns one transaction proposal: its status, its approval threshold, who has approved so far by name, and the Bitcoin transaction id once it has been broadcast.

AccessRequires a signed-in caller

This is the call behind the pending-movement view. Any member of the workspace can read a proposal belonging to it, which is what lets an approver see what they are being asked to approve before they sign. It reports the same movement The signing workflow describes for operators.

m and n restate the vault's threshold, and signers lists every key in the vault's signer set with the member's name and whether they have approved yet. There is no separate counter for outstanding approvals: compare m with the number of signers entries whose is_signed is true. status is one of drafting, signing, finalized, broadcast, failed, or cancelled, and txid is present once the transaction has been broadcast.

Query parameters

psbt_idstringrequired

The proposal to show, as returned by create-psbt or forward-to-vault.

workspace_idnumberrequired

The workspace the proposal belongs to. You must be a member of it.

bash

curl "$SQRL_API/api/v1/psbt?psbt_id=psbt_01HZXC9F4R&workspace_id=342" \
  -H "authorization: Bearer $SQRL_TOKEN"

const params = new URLSearchParams({
  psbt_id: "psbt_01HZXC9F4R",
  workspace_id: "342",
});
const res = await fetch(
  `${process.env.SQRL_API}/api/v1/psbt?${params}`,
  { headers: { authorization: `Bearer ${process.env.SQRL_TOKEN}` } },
);
const { status, m, signers, txid } = await res.json();

rust

let res = client
    .get(format!("{}/api/v1/psbt", api_base))
    .query(&[("psbt_id", "psbt_01HZXC9F4R"), ("workspace_id", "342")])
    .bearer_auth(&token)
    .send()
    .await?;

Response200 OK

{
"psbt_id": "psbt_01HZXC9F4R",
"wallet_id": "vault_01HZXB2K7P",
"description": "August settlement to custody partner",
"status": "broadcast",
"psbt_base64": "cHNidP8BAH0CAAAAAe1f…AAAA",
"m": 2,
"n": 3,
"created_at": "2026-08-03T11:41:55Z",
"signers": [
  { "key_id": "key_01HZX4M8QT", "is_signed": true, "name": "Ada", "surname": "Okafor" },
  { "key_id": "key_01HZX52NRB", "is_signed": true, "name": "Ben", "surname": "Iversen" },
  { "key_id": "key_01HZX5A3WD", "is_signed": false, "name": "Chi", "surname": "Nakamura" }
],
"txid": "4a7d2e9f1b…c83"
}

Was this page helpful?