Delete
This method can be used to delete a particular W-9 request or a submission. If there are multiple W-9 requested in a submission, all the W-9 records under the submission will be deleted.
DELETE FormW9/Delete
Request Body
Field | Type | Description |
---|---|---|
SubmissionId | Guid | Unique Identifier for a Submission. |
PayeeRef | String | Unique identifier of a recipient. Either PayeeRef or Email is required Size Range: 1-50 |
String | Email Address of the recipient. Size Range: 1-50 |
Response Body
Field | Type | Description |
---|---|---|
FormW9Records | Object | Details of the W-9s requested for delete |
  SubmissionId | Guid | Unique identifier of a submission |
  PayeeRef | String | Unique identifier of the recipient |
  Email | String | Email Address of the recipient. |
  W9Status | String | Status of the W-9 |
  StatusTs | String | Timestamp of the W-9 Status |
Errors | Object | Shows detailed error information. |
Scenario 1: Delete a recipient with SubmissionId
FormW9/Delete?SubmissionId=019c8aec-41fe-4b80-883a-441665dc004a
Response 1: All W-9s will be deleted for the given SubmissionId.
{ "FormW9Records": [ { "SubmissionId": "019c8aec-41fe-4b80-883a-441665dc004a", "PayeeRef": "Pe123451234", "Email": "steve@abcinc.com", "W9Status": "DELETED", "StatusTs": "2021-02-22 04:24:09 -05:00" } ], "Errors": null}
Scenario 2: Delete a recipient with PayeeRef
FormW9/Delete?PayeeRef=Pe123451234
Response 2: All the W-9s will be deleted for a given PayeeRef.
{ "FormW9Records": [ { "SubmissionId": "58c06235-d278-4d4e-9f0e-cca9d21f38df", "PayeeRef": "Pe123451234", "Email": "steve@abcinc.com", "W9Status": "DELETED", "StatusTs": "2021-04-09 13:48:30 -04:00" }, { "SubmissionId": "af0835ad-b26c-4a94-8d56-6e8f4cd36cb1", "PayeeRef": "Pe123451234", "Email": "steve@abcinc.com", "W9Status": "DELETED", "StatusTs": "2021-04-09 13:48:30 -04:00" } ], "Errors": null}
Scenario 3: Delete a recipient with Email
FormW9/Delete?Email=steve@abcinc.com
Response 3: All the W-9s will be deleted for given Recipient Email.
{ "FormW9Records": [ { "SubmissionId": "019c8aec-41fe-4b80-883a-441665dc004a", "PayeeRef": "Pe123451234", "Email": "steve@abcinc.com", "W9Status": "DELETED", "StatusTs": "2021-02-22 04:24:09 -05:00" } ], "Errors": null}
Scenario 4: Delete a recipient with SubmissionId [Invalid]
FormW9/Delete?SubmissionId=019c8aec-41fe-4b80-883a-441665dc0033&Email=steve@abcinc.com
Response 4 : Since the Requester information was not given, the system will look up for W-9s under default business and return the result.
{ "FormW9Records": null, "Errors": [ { "Id": "F00-100146", "Name": "Submission Id", "Message": "Submission Id is invalid" } ]}