Deactivate

Deactivate

This endpoint temporarily suspends a recipient without deleting it. Use this when a recipient is temporarily inactive or should be paused from filing without losing its history.

Key Points

• Once the recipient is deactivated, filings cannot be made until the recipient is reactivated.
• You can reactivate the recipient at any time using the Reactivate endpoint.

GET recipient/deactivate

Run in Postman

Request Body

Field	Type	Description
RecipientId	GUIDs	TaxBandits-generated unique identifier for the recipient.
PayeeRef	String	Your unique identifier for the recipient.

Response Body

Field	Type	Description
SuccessRecords	Object []	Records that were processed successfully.
RecipientId	GUID	TaxBandits-generated unique identifier for the recipient.
PayeeRef	String	Your unique identifier for the recipient.
Status	String	Status of the operation.
StatusTs	String	Date and time the operation was completed.
ErrorRecords	Object []	Records that failed to process.
RecipientId	GUID	Identifier of the failed recipient.
PayeeRef	String	Your unique identifier for the recipient.
Errors	Object []	Validation error details.
Id	String	Validation error code.
Name	String	Name of the validation rule that failed.
Message	String	Description of the error.
Errors	Object []	Top-level request errors if the entire request cannot be processed.
Id	String	Validation error code.
Name	String	Name of the validation rule that failed.
Message	String	Description of the error.

Payload

Request Params

Sample	Description	Action
Sample 1	Deactivate a recipient using recipientIds and PayeeRef.

Sample 1

recipient/deactivate?recipientIds=d67539c3-0603-4fb7-9a29-3ae15339269a

Response JSON

Response	Description	Action
200	Success Response - You'll get the below response when the request is processed successfully.
207	Multi-status Response - You'll get the below response when multiple statuses are included.
400	Bad Request Response - You'll get the below response when your API requests contain any validation errors.
401	Unauthorized Response - You'll get the below response when your API requests don't contain valid authentication credentials.

Response: 200

{
  "SuccessRecords": [
    {
      "RecipientId": "d67539c3-0603-4fb7-9a29-3ae15339269a",
      "PayeeRef": "PAYEE001",
      "Status": "DEACTIVATED",
      "StatusTs": "2026-07-09 06:20:30 -04:00"
    }
  ],
  "ErrorRecords": null,
  "Errors": null
}

Go Lang

  package main

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

  func main() {
      url := "<APIURL>/v2.0.0/recipient/deactivate?recipientIds=d67539c3-0603-4fb7-9a29-3ae15339269a"
      method := "GET"

      payload := strings.NewReader(``)

      client := &http.Client{}

      req, err := http.NewRequest(method, url, payload)
      if err != nil {
          fmt.Println(err)
          return
      }

      req.Header.Add("Content-Type", "application/json")
      req.Header.Add("Authorization", "<ACCESS_TOKEN>")

      res, err := client.Do(req)
      if err != nil {
          fmt.Println(err)
          return
      }
      defer res.Body.Close()

      body, err := io.ReadAll(res.Body)
      if err != nil {
          fmt.Println(err)
          return
      }

      fmt.Println(string(body))
  }

Node.js

  const axios = require('axios');
  let data = '';

  let config = {
  method: 'get',
  maxBodyLength: Infinity,
  url: '<APIURL>/v2.0.0/recipient/deactivate?recipientIds=d67539c3-0603-4fb7-9a29-3ae15339269a',
  headers: { 
      'Content-Type': 'application/json', 
      'Authorization': '<ACCESS_TOKEN>'
  },
  data : data
  };

  axios.request(config)
  .then((response) => {
  console.log(JSON.stringify(response.data));
  })
  .catch((error) => {
  console.log(error);
  });

Python

  import http.client
  import json

  conn = http.client.HTTPSConnection("<APIURL>")
  payload = ''
  headers = {
  'Content-Type': 'application/json',
  'Authorization': '<ACCESS_TOKEN>'
  }
  conn.request("GET", "/v2.0.0/recipient/deactivate?recipientIds=d67539c3-0603-4fb7-9a29-3ae15339269a", payload, headers)
  res = conn.getresponse()
  data = res.read()
  print(data.decode("utf-8"))

.NET C#

  var client = new HttpClient();
  var request = new HttpRequestMessage(HttpMethod.Get, "<APIURL>/v2.0.0/recipient/deactivate?recipientIds=d67539c3-0603-4fb7-9a29-3ae15339269a");
  request.Headers.Add("Authorization", "<ACCESS_TOKEN>");
  var content = new StringContent("", null, "application/json");
  request.Content = content;
  var response = await client.SendAsync(request);
  response.EnsureSuccessStatusCode();
  Console.WriteLine(await response.Content.ReadAsStringAsync());

Ruby

  require "uri"
  require "json"
  require "net/http"

  url = URI("<APIURL>/v2.0.0/recipient/deactivate?recipientIds=d67539c3-0603-4fb7-9a29-3ae15339269a")

  http = Net::HTTP.new(url.host, url.port);
  request = Net::HTTP::Get.new(url)
  request["Content-Type"] = "application/json"
  request["Authorization"] = "<ACCESS_TOKEN>"

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

Java

  OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
  MediaType mediaType = MediaType.parse("application/json");
  RequestBody body = RequestBody.create(mediaType, "");
  Request request = new Request.Builder()
  .url("<APIURL>/v2.0.0/recipient/deactivate?recipientIds=d67539c3-0603-4fb7-9a29-3ae15339269a")
  .method("GET", body)
  .addHeader("Content-Type", "application/json")
  .addHeader("Authorization", "<ACCESS_TOKEN>")
  .build();
  Response response = client.newCall(request).execute();

cURL

  curl --location '<APIURL>/v2.0.0/recipient/deactivate?recipientIds=d67539c3-0603-4fb7-9a29-3ae15339269a'   --header 'Content-Type: application/json'   --header 'Authorization: <ACCESS_TOKEN>'   --data ''