Send a completed withdrawal to another Canton Party
curl --request POST \
--url https://testnet.edel-api.xyz/v1/withdrawals/{withdrawalId}/party-transfer \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--data '
{
"withdrawalId": "{{withdrawalId}}",
"receiverPartyId": "receiver-wallet::12200f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f"
}
'import requests
url = "https://testnet.edel-api.xyz/v1/withdrawals/{withdrawalId}/party-transfer"
payload = {
"withdrawalId": "{{withdrawalId}}",
"receiverPartyId": "receiver-wallet::12200f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f"
}
headers = {
"Idempotency-Key": "<idempotency-key>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'Idempotency-Key': '<idempotency-key>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
withdrawalId: '{{withdrawalId}}',
receiverPartyId: 'receiver-wallet::12200f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f'
})
};
fetch('https://testnet.edel-api.xyz/v1/withdrawals/{withdrawalId}/party-transfer', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://testnet.edel-api.xyz/v1/withdrawals/{withdrawalId}/party-transfer",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'withdrawalId' => '{{withdrawalId}}',
'receiverPartyId' => 'receiver-wallet::12200f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"Idempotency-Key: <idempotency-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://testnet.edel-api.xyz/v1/withdrawals/{withdrawalId}/party-transfer"
payload := strings.NewReader("{\n \"withdrawalId\": \"{{withdrawalId}}\",\n \"receiverPartyId\": \"receiver-wallet::12200f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Idempotency-Key", "<idempotency-key>")
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://testnet.edel-api.xyz/v1/withdrawals/{withdrawalId}/party-transfer")
.header("Idempotency-Key", "<idempotency-key>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"withdrawalId\": \"{{withdrawalId}}\",\n \"receiverPartyId\": \"receiver-wallet::12200f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://testnet.edel-api.xyz/v1/withdrawals/{withdrawalId}/party-transfer")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"withdrawalId\": \"{{withdrawalId}}\",\n \"receiverPartyId\": \"receiver-wallet::12200f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f\"\n}"
response = http.request(request)
puts response.read_body{
"version": "local-signing/v2",
"status": "approval_required",
"signingStep": "owner_withdrawal_consent",
"challenge": {
"challenge": "<string>",
"challengeIdentifier": "<string>",
"allowCredentials": {
"key": [
{
"type": "public-key",
"id": "<string>"
}
],
"webauthn": [
{
"type": "public-key",
"id": "<string>"
}
]
},
"userVerification": "required"
},
"withdrawal": {
"version": "local-signing/v2",
"withdrawalId": "<string>",
"accountId": "<string>",
"asset": "USD.E",
"amountAtoms": "<string>",
"status": "authorized",
"dueSigningStep": "owner_withdrawal_consent",
"payoutOfferExpiresAtEpochMs": 123,
"settled": true,
"partyTransfer": {
"receiverPartyId": "<string>",
"status": "requested",
"updateId": "<string>",
"instructionId": "<string>",
"holdingId": "<string>",
"executeBeforeEpochMs": 123
}
}
}{
"version": "external-rest-error/v1",
"requestId": "<string>",
"code": "invalid_request",
"safeMessage": "<string>",
"retryable": true,
"recoveryActions": [
"none"
],
"occurredAtEpochMs": 1,
"realtimeTicketFailure": "invalid",
"apiKeyRejection": "malformed",
"agentRefusal": "agents_not_admitted_in_environment",
"rejectionGuard": "amount_atoms_invalid",
"withdrawalFailure": "requested",
"dependency": "dfns"
}{
"version": "external-rest-error/v1",
"requestId": "<string>",
"code": "invalid_request",
"safeMessage": "<string>",
"retryable": true,
"recoveryActions": [
"none"
],
"occurredAtEpochMs": 1,
"realtimeTicketFailure": "invalid",
"apiKeyRejection": "malformed",
"agentRefusal": "agents_not_admitted_in_environment",
"rejectionGuard": "amount_atoms_invalid",
"withdrawalFailure": "requested",
"dependency": "dfns"
}{
"version": "external-rest-error/v1",
"requestId": "<string>",
"code": "invalid_request",
"safeMessage": "<string>",
"retryable": true,
"recoveryActions": [
"none"
],
"occurredAtEpochMs": 1,
"realtimeTicketFailure": "invalid",
"apiKeyRejection": "malformed",
"agentRefusal": "agents_not_admitted_in_environment",
"rejectionGuard": "amount_atoms_invalid",
"withdrawalFailure": "requested",
"dependency": "dfns"
}{
"version": "external-rest-error/v1",
"requestId": "<string>",
"code": "invalid_request",
"safeMessage": "<string>",
"retryable": true,
"recoveryActions": [
"none"
],
"occurredAtEpochMs": 1,
"realtimeTicketFailure": "invalid",
"apiKeyRejection": "malformed",
"agentRefusal": "agents_not_admitted_in_environment",
"rejectionGuard": "amount_atoms_invalid",
"withdrawalFailure": "requested",
"dependency": "dfns"
}{
"version": "external-rest-error/v1",
"requestId": "<string>",
"code": "invalid_request",
"safeMessage": "<string>",
"retryable": true,
"recoveryActions": [
"none"
],
"occurredAtEpochMs": 1,
"realtimeTicketFailure": "invalid",
"apiKeyRejection": "malformed",
"agentRefusal": "agents_not_admitted_in_environment",
"rejectionGuard": "amount_atoms_invalid",
"withdrawalFailure": "requested",
"dependency": "dfns"
}{
"version": "external-rest-error/v1",
"requestId": "<string>",
"code": "invalid_request",
"safeMessage": "<string>",
"retryable": true,
"recoveryActions": [
"none"
],
"occurredAtEpochMs": 1,
"realtimeTicketFailure": "invalid",
"apiKeyRejection": "malformed",
"agentRefusal": "agents_not_admitted_in_environment",
"rejectionGuard": "amount_atoms_invalid",
"withdrawalFailure": "requested",
"dependency": "dfns"
}{
"version": "external-rest-error/v1",
"requestId": "<string>",
"code": "invalid_request",
"safeMessage": "<string>",
"retryable": true,
"recoveryActions": [
"none"
],
"occurredAtEpochMs": 1,
"realtimeTicketFailure": "invalid",
"apiKeyRejection": "malformed",
"agentRefusal": "agents_not_admitted_in_environment",
"rejectionGuard": "amount_atoms_invalid",
"withdrawalFailure": "requested",
"dependency": "dfns"
}Withdrawals
Send a completed withdrawal to another Canton Party
Sends the full amount of a completed withdrawal on from the account owner’s own Canton Party to another Canton Party. receiverPartyId must be a full Party id: a hint, two colons, and the namespace fingerprint 1220 followed by 64 lowercase hexadecimal characters; it may not be the owner’s own Party. The withdrawal must be completed (paid out to the owner’s Party); any other withdrawal is refused and nothing is stored. The answer is the withdrawal with partyTransfer and dueSigningStep owner_party_transfer: a passkey session receives the challenge for that step and completes it with POST /v1/withdrawals//confirm, action complete and signingStep owner_party_transfer; an API key with the funding scope records the request and answers status owner_signature_required, because the owner signs every transfer in the browser. Repeating the request with the same receiver answers the same transfer. The receiver can be corrected until a transfer is prepared for signing; after that another receiver is refused. When the receiver Party is not known on the network the request answers an error and nothing is signed; the funds stay in the owner’s Party. After the owner signs, partyTransfer.status is pending_receiver_acceptance when the receiver still has to accept the transfer in their own wallet (instructionId names it; the receiver accepts before executeBeforeEpochMs, otherwise the funds return to the owner’s Party), or transferred only when the receiver holds the funds (holdingId names them). The signing deadline is also executeBeforeEpochMs: 24 hours after the request; a transfer not signed by then is refused. Requests for another owner’s withdrawal return HTTP 403. Bot sessions cannot send withdrawals to another Party.
Method and path: POST /v1/withdrawals//party-transfer
Authentication: DFNS trader bearer required.
Request schema: WithdrawalPartyTransferRequest.
Response schema: DfnsWithdrawalConfirmResponse.
Error envelope: ExternalRestError (external-rest-error/v1).
POST
/
v1
/
withdrawals
/
{withdrawalId}
/
party-transfer
Send a completed withdrawal to another Canton Party
curl --request POST \
--url https://testnet.edel-api.xyz/v1/withdrawals/{withdrawalId}/party-transfer \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--data '
{
"withdrawalId": "{{withdrawalId}}",
"receiverPartyId": "receiver-wallet::12200f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f"
}
'import requests
url = "https://testnet.edel-api.xyz/v1/withdrawals/{withdrawalId}/party-transfer"
payload = {
"withdrawalId": "{{withdrawalId}}",
"receiverPartyId": "receiver-wallet::12200f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f"
}
headers = {
"Idempotency-Key": "<idempotency-key>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'Idempotency-Key': '<idempotency-key>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
withdrawalId: '{{withdrawalId}}',
receiverPartyId: 'receiver-wallet::12200f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f'
})
};
fetch('https://testnet.edel-api.xyz/v1/withdrawals/{withdrawalId}/party-transfer', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://testnet.edel-api.xyz/v1/withdrawals/{withdrawalId}/party-transfer",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'withdrawalId' => '{{withdrawalId}}',
'receiverPartyId' => 'receiver-wallet::12200f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"Idempotency-Key: <idempotency-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://testnet.edel-api.xyz/v1/withdrawals/{withdrawalId}/party-transfer"
payload := strings.NewReader("{\n \"withdrawalId\": \"{{withdrawalId}}\",\n \"receiverPartyId\": \"receiver-wallet::12200f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Idempotency-Key", "<idempotency-key>")
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://testnet.edel-api.xyz/v1/withdrawals/{withdrawalId}/party-transfer")
.header("Idempotency-Key", "<idempotency-key>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"withdrawalId\": \"{{withdrawalId}}\",\n \"receiverPartyId\": \"receiver-wallet::12200f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://testnet.edel-api.xyz/v1/withdrawals/{withdrawalId}/party-transfer")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"withdrawalId\": \"{{withdrawalId}}\",\n \"receiverPartyId\": \"receiver-wallet::12200f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f\"\n}"
response = http.request(request)
puts response.read_body{
"version": "local-signing/v2",
"status": "approval_required",
"signingStep": "owner_withdrawal_consent",
"challenge": {
"challenge": "<string>",
"challengeIdentifier": "<string>",
"allowCredentials": {
"key": [
{
"type": "public-key",
"id": "<string>"
}
],
"webauthn": [
{
"type": "public-key",
"id": "<string>"
}
]
},
"userVerification": "required"
},
"withdrawal": {
"version": "local-signing/v2",
"withdrawalId": "<string>",
"accountId": "<string>",
"asset": "USD.E",
"amountAtoms": "<string>",
"status": "authorized",
"dueSigningStep": "owner_withdrawal_consent",
"payoutOfferExpiresAtEpochMs": 123,
"settled": true,
"partyTransfer": {
"receiverPartyId": "<string>",
"status": "requested",
"updateId": "<string>",
"instructionId": "<string>",
"holdingId": "<string>",
"executeBeforeEpochMs": 123
}
}
}{
"version": "external-rest-error/v1",
"requestId": "<string>",
"code": "invalid_request",
"safeMessage": "<string>",
"retryable": true,
"recoveryActions": [
"none"
],
"occurredAtEpochMs": 1,
"realtimeTicketFailure": "invalid",
"apiKeyRejection": "malformed",
"agentRefusal": "agents_not_admitted_in_environment",
"rejectionGuard": "amount_atoms_invalid",
"withdrawalFailure": "requested",
"dependency": "dfns"
}{
"version": "external-rest-error/v1",
"requestId": "<string>",
"code": "invalid_request",
"safeMessage": "<string>",
"retryable": true,
"recoveryActions": [
"none"
],
"occurredAtEpochMs": 1,
"realtimeTicketFailure": "invalid",
"apiKeyRejection": "malformed",
"agentRefusal": "agents_not_admitted_in_environment",
"rejectionGuard": "amount_atoms_invalid",
"withdrawalFailure": "requested",
"dependency": "dfns"
}{
"version": "external-rest-error/v1",
"requestId": "<string>",
"code": "invalid_request",
"safeMessage": "<string>",
"retryable": true,
"recoveryActions": [
"none"
],
"occurredAtEpochMs": 1,
"realtimeTicketFailure": "invalid",
"apiKeyRejection": "malformed",
"agentRefusal": "agents_not_admitted_in_environment",
"rejectionGuard": "amount_atoms_invalid",
"withdrawalFailure": "requested",
"dependency": "dfns"
}{
"version": "external-rest-error/v1",
"requestId": "<string>",
"code": "invalid_request",
"safeMessage": "<string>",
"retryable": true,
"recoveryActions": [
"none"
],
"occurredAtEpochMs": 1,
"realtimeTicketFailure": "invalid",
"apiKeyRejection": "malformed",
"agentRefusal": "agents_not_admitted_in_environment",
"rejectionGuard": "amount_atoms_invalid",
"withdrawalFailure": "requested",
"dependency": "dfns"
}{
"version": "external-rest-error/v1",
"requestId": "<string>",
"code": "invalid_request",
"safeMessage": "<string>",
"retryable": true,
"recoveryActions": [
"none"
],
"occurredAtEpochMs": 1,
"realtimeTicketFailure": "invalid",
"apiKeyRejection": "malformed",
"agentRefusal": "agents_not_admitted_in_environment",
"rejectionGuard": "amount_atoms_invalid",
"withdrawalFailure": "requested",
"dependency": "dfns"
}{
"version": "external-rest-error/v1",
"requestId": "<string>",
"code": "invalid_request",
"safeMessage": "<string>",
"retryable": true,
"recoveryActions": [
"none"
],
"occurredAtEpochMs": 1,
"realtimeTicketFailure": "invalid",
"apiKeyRejection": "malformed",
"agentRefusal": "agents_not_admitted_in_environment",
"rejectionGuard": "amount_atoms_invalid",
"withdrawalFailure": "requested",
"dependency": "dfns"
}{
"version": "external-rest-error/v1",
"requestId": "<string>",
"code": "invalid_request",
"safeMessage": "<string>",
"retryable": true,
"recoveryActions": [
"none"
],
"occurredAtEpochMs": 1,
"realtimeTicketFailure": "invalid",
"apiKeyRejection": "malformed",
"agentRefusal": "agents_not_admitted_in_environment",
"rejectionGuard": "amount_atoms_invalid",
"withdrawalFailure": "requested",
"dependency": "dfns"
}Authorizations
The authorization field takes the session bearer returned by sign-in, or an API key where the route allows keys. Paste the token itself into the authorization field.
Headers
Minimum string length:
1Path Parameters
Minimum string length:
1Body
application/json
Response
Success
- Option 1
- Option 2
- Option 3
Allowed value:
"local-signing/v2"Allowed value:
"approval_required"Available options:
owner_withdrawal_consent, owner_payout_acceptance, owner_party_transfer Show child attributes
Show child attributes
Show child attributes
Show child attributes