Skip to content

Get transfer proposals to a Canton account

GET/accounts/{id}/canton/transfer-proposals

Path parameters

NameTypeDescriptionRequired
id
string
Id of the target Canton account

Response schema

Array<{
// Transfer amount
amount: string;
// ID of the transfer-proposal contract
contractId: string;
// ID of the instrument being transferred
instrumentId: string;
// Expiration timestamp in microseconds
expiresAtMicros: number;
// Optional note attached to the proposal
memo: string | null;
// Party proposing to send the asset
sender: string;
// Intended recipient of the proposed transfer
recipient: string;
}
>

Examples

bash
curl \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer {jwt}" \
  "$API_BASE_URL/accounts/{id}/canton/transfer-proposals"
ts
const url = "<base-url>/accounts/{id}/canton/transfer-proposals";

const headers = {
  "Content-Type": "application/json",
  Authorization: "Bearer <jwt>"
};

fetch(url, { headers }).then(res => {
  console.log(res)
});
python
import requests

url = "<base-url>/accounts/{id}/canton/transfer-proposals"

headers = {
  "Content-Type": "application/json",
  "Authorization": "Bearer <jwt>"
}

print(requests.get(url, headers=headers))