curl --request GET \
--url https://api.smokeball.com/bankaccounts/{id}/protected-balances/{protectionId} \
--header 'Authorization: <api-key>' \
--header 'x-api-key: <api-key>'import requests
url = "https://api.smokeball.com/bankaccounts/{id}/protected-balances/{protectionId}"
headers = {
"x-api-key": "<api-key>",
"Authorization": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>', Authorization: '<api-key>'}};
fetch('https://api.smokeball.com/bankaccounts/{id}/protected-balances/{protectionId}', 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.smokeball.com/bankaccounts/{id}/protected-balances/{protectionId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"x-api-key: <api-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"
"net/http"
"io"
)
func main() {
url := "https://api.smokeball.com/bankaccounts/{id}/protected-balances/{protectionId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Authorization", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.smokeball.com/bankaccounts/{id}/protected-balances/{protectionId}")
.header("x-api-key", "<api-key>")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.smokeball.com/bankaccounts/{id}/protected-balances/{protectionId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"href": "<string>",
"relation": "<string>",
"method": "GET",
"self": {
"id": "<string>",
"href": "<string>",
"relation": "<string>",
"method": "GET"
},
"id": "p1",
"bankAccount": {
"id": "<string>",
"href": "<string>",
"relation": "<string>",
"method": "GET"
},
"matter": {
"id": "<string>",
"href": "<string>",
"relation": "<string>",
"method": "GET"
},
"contact": {
"id": "<string>",
"href": "<string>",
"relation": "<string>",
"method": "GET"
},
"amount": 100.5,
"reason": "Court order requiring protection of funds",
"effectiveDate": "2024-01-15T00:00:00Z",
"timestamp": "2024-01-15T10:30:00Z",
"isProtected": true,
"userId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"unprotectingUserId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"lastUpdated": "2024-01-15T10:30:00Z"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}Get a protected bank account balance
Retrieves a specified protected account balance record.
curl --request GET \
--url https://api.smokeball.com/bankaccounts/{id}/protected-balances/{protectionId} \
--header 'Authorization: <api-key>' \
--header 'x-api-key: <api-key>'import requests
url = "https://api.smokeball.com/bankaccounts/{id}/protected-balances/{protectionId}"
headers = {
"x-api-key": "<api-key>",
"Authorization": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>', Authorization: '<api-key>'}};
fetch('https://api.smokeball.com/bankaccounts/{id}/protected-balances/{protectionId}', 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.smokeball.com/bankaccounts/{id}/protected-balances/{protectionId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"x-api-key: <api-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"
"net/http"
"io"
)
func main() {
url := "https://api.smokeball.com/bankaccounts/{id}/protected-balances/{protectionId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Authorization", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.smokeball.com/bankaccounts/{id}/protected-balances/{protectionId}")
.header("x-api-key", "<api-key>")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.smokeball.com/bankaccounts/{id}/protected-balances/{protectionId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"href": "<string>",
"relation": "<string>",
"method": "GET",
"self": {
"id": "<string>",
"href": "<string>",
"relation": "<string>",
"method": "GET"
},
"id": "p1",
"bankAccount": {
"id": "<string>",
"href": "<string>",
"relation": "<string>",
"method": "GET"
},
"matter": {
"id": "<string>",
"href": "<string>",
"relation": "<string>",
"method": "GET"
},
"contact": {
"id": "<string>",
"href": "<string>",
"relation": "<string>",
"method": "GET"
},
"amount": 100.5,
"reason": "Court order requiring protection of funds",
"effectiveDate": "2024-01-15T00:00:00Z",
"timestamp": "2024-01-15T10:30:00Z",
"isProtected": true,
"userId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"unprotectingUserId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"lastUpdated": "2024-01-15T10:30:00Z"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}Response
When request is successful. Returns a 'ProtectedAccountBalance' object.
Show child attributes
Show child attributes
Unique identifier of the protection record.
"p1"
The bank account where the protection was applied.
Show child attributes
Show child attributes
The associated matter.
Show child attributes
Show child attributes
The associated contact (US only).
Show child attributes
Show child attributes
The amount protected in dollars. Limited to 2 decimal places (cents).
100.5
Reason for protecting the funds.
"Court order requiring protection of funds"
Date the protection took effect.
"2024-01-15T00:00:00Z"
Timestamp when the protection was created.
"2024-01-15T10:30:00Z"
True if the funds are currently protected.
true
Unique identifier of the user who protected the funds.
"a1b2c3d4-e5f6-7890-abcd-ef1234567890"
Unique identifier of the user who unprotected the funds (if applicable).
"a1b2c3d4-e5f6-7890-abcd-ef1234567890"
Timestamp when the protection was last updated (e.g. protected or unprotected).
"2024-01-15T10:30:00Z"