POST /v0/wallet/buy-traffic-requests

curl --request POST \
  --url 'https://example.com/api/validator/v0/wallet/buy-traffic-requests' \
  --header 'Authorization: Bearer $TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "receiving_validator_party_id": "<string>",
  "domain_id": "<string>",
  "traffic_amount": 123,
  "tracking_id": "<string>",
  "expires_at": 123
}'

import json
import requests

url = "https://example.com/api/validator/v0/wallet/buy-traffic-requests"
headers = {'Authorization': 'Bearer <token>', 'Content-Type': 'application/json'}
payload = json.loads(r'''{
  "receiving_validator_party_id": "<string>",
  "domain_id": "<string>",
  "traffic_amount": 123,
  "tracking_id": "<string>",
  "expires_at": 123
}''')
response = requests.request(
    "POST", url, headers=headers, json=payload
)

print(response.text)

const response = await fetch('https://example.com/api/validator/v0/wallet/buy-traffic-requests', {
  method: 'POST',
  headers: {
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
},
  body: JSON.stringify({
  "receiving_validator_party_id": "<string>",
  "domain_id": "<string>",
  "traffic_amount": 123,
  "tracking_id": "<string>",
  "expires_at": 123
}),
});

console.log(await response.text());

<?php
$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => 'https://example.com/api/validator/v0/wallet/buy-traffic-requests',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_POSTFIELDS => <<<'JSON'
{
  "receiving_validator_party_id": "<string>",
  "domain_id": "<string>",
  "traffic_amount": 123,
  "tracking_id": "<string>",
  "expires_at": 123
}
JSON,
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer <token>",
        "Content-Type: application/json"
    ],
]);

$response = curl_exec($curl);
echo $response;

package main

import (
  "bytes"
  "fmt"
  "io"
  "net/http"
)

func main() {
  req, _ := http.NewRequest("POST", "https://example.com/api/validator/v0/wallet/buy-traffic-requests", bytes.NewBufferString(`{
  "receiving_validator_party_id": "<string>",
  "domain_id": "<string>",
  "traffic_amount": 123,
  "tracking_id": "<string>",
  "expires_at": 123
}`))
  req.Header.Set("Authorization", "Bearer <token>")
  req.Header.Set("Content-Type", "application/json")
  response, _ := http.DefaultClient.Do(req)
  defer response.Body.Close()
  body, _ := io.ReadAll(response.Body)
  fmt.Println(string(body))
}

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

var request = HttpRequest.newBuilder()
    .uri(URI.create("https://example.com/api/validator/v0/wallet/buy-traffic-requests"))
    .header("Authorization", "Bearer <token>")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("""
{
  "receiving_validator_party_id": "<string>",
  "domain_id": "<string>",
  "traffic_amount": 123,
  "tracking_id": "<string>",
  "expires_at": 123
}
"""))
    .build();
var response = HttpClient.newHttpClient().send(
    request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

require 'net/http'
require 'uri'

uri = URI('https://example.com/api/validator/v0/wallet/buy-traffic-requests')
request = Net::HTTP::Post.new(uri)
request['Authorization'] = 'Bearer <token>'
request['Content-Type'] = 'application/json'
request.body = <<~JSON
{
  "receiving_validator_party_id": "<string>",
  "domain_id": "<string>",
  "traffic_amount": 123,
  "tracking_id": "<string>",
  "expires_at": 123
}
JSON
response = Net::HTTP.start(uri.hostname, uri.port) do |http|
  http.request(request)
end
puts response.body

{
  "request_contract_id": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

POST

api

validator

wallet

buy-traffic-requests

curl --request POST \
  --url 'https://example.com/api/validator/v0/wallet/buy-traffic-requests' \
  --header 'Authorization: Bearer $TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "receiving_validator_party_id": "<string>",
  "domain_id": "<string>",
  "traffic_amount": 123,
  "tracking_id": "<string>",
  "expires_at": 123
}'

import json
import requests

url = "https://example.com/api/validator/v0/wallet/buy-traffic-requests"
headers = {'Authorization': 'Bearer <token>', 'Content-Type': 'application/json'}
payload = json.loads(r'''{
  "receiving_validator_party_id": "<string>",
  "domain_id": "<string>",
  "traffic_amount": 123,
  "tracking_id": "<string>",
  "expires_at": 123
}''')
response = requests.request(
    "POST", url, headers=headers, json=payload
)

print(response.text)

const response = await fetch('https://example.com/api/validator/v0/wallet/buy-traffic-requests', {
  method: 'POST',
  headers: {
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
},
  body: JSON.stringify({
  "receiving_validator_party_id": "<string>",
  "domain_id": "<string>",
  "traffic_amount": 123,
  "tracking_id": "<string>",
  "expires_at": 123
}),
});

console.log(await response.text());

<?php
$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => 'https://example.com/api/validator/v0/wallet/buy-traffic-requests',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_POSTFIELDS => <<<'JSON'
{
  "receiving_validator_party_id": "<string>",
  "domain_id": "<string>",
  "traffic_amount": 123,
  "tracking_id": "<string>",
  "expires_at": 123
}
JSON,
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer <token>",
        "Content-Type: application/json"
    ],
]);

$response = curl_exec($curl);
echo $response;

package main

import (
  "bytes"
  "fmt"
  "io"
  "net/http"
)

func main() {
  req, _ := http.NewRequest("POST", "https://example.com/api/validator/v0/wallet/buy-traffic-requests", bytes.NewBufferString(`{
  "receiving_validator_party_id": "<string>",
  "domain_id": "<string>",
  "traffic_amount": 123,
  "tracking_id": "<string>",
  "expires_at": 123
}`))
  req.Header.Set("Authorization", "Bearer <token>")
  req.Header.Set("Content-Type", "application/json")
  response, _ := http.DefaultClient.Do(req)
  defer response.Body.Close()
  body, _ := io.ReadAll(response.Body)
  fmt.Println(string(body))
}

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

var request = HttpRequest.newBuilder()
    .uri(URI.create("https://example.com/api/validator/v0/wallet/buy-traffic-requests"))
    .header("Authorization", "Bearer <token>")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("""
{
  "receiving_validator_party_id": "<string>",
  "domain_id": "<string>",
  "traffic_amount": 123,
  "tracking_id": "<string>",
  "expires_at": 123
}
"""))
    .build();
var response = HttpClient.newHttpClient().send(
    request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

require 'net/http'
require 'uri'

uri = URI('https://example.com/api/validator/v0/wallet/buy-traffic-requests')
request = Net::HTTP::Post.new(uri)
request['Authorization'] = 'Bearer <token>'
request['Content-Type'] = 'application/json'
request.body = <<~JSON
{
  "receiving_validator_party_id": "<string>",
  "domain_id": "<string>",
  "traffic_amount": 123,
  "tracking_id": "<string>",
  "expires_at": 123
}
JSON
response = Net::HTTP.start(uri.hostname, uri.port) do |http|
  http.request(request)
end
puts response.body

{
  "request_contract_id": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

Create a request to buy traffic. Note that this only creates the request to do so. Refer to the status endpoint to check if the request succeeded.

OpenAPIAdded 0.5.10

curl --request POST \
  --url 'https://example.com/api/validator/v0/wallet/buy-traffic-requests' \
  --header 'Authorization: Bearer $TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "receiving_validator_party_id": "<string>",
  "domain_id": "<string>",
  "traffic_amount": 123,
  "tracking_id": "<string>",
  "expires_at": 123
}'

import json
import requests

url = "https://example.com/api/validator/v0/wallet/buy-traffic-requests"
headers = {'Authorization': 'Bearer <token>', 'Content-Type': 'application/json'}
payload = json.loads(r'''{
  "receiving_validator_party_id": "<string>",
  "domain_id": "<string>",
  "traffic_amount": 123,
  "tracking_id": "<string>",
  "expires_at": 123
}''')
response = requests.request(
    "POST", url, headers=headers, json=payload
)

print(response.text)

const response = await fetch('https://example.com/api/validator/v0/wallet/buy-traffic-requests', {
  method: 'POST',
  headers: {
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
},
  body: JSON.stringify({
  "receiving_validator_party_id": "<string>",
  "domain_id": "<string>",
  "traffic_amount": 123,
  "tracking_id": "<string>",
  "expires_at": 123
}),
});

console.log(await response.text());

<?php
$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => 'https://example.com/api/validator/v0/wallet/buy-traffic-requests',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_POSTFIELDS => <<<'JSON'
{
  "receiving_validator_party_id": "<string>",
  "domain_id": "<string>",
  "traffic_amount": 123,
  "tracking_id": "<string>",
  "expires_at": 123
}
JSON,
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer <token>",
        "Content-Type: application/json"
    ],
]);

$response = curl_exec($curl);
echo $response;

package main

import (
  "bytes"
  "fmt"
  "io"
  "net/http"
)

func main() {
  req, _ := http.NewRequest("POST", "https://example.com/api/validator/v0/wallet/buy-traffic-requests", bytes.NewBufferString(`{
  "receiving_validator_party_id": "<string>",
  "domain_id": "<string>",
  "traffic_amount": 123,
  "tracking_id": "<string>",
  "expires_at": 123
}`))
  req.Header.Set("Authorization", "Bearer <token>")
  req.Header.Set("Content-Type", "application/json")
  response, _ := http.DefaultClient.Do(req)
  defer response.Body.Close()
  body, _ := io.ReadAll(response.Body)
  fmt.Println(string(body))
}

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

var request = HttpRequest.newBuilder()
    .uri(URI.create("https://example.com/api/validator/v0/wallet/buy-traffic-requests"))
    .header("Authorization", "Bearer <token>")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("""
{
  "receiving_validator_party_id": "<string>",
  "domain_id": "<string>",
  "traffic_amount": 123,
  "tracking_id": "<string>",
  "expires_at": 123
}
"""))
    .build();
var response = HttpClient.newHttpClient().send(
    request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

require 'net/http'
require 'uri'

uri = URI('https://example.com/api/validator/v0/wallet/buy-traffic-requests')
request = Net::HTTP::Post.new(uri)
request['Authorization'] = 'Bearer <token>'
request['Content-Type'] = 'application/json'
request.body = <<~JSON
{
  "receiving_validator_party_id": "<string>",
  "domain_id": "<string>",
  "traffic_amount": 123,
  "tracking_id": "<string>",
  "expires_at": 123
}
JSON
response = Net::HTTP.start(uri.hostname, uri.port) do |http|
  http.request(request)
end
puts response.body

{
  "request_contract_id": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

Authorizations

walletUserAuth

string

required

HTTP bearer authentication. Send the token as Authorization: Bearer <token>. Bearer format: JWT. JWT token as described by the spliceAppBearerAuth security scheme. The subject of the token must be ledger API user of the user whose wallet the endpoint affects.

Body

application/json

string

required

Traffic will be purchased for the validator hosting this party. If the party is hosted on multiple participants, the request will fail with 400 Bad Request.

string

required

The domain to purchase traffic for.

number

required

OpenAPI type: integer (int64).traffic to purchase in bytes.

string

required

Tracking id to support exactly once submission. Once submitted, all succeessive calls with the same tracking id will get rejected with a 409 or 429 status code unless the command fails and the traffic did not get purchased. Clients should create a fresh tracking id when they try to send a new request to buy traffic. If that command submission fails with a retryable error or the application crashed and got restarted, successive command submissions must reuse the same tracking id to ensure they don’t purchase traffic multiple times.

Added0.5.10

Ledger API

Daml Standard Library

Daml Script

TypeScript

dApp API

Wallet Gateway

Splice APIs

Admin API

POST /v0/wallet/buy-traffic-requests

Authorizations

walletUserAuth

Body

Responses

200

400

409

429

500

History

​Authorizations

​walletUserAuth

​Body

​Responses

​200

​400

​409

​429

​500

​History

Authorizations

walletUserAuth

Body

Responses

200

400

409

429

500

History