Create a request to buy traffic

POST /api/validator/v0/wallet/buy-traffic-requests

Request

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":0,"tracking_id":"string","expires_at":0}'

200 response

{
  "request_contract_id": "string"
}

Wallet API (External)

Create a request to buy traffic

OpenAPISince 0.5.10

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.

Protocol Details

Operation IDcreateBuyTrafficRequest

AuthenticationBearer token

Published0.7.4

SpecificationDownload OpenAPI

Inputs

Request body

application/json

receiving_validator_party_id · 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.

domain_id · string · required

The domain to purchase traffic for.

traffic_amount · number · required

OpenAPI type: integer (int64).

traffic to purchase in bytes.

tracking_id · 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.

expires_at · number · required

OpenAPI type: integer (int64).

Expiry time of the request to buy traffic as unix timestamp in microseconds. If the request does not succeed before this time, the wallet automation will reject and expire it. Note that this time is compared against the ledger effective time of the Daml transaction accepting or expiring an offer, and can skew from the wall clock time measured on the caller’s machine. See https://docs.daml.com/concepts/time.html for how ledger effective time is bound to the record time of a transaction on a domain.

Outputs

200

application/json

request_contract_id · string · required

400

application/json

error · string · required

409

application/json

error · string · required

429

application/json

error · string · required

500

application/json

error · string · required

History

Introduced0.5.10

Request

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":0,"tracking_id":"string","expires_at":0}'

200 response

{
  "request_contract_id": "string"
}