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.

Request JSON

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

Response JSON

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