Skip to main content
Version: 1.7.0

Delete

This method can be used to delete a particular W-8BEN request or a submission.

If there are multiple W-8BENs requested in a Submission, all the W-8BEN records under the submission will be deleted.

DELETE FormW8Ben/Delete

Request Body

FieldTypeDescription
SubmissionIdGuidUnique Identifier for a Submission.
PayeeRefStringUnique identifier of a recipient. Either PayeeRef or Email is required
Size Range: 1-50
EmailStringEmail Address of the recipient.
Size Range: 1-50

Response Body

FieldTypeDescription
FormW8BENRecordsObjectDetails of the W-8BENs requested for delete
    SubmissionIdGuidUnique identifier of a submission.
    PayeeRefStringUnique identifier of the recipient
    EmailStringEmail Address of the recipient.
    W8BENStatusStringStatus of the W-8BEN
    StatusTsStringTimestamp of the status
ErrorsObjectShows detailed error information.

Scenario 1: Delete a recipient with SubmissionId

FormW8Ben/Delete?SubmissionId=019c8aec-41fe-4b80-883a-441665dc004a

Response 1: All W-8BENs will be deleted for the given SubmissionId.

{ "FormW8BENRecords": [   {     "SubmissionId": "019c8aec-41fe-4b80-883a-441665dc004a",     "PayeeRef": "Pe123451234",     "Email": "steve@abcinc.com",     "W8BENStatus": "DELETED",     "StatusTs": "2021-02-22 04:24:09 -05:00"   } ], "Errors": null}

Scenario 2: Delete a recipient with PayeeRef

FormW8Ben/Delete?PayeeRef=Pe123451234

Response 2: All the W-8BENs will be deleted for given PayeeRef.

{   "FormW8BENRecords": [       {           "SubmissionId": "58c06235-d278-4d4e-9f0e-cca9d21f38df",           "PayeeRef": "Pe123451234",           "Email": "steve@abcinc.com",           "W8BENStatus": "DELETED",           "StatusTs": "2021-04-09 13:48:30 -04:00"       },       {           "SubmissionId": "af0835ad-b26c-4a94-8d56-6e8f4cd36cb1",           "PayeeRef": "Pe123451234",           "Email": "steve@abcinc.com",           "W8BENStatus": "DELETED",           "StatusTs": "2021-04-09 13:48:30 -04:00"       }   ],   "Errors": null}

Scenario 3: Delete a recipient with Email

FormW8Ben/Delete?Email=steve@abcinc.com

Response 3: All the W-8BENs will be deleted for given Email.

{ "FormW8BENRecords": [   {     "SubmissionId": "019c8aec-41fe-4b80-883a-441665dc004a",     "PayeeRef": "Pe123451234",     "Email": "steve@abcinc.com",     "W8BENStatus": "DELETED",     "StatusTs": "2021-02-22 04:24:09 -05:00"   } ], "Errors": null}