getGarnishmentAgencies
curl --request GET \
--url https://sandbox.rollfi.xyz/reports/getGarnishmentAgencies \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"method": "getGarnishmentAgencies",
"garnishmentType": "Child Support"
}
'import requests
url = "https://sandbox.rollfi.xyz/reports/getGarnishmentAgencies"
payload = {
"method": "getGarnishmentAgencies",
"garnishmentType": "Child Support"
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.get(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({method: 'getGarnishmentAgencies', garnishmentType: 'Child Support'})
};
fetch('https://sandbox.rollfi.xyz/reports/getGarnishmentAgencies', 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://sandbox.rollfi.xyz/reports/getGarnishmentAgencies",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_POSTFIELDS => json_encode([
'method' => 'getGarnishmentAgencies',
'garnishmentType' => 'Child Support'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"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://sandbox.rollfi.xyz/reports/getGarnishmentAgencies"
payload := strings.NewReader("{\n \"method\": \"getGarnishmentAgencies\",\n \"garnishmentType\": \"Child Support\"\n}")
req, _ := http.NewRequest("GET", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
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.get("https://sandbox.rollfi.xyz/reports/getGarnishmentAgencies")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"method\": \"getGarnishmentAgencies\",\n \"garnishmentType\": \"Child Support\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.rollfi.xyz/reports/getGarnishmentAgencies")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"method\": \"getGarnishmentAgencies\",\n \"garnishmentType\": \"Child Support\"\n}"
response = http.request(request)
puts response.read_body{
"garnishmentAgencies": [
"Alabama Child Support Agency",
"Alaska Child Support Agency",
"Arizona Child Support Agency",
"Arkansas Child Support Agency",
"California Child Support Agency",
"Colorado Child Support Agency",
"Connecticut Child Support Agency",
"Delaware Child Support Agency",
"District of Columbia Child Support Agency",
"Florida Child Support Enforcement",
"Georgia Child Support Agency",
"Hawaii Child Support Agency",
"Idaho Child Support Agency",
"Illinois Child Support State Agency",
"Indiana Child Support Agency",
"Iowa Child Support Agency",
"Kansas Child Support Agency",
"Kentucky Child Support Agency",
"Louisiana Child Support Agency",
"Maine Child Support Agency",
"Maryland Child Support Agency",
"Massachusetts Child Support Agency",
"Michigan Child Support Agency",
"Minnesota Child Support Agency",
"Mississippi Child Support Agency",
"Missouri Child Support Agency",
"Montana Child Support Agency",
"Nebraska Child Support Agency",
"Nevada Child Support Agency",
"New Hampshire Child Support Agency",
"New Jersey Child Support Agency",
"New Mexico Child Support Agency",
"New York Child Support Enforcement",
"North Carolina Child Support Agency",
"North Dakota Child Support Division",
"Ohio Child Support Program",
"Oklahoma Child Support Agency",
"Oregon Child Support Agency",
"Pennsylvania Child Support Agency",
"Rhode Island Child Support Agency",
"South Carolina Child Support Agency",
"South Dakota Child Support Agency",
"Tennessee Child Support Agency",
"Texas Attorney General Child Support",
"Utah Child Support Agency",
"Vermont Child Support Agency",
"Virginia Child Support Agency",
"Washington Child Support Agency",
"West Virginia Child Support Agency",
"Wisconsin Child Support Agency",
"Wyoming Child Support Agency"
]
}{
"error": {
"code": 404,
"message": "No garnishment type found matching Test Agency."
}
}Garnishments
getGarnishmentAgencies
The getGarnishmentAgencies API retrieves the available agencies given a garnishment type
When to use:
- To determine the agency to send in the
addGarnishmentsrequest - Agencies are state specific and will be stated on any garnishment communications you recieve via mail
Note:
- Currently only
Child Supportis supported for garnishmentType since this is the only garnishment Rollfi pays directly to an agency
Direct Agency Payment Scope:
- Rollfi can only pay agencies directly for
Child Supportgarnishments. - Direct agency payment for child support is available in 49 states (all except South Carolina (SC)).
GET
/
reports
/
getGarnishmentAgencies
getGarnishmentAgencies
curl --request GET \
--url https://sandbox.rollfi.xyz/reports/getGarnishmentAgencies \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"method": "getGarnishmentAgencies",
"garnishmentType": "Child Support"
}
'import requests
url = "https://sandbox.rollfi.xyz/reports/getGarnishmentAgencies"
payload = {
"method": "getGarnishmentAgencies",
"garnishmentType": "Child Support"
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.get(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({method: 'getGarnishmentAgencies', garnishmentType: 'Child Support'})
};
fetch('https://sandbox.rollfi.xyz/reports/getGarnishmentAgencies', 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://sandbox.rollfi.xyz/reports/getGarnishmentAgencies",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_POSTFIELDS => json_encode([
'method' => 'getGarnishmentAgencies',
'garnishmentType' => 'Child Support'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"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://sandbox.rollfi.xyz/reports/getGarnishmentAgencies"
payload := strings.NewReader("{\n \"method\": \"getGarnishmentAgencies\",\n \"garnishmentType\": \"Child Support\"\n}")
req, _ := http.NewRequest("GET", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
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.get("https://sandbox.rollfi.xyz/reports/getGarnishmentAgencies")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"method\": \"getGarnishmentAgencies\",\n \"garnishmentType\": \"Child Support\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.rollfi.xyz/reports/getGarnishmentAgencies")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"method\": \"getGarnishmentAgencies\",\n \"garnishmentType\": \"Child Support\"\n}"
response = http.request(request)
puts response.read_body{
"garnishmentAgencies": [
"Alabama Child Support Agency",
"Alaska Child Support Agency",
"Arizona Child Support Agency",
"Arkansas Child Support Agency",
"California Child Support Agency",
"Colorado Child Support Agency",
"Connecticut Child Support Agency",
"Delaware Child Support Agency",
"District of Columbia Child Support Agency",
"Florida Child Support Enforcement",
"Georgia Child Support Agency",
"Hawaii Child Support Agency",
"Idaho Child Support Agency",
"Illinois Child Support State Agency",
"Indiana Child Support Agency",
"Iowa Child Support Agency",
"Kansas Child Support Agency",
"Kentucky Child Support Agency",
"Louisiana Child Support Agency",
"Maine Child Support Agency",
"Maryland Child Support Agency",
"Massachusetts Child Support Agency",
"Michigan Child Support Agency",
"Minnesota Child Support Agency",
"Mississippi Child Support Agency",
"Missouri Child Support Agency",
"Montana Child Support Agency",
"Nebraska Child Support Agency",
"Nevada Child Support Agency",
"New Hampshire Child Support Agency",
"New Jersey Child Support Agency",
"New Mexico Child Support Agency",
"New York Child Support Enforcement",
"North Carolina Child Support Agency",
"North Dakota Child Support Division",
"Ohio Child Support Program",
"Oklahoma Child Support Agency",
"Oregon Child Support Agency",
"Pennsylvania Child Support Agency",
"Rhode Island Child Support Agency",
"South Carolina Child Support Agency",
"South Dakota Child Support Agency",
"Tennessee Child Support Agency",
"Texas Attorney General Child Support",
"Utah Child Support Agency",
"Vermont Child Support Agency",
"Virginia Child Support Agency",
"Washington Child Support Agency",
"West Virginia Child Support Agency",
"Wisconsin Child Support Agency",
"Wyoming Child Support Agency"
]
}{
"error": {
"code": 404,
"message": "No garnishment type found matching Test Agency."
}
}⌘I
