Answer an offer

ONE endpoint for every offer domain. Two layers of discrimination, nested: `domain` selects `response`, and inside `response` the `responseType` selects the variant. Both layers are closed, so an onboarding response type sent under `domain: ALLOCATIONS` is a `400`. {"domain":"ONBOARDING","response":{"responseType":"DTCC_…_REJECT","reason":"KYC"}} `domain: TRANSFERS` is declared so the endpoint covers every offer domain. Transfer responses are not available yet — the domain is part of the contract, not of v1's behaviour.

POST

operations

canton

offers

{offerId}

responses

Answer an offer

curl --request POST \
  --url https://api.fireblocks.io/v1/operations/canton/offers/{offerId}/responses \
  --header 'Content-Type: application/json' \
  --data '
{
  "domain": "ONBOARDING",
  "response": {
    "responseType": "DTCC_END_INVESTOR_ONBOARDING_ACCEPT"
  }
}
'

import requests

url = "https://api.fireblocks.io/v1/operations/canton/offers/{offerId}/responses"

payload = {
    "domain": "ONBOARDING",
    "response": { "responseType": "DTCC_END_INVESTOR_ONBOARDING_ACCEPT" }
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    domain: 'ONBOARDING',
    response: {responseType: 'DTCC_END_INVESTOR_ONBOARDING_ACCEPT'}
  })
};

fetch('https://api.fireblocks.io/v1/operations/canton/offers/{offerId}/responses', 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://api.fireblocks.io/v1/operations/canton/offers/{offerId}/responses",
  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([
    'domain' => 'ONBOARDING',
    'response' => [
        'responseType' => 'DTCC_END_INVESTOR_ONBOARDING_ACCEPT'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$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://api.fireblocks.io/v1/operations/canton/offers/{offerId}/responses"

	payload := strings.NewReader("{\n  \"domain\": \"ONBOARDING\",\n  \"response\": {\n    \"responseType\": \"DTCC_END_INVESTOR_ONBOARDING_ACCEPT\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	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://api.fireblocks.io/v1/operations/canton/offers/{offerId}/responses")
  .header("Content-Type", "application/json")
  .body("{\n  \"domain\": \"ONBOARDING\",\n  \"response\": {\n    \"responseType\": \"DTCC_END_INVESTOR_ONBOARDING_ACCEPT\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.fireblocks.io/v1/operations/canton/offers/{offerId}/responses")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"domain\": \"ONBOARDING\",\n  \"response\": {\n    \"responseType\": \"DTCC_END_INVESTOR_ONBOARDING_ACCEPT\"\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "transactionId": "5a1d8b0f-2c31-4c7e-9d0a-118e7b6c4a21",
  "status": "SUBMITTED",
  "responseType": "DTCC_END_INVESTOR_ONBOARDING_REJECT"
}

{
  "message": "<string>",
  "code": 123
}

{
  "message": "<string>",
  "code": 123
}

{
  "message": "<string>",
  "code": 123
}

{
  "message": "<string>",
  "code": 123
}

{
  "message": "<string>",
  "code": 123
}

Headers

Idempotency-Key

string

A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours.

Path Parameters

offerId

string

required

The Fireblocks transaction id of the incoming offer being answered.

Example:

"5a1d8b0f-2c31-4c7e-9d0a-118e7b6c4a21"

Body

application/json

Option 1
Option 2
Option 3

domain

enum<string>

required

Which offer domain this response belongs to. Selects the shape of response.

Available options:

ONBOARDING

Example:

"ONBOARDING"

response

object

required

Accept a DTCC end-investor onboarding offer. Carries no arguments.

Option 1
Option 2
Option 3
Option 4

Show child attributes

Response

The outgoing transaction that carries the response. Its on-chain outcome arrives by webhook as a status update on this transaction.

transactionId

string

required

The outgoing response transaction.

Example:

"5a1d8b0f-2c31-4c7e-9d0a-118e7b6c4a21"

status

string

required

The transaction's status at the time of this response — SUBMITTED.

Example:

"SUBMITTED"

responseType

string

required

The response type you sent, echoed back so you can correlate without re-reading.

Example:

"DTCC_END_INVESTOR_ONBOARDING_REJECT"

Answer an offer

curl --request POST \
  --url https://api.fireblocks.io/v1/operations/canton/offers/{offerId}/responses \
  --header 'Content-Type: application/json' \
  --data '
{
  "domain": "ONBOARDING",
  "response": {
    "responseType": "DTCC_END_INVESTOR_ONBOARDING_ACCEPT"
  }
}
'

import requests

url = "https://api.fireblocks.io/v1/operations/canton/offers/{offerId}/responses"

payload = {
    "domain": "ONBOARDING",
    "response": { "responseType": "DTCC_END_INVESTOR_ONBOARDING_ACCEPT" }
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    domain: 'ONBOARDING',
    response: {responseType: 'DTCC_END_INVESTOR_ONBOARDING_ACCEPT'}
  })
};

fetch('https://api.fireblocks.io/v1/operations/canton/offers/{offerId}/responses', 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://api.fireblocks.io/v1/operations/canton/offers/{offerId}/responses",
  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([
    'domain' => 'ONBOARDING',
    'response' => [
        'responseType' => 'DTCC_END_INVESTOR_ONBOARDING_ACCEPT'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$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://api.fireblocks.io/v1/operations/canton/offers/{offerId}/responses"

	payload := strings.NewReader("{\n  \"domain\": \"ONBOARDING\",\n  \"response\": {\n    \"responseType\": \"DTCC_END_INVESTOR_ONBOARDING_ACCEPT\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	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://api.fireblocks.io/v1/operations/canton/offers/{offerId}/responses")
  .header("Content-Type", "application/json")
  .body("{\n  \"domain\": \"ONBOARDING\",\n  \"response\": {\n    \"responseType\": \"DTCC_END_INVESTOR_ONBOARDING_ACCEPT\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.fireblocks.io/v1/operations/canton/offers/{offerId}/responses")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"domain\": \"ONBOARDING\",\n  \"response\": {\n    \"responseType\": \"DTCC_END_INVESTOR_ONBOARDING_ACCEPT\"\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "transactionId": "5a1d8b0f-2c31-4c7e-9d0a-118e7b6c4a21",
  "status": "SUBMITTED",
  "responseType": "DTCC_END_INVESTOR_ONBOARDING_REJECT"
}

{
  "message": "<string>",
  "code": 123
}

{
  "message": "<string>",
  "code": 123
}

{
  "message": "<string>",
  "code": 123
}

{
  "message": "<string>",
  "code": 123
}

{
  "message": "<string>",
  "code": 123
}

Introduction

Errors & Statuses

Data Objects

API Endpoints

Answer an offer

Headers

Path Parameters

Body

Response