Extend your software with TaxBandits IRS E-file API Integration

Skip to main content
Version: 1.7.1

Cancel

Use this method to cancel a particular request or submission. You can only cancel a request if the TIN Matching status is “Order Created”.

PUT TINMatchingRecipients/CancelRequest

Request Body

FieldTypeDescription
SubmissionIdGuidUnique identifier of a submission.
RecordIdsGuid[]Optional Unique identifier of the record. Mention the multiple RecordIds, if you want to cancel multiple TIN Matching requests under a submission. Do not mention the record Ids if all the records under the submission need to be cancelled.

Response Body

FieldTypeDescription
SubmissionIdGuidUnique identifier of a submission.
TINMatchingDetailsobjectCollection of TIN Matching records requested to cancel.
    SuccessRecordsobject[]Successfully canceled records.
        SequenceIdStringUnique record identifier set by the client.
        RecordIdGuidUnique identifier of the record.
        StatusStringTIN Matching order status.
        StatusTsStringTimestamp of the TIN Matching status.
    ErrorRecordsobjectError records that were not canceled.
        IdStringError ID number. This ID is assigned by TaxBandits and it is unique for each error.
        NameStringName of the errored node.
        MessageStringShows the error message.
    Errorsobject[]Collection of error records in the request.
        IdstringError ID number. This ID is assigned by TaxBandits and it is unique for each error.
        NamestringName of the errored node.
        MessagestringShows the error message.

Request 1 : Cancel with SubmissionId and RecorIds

TINMatchingRecipients/CancelRequest?SubmissionId=387f41d7-b238-455b-b9d7-48f7d48889f5&RecordIds=15c3caa6-8402-4548-8713-4fcdd2f7d42d,eb39714e-f653-4c4d-a53c-07f24f9a9dj5

Response 1

{
"SubmissionId": "9d71ae45-df5f-49f7-86f8-e88f54132fa1",
"TINMatchingDetails": {
"SuccessRecords": [
{
"SequenceId": "1",
"RecordId": "15c3caa6-8402-4548-8713-4fcdd2f7d42d",
"Status": "CANCELED",
"StatusTs": "2019-08-05 06:26:16 -04:00"
},
{
"SequenceId": "2",
"RecordId": "eb39714e-f653-4c4d-a53c-07f24f9a9dj5",
"Status": "CANCELED",
"StatusTs": "2019-08-05 06:26:16 -04:00"
}
],
"ErrorRecords": null
},
"Errors": null
}

Request 2 : Cancel with SubmissionId.

TINMatchingRecipients/Cancel?SubmissionId=387f41d7-b238-455b-b9d7-48f7d48889f5

Response 2

{
"SubmissionId": "9d71ae45-df5f-49f7-86f8-e88f54132fa1",
"TINMatchingDetails": {
"SuccessRecords": [
{
"SequenceId": "1",
"RecordId": "15c3caa6-8402-4548-8713-4fcdd2f7d42d",
"Status": "CANCELED",
"StatusTs": "2019-08-05 06:26:16 -04:00"
},
{
"SequenceId": "2",
"RecordId": "eb39714e-f653-4c4d-a53c-07f24f9a9dj5",
"Status": "CANCELED",
"StatusTs": "2019-08-05 06:26:16 -04:00"
}
],
"ErrorRecords": null
},
"Errors": null
}

Request 3 : Cancel with invalid SubmissionId.

TINMatchingRecipients/Cancel?SubmissionId=447f41d7-b238-455b-b9d7-48f7d48889f5

Response 3

{
"SubmissionId": "00000000-0000-0000-0000-000000000000",
"TinMatchingDetails": null,
"Errors": [
{
"Id": "F68-100023",
"Name": "SubmissionId",
"Message": "SubmissionId is invalid"
}
]
}