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”.

PUTTINMatchingRecipients/CancelRequest

Request Params

Field	Type	Description
SubmissionId	Guid	Unique identifier of a submission.
RecordIds	Guid[]	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.

Request Params

Sample 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"

Sample 2

Cancel with SubmissionId

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

Sample 3

Cancel with invalid SubmissionId.

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

Response Body

Field	Type	Description
SubmissionId	Guid	Unique identifier of a submission.
TINMatchingDetails	object	Collection of TIN Matching records requested to cancel.
SuccessRecords	object[]	Successfully canceled records.
SequenceId	String	Unique record identifier set by the client.
RecordId	Guid	Unique identifier of the record.
Status	String	TIN Matching order status.
StatusTs	String	Timestamp of the TIN Matching status.
ErrorRecords	object	Error records that were not canceled.
Id	String	Error ID number. This ID is assigned by TaxBandits and it is unique for each error.
Name	String	Name of the errored node.
Message	String	Shows the error message.
Errors	object[]	Collection of error records in the request.
Id	string	Error ID number. This ID is assigned by TaxBandits and it is unique for each error.
Name	string	Name of the errored node.
Message	string	Shows the error message.

Response JSON

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
}

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
}

Response 3

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