Skip to main content
Version: 1.7.3

Update

Update

Use this endpoint to update the information on existing PA W-3 forms that are already created for a specific employer (payer).

Note:

You cannot update a return once it has been transmitted.

PUTStateFilings/PAWH/Update

Request Body

FieldTypeDescription
SubmissionIdGuidUnique identifier created by TaxBandits for each submission. Not required when you are creating a return.
StateWHRecordsObject[]Object to create Form W-3
SequenceIdStringA unique number given by an inbound application to identify failed records.
Size Range: 1-10
ReturnHeaderObjectIdentifies the supporting details of Form W-3
QtrStringThe quarter for which Form W-3 needs to be filed.
Allowed values

"Q1", "Q2", "Q3", "Q4"

TaxYrStringThe tax year for which Form W-3 needs to be filed.
Allowed values

"2025"

BusinessObjectThe details of the business you're filing for.
BusinessNmStringName of the business.
Size Range: 1-75
PayerRefstringOptional A unique identifier for each payer completing their information. This identifier can be used in future references of the payer in the API.
Size Range: 1-50
TradeNmStringOptional Name under which the business operates.
Size Range: 1-75
IsEINBooleanWhen true, identifies the business with an EIN.
EINorSSNStringWhen IsEIN is true, use Employer Identification Number (EIN).
Size Range: 9-11
EmailStringEmail address of the business.
Size Range: 1-100
IsForeignBooleanWhen true, identifies the business as having a foreign address.
USAddressObjectIf IsForeign is false, pass the US address of the business.
Address1StringEmployer/Payer's US address (street address or post office box).
Size Range: 1-46
Address2StringOptional Employer/Payer's suite or apartment.
Size Range: 1-46
CityStringEmployer/Payer's city.
Size Range: 1-50
StateStringEmployer/Payer's state.
Size Range: 2
Allowed values

"AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY", "AS", "FM", "GU", "MH", "MP", "PW", "PR", "VI", "AA", "AE", "AP"

ZipCdStringEmployer/Payer's zip code.
Size Range: 5-10
ForeignAddressObjectIf IsForeign is true, pass the foreign address of the business.
Address1StringEmployer/Payer's foreign address (street address or post office box).
Size Range: 1-50
Address2StringOptional Employer/Payer's suite or apartment.
Size Range: 1-50
CityStringEmployer/Payer's city.
Size Range: 1-50
ProvinceOrStateNmStringEmployer/Payer's province or state name.
Size Range: 1-50
CountryStringEmployer/Payer's country.
Size Range: 2
Allowed values

"AF", "AX", "AL", "AG", "AQ", "AN", "AO", "AV", "AY", "AC", "AR", "AM", "AA", "AT", "AS", "AU", "AJ", "BF", "BA", "FQ", "BG", "BB", "BO", "BE", "BH", "BN", "BD", "BT", "BL", "BK", "BC", "BV", "BR", "IO", "VI", "BX", "BU", "UV", "BM", "BY", "CB", "CM", "CA", "CV", "CJ", "CT", "CD", "CI", "CH", "KT", "IP", "CK", "CO", "CN", "CF", "CG", "CW", "CR", "CS", "IV", "HR", "CU", "UC", "CY", "EZ", "DA", "DX", "DJ", "DO", "DR", "TT", "EC", "EG", "ES", "EK", "ER", "EN", "ET", "FK", "FO", "FM", "FJ", "FI", "FR", "FP", "FS", "GB", "GA", "GG", "GM", "GH", "GI", "GR", "GL", "GJ", "GQ", "GT", "GK", "GV", "PU", "GY", "HA", "HM", "VT", "HO", "HK", "HQ", "HU", "IC", "IN", "ID", "IR", "IZ", "EI", "IS", "IT", "JM", "JN", "JA", "DQ", "JE", "JQ", "JO", "KZ", "KE", "KQ", "KR", "KN", "KS", "KV", "KU", "KG", "LA", "LG", "LE", "LT", "LI", "LY", "LS", "LH", "LU", "MC", "MK", "MA", "MI", "MY", "MV", "ML", "MT", "IM", "RM", "MR", "MP", "MX", "MQ", "MD", "MN", "MG", "MJ", "MH", "MO", "MZ", "WA", "NR", "BQ", "NP", "NL", "NC", "NZ", "NU", "NG", "NI", "NE", "NF", "CQ", "NO", "MU", "OC", "PK", "PS", "LQ", "PM", "PP", "PF", "PA", "PE", "RP", "PC", "PL", "PO", "RQ", "QA", "RO", "RS", "RW", "TB", "RN", "WS", "SM", "TP", "SA", "SG", "RI", "SE", "SL", "SN", "NN", "LO", "SI", "BP", "SO", "SF", "SX", "OD", "SP", "PG", "CE", "SH", "SC", "ST", "SB", "VC", "SU", "NS", "SV", "WZ", "SW", "SZ", "SY", "TW", "TI", "TZ", "TH", "TO", "TL", "TN", "TD", "TS", "TU", "TX", "TK", "TV", "UG", "UP", "AE", "UK", "UY", "UZ", "NH", "VE", "VM", "VQ", "WQ", "WF", "WI", "YM", "ZA", "ZI"

PostalCdStringEmployer/Payer's postal code.
Size Range: 1-16
ReturnDataObjectIdentifies the Form W-3
FormW3ObjectPennsylvania withholding tax returns.
WHIdNumStringPennsylvania withholding file number.
Size Range: 8 or 11
DepositSchedulestringThe filing frequency of Form W-3
Allowed values

"QUARTERLY", "MONTHLY", "SEMI_MONTHLY", "SEMI_WEEKLY"

TotPayrollAmtNumberTotal pennsylvania taxable wages paid for the quarter.
Size Range: 0-999999999.99
TaxWHNumberPennsylvania income tax withheld from all sources for the filing period
Size Range: 0-99999999.99
TaxPaidNumberPennsylvania income tax paid from all sources for the filing period
Size Range: 0-99999999.99
OverpaymentNumberOverpayment amount.
Size Range: 0-999999999.99
BalanceDueNumberBalance due amount.
Size Range: 0-999999999.99
MonthlyWHDepositObjectIdentifies details of monthly tax withheld deposits.
Month1WHAmtNumberTotal Pennsylvania income tax withheld for the month 1.
Size Range: 0-999999999.99
Month2WHAmtNumberTotal Pennsylvania income tax withheld for the month 2.
Size Range: 0-999999999.99
Month3WHAmtNumberTotal Pennsylvania income tax withheld for the month 3.
Size Range: 0-999999999.99
SemiMonthlyWHDepositObjectIdentifies details of semi-monthly tax withheld deposits.
Month1FHWHAmtNumberTotal Pennsylvania income tax withheld for the first half of Month 1.
Size Range: 0-999999999.99
Month1SHWHAmtNumberTotal Pennsylvania income tax withheld for the second half of Month 1.
Size Range: 0-999999999.99
Month2FHWHAmtNumberTotal Pennsylvania income tax withheld for the first half of Month 2.
Size Range: 0-999999999.99
Month2SHWHAmtNumberTotal Pennsylvania income tax withheld for the second half of Month 2.
Size Range: 0-999999999.99
Month3FHWHAmtNumberTotal Pennsylvania income tax withheld for the first half of Month 3.
Size Range: 0-999999999.99
Month3SHWHAmtNumberTotal Pennsylvania income tax withheld for the second half of Month 3.
Size Range: 0-999999999.99
SemiWeeklyWHDepositObjectIdentifies details of semi-weekly tax withheld deposits.
Period1NumberTotal Pennsylvania income tax withheld for Period 1 of the semi-weekly deposit.
Size Range: 0-999999999.99
Period2NumberTotal Pennsylvania income tax withheld for Period 2 of the semi-weekly deposit.
Size Range: 0-999999999.99
Period3NumberTotal Pennsylvania income tax withheld for Period 3 of the semi-weekly deposit.
Size Range: 0-999999999.99
Period4NumberTotal Pennsylvania income tax withheld for Period 4 of the semi-weekly deposit.
Size Range: 0-999999999.99
Period5NumberTotal Pennsylvania income tax withheld for Period 5 of the semi-weekly deposit.
Size Range: 0-999999999.99
Period6NumberTotal Pennsylvania income tax withheld for Period 6 of the semi-weekly deposit.
Size Range: 0-999999999.99
Period7NumberTotal Pennsylvania income tax withheld for Period 7 of the semi-weekly deposit.
Size Range: 0-999999999.99
Period8NumberTotal Pennsylvania income tax withheld for Period 8 of the semi-weekly deposit.
Size Range: 0-999999999.99
Period9NumberTotal Pennsylvania income tax withheld for Period 9 of the semi-weekly deposit.
Size Range: 0-999999999.99
Period10NumberTotal Pennsylvania income tax withheld for Period 10 of the semi-weekly deposit.
Size Range: 0-999999999.99
Period11NumberTotal Pennsylvania income tax withheld for Period 11 of the semi-weekly deposit.
Size Range: 0-999999999.99
Period12NumberTotal Pennsylvania income tax withheld for Period 12 of the semi-weekly deposit.
Size Range: 0-999999999.99
Period13NumberTotal Pennsylvania income tax withheld for Period 13 of the semi-weekly deposit.
Size Range: 0-999999999.99
Period14NumberTotal Pennsylvania income tax withheld for Period 14 of the semi-weekly deposit.
Size Range: 0-999999999.99
Period15NumberTotal Pennsylvania income tax withheld for Period 15 of the semi-weekly deposit.
Size Range: 0-999999999.99
Period16NumberTotal Pennsylvania income tax withheld for Period 16 of the semi-weekly deposit.
Size Range: 0-999999999.99
Period17NumberTotal Pennsylvania income tax withheld for Period 17 of the semi-weekly deposit.
Size Range: 0-999999999.99
Period18NumberTotal Pennsylvania income tax withheld for Period 18 of the semi-weekly deposit.
Size Range: 0-999999999.99
Period19NumberTotal Pennsylvania income tax withheld for Period 19 of the semi-weekly deposit.
Size Range: 0-999999999.99
Period20NumberTotal Pennsylvania income tax withheld for Period 20 of the semi-weekly deposit.
Size Range: 0-999999999.99
Period21NumberTotal Pennsylvania income tax withheld for Period 21 of the semi-weekly deposit.
Size Range: 0-999999999.99
Period22NumberTotal Pennsylvania income tax withheld for Period 22 of the semi-weekly deposit.
Size Range: 0-999999999.99
Period23NumberTotal Pennsylvania income tax withheld for Period 23 of the semi-weekly deposit.
Size Range: 0-999999999.99
Period24NumberTotal Pennsylvania income tax withheld for Period 24 of the semi-weekly deposit.
Size Range: 0-999999999.99
Period25NumberTotal Pennsylvania income tax withheld for Period 25 of the semi-weekly deposit.
Size Range: 0-999999999.99
Period26NumberTotal Pennsylvania income tax withheld for Period 26 of the semi-weekly deposit.
Size Range: 0-999999999.99
Period27NumberTotal Pennsylvania income tax withheld for Period 27 of the semi-weekly deposit.
Size Range: 0-999999999.99
TotQtrTaxLiabAmtNumberTotal tax required to be withheld for all the months of the quarter.
Size Range: 0-99999999.99

Response Body

FieldTypeDescription
SubmissionIdGuidUnique identifier of a submission
SuccessRecordsobject[]It will show the detailed information about the success status of Form W-3 Records
SequenceIdstringA unique number given by an inbound application to identify particular records.
BusinessIdGuidUnique identifier of a Business
PayerRefstringUnique identifier of the payer
RecordIdGuidA unique identifier generated by TaxBandits when a W-3 return is created
FormTypestringDenotes the type of withholding form W-3.
StatusstringReturns the record status of return.
StatusTsstringDate and time of the return created.
InfostringReturns the information about the return
Errorsobject[]Shows error information of state returns of Form W-3
IdstringReturns the validation error Id.
NamestringName of the validation error.
MessagestringDescription of the validation error.
ErrorRecordsobject[]It will show the detailed information about the error status of Form WH-1001 Records.
SequenceIdstringA unique number given by an inbound application to identify particular records. The Sequence ID will be returned in the Response for your reference.
RecordIdGuidUnique identifier of a record
Errorsobject[]Shows detailed error information
IdstringReturns the validation error Id
NamestringName of the validation error
MessagestringDescription of the validation error

Request JSON

{ 
"SubmissionId": "019db3c1-8275-71c4-8899-4f3ec8dff392",
"StateWHRecords": [
{
"SequenceId": "001",
"RecordId": "019db3c1-83bb-741d-a785-2261c5fd7fb1",
"ReturnHeader": {
"Qtr": "Q2",
"TaxYr": "2025",
"Business": {
"BusinessNm": "Keystone Manufacturing LLC",
"TradeNm": "Keystone Mfg",
"IsEIN": true,
"PayerRef":"Keystone123",
"EINorSSN": "236789128",
"Email": "info@keystonemfg.com",
"ContactNm": "Michael Turner",
"Phone": "7175554821",
"PhoneExtn": "101",
"Fax": "7175554899",
"BusinessType": "ESTE",
"SigningAuthority": {
"Name": "Michael Turner",
"Phone": "7175554821",
"BusinessMemberType": "ADMINISTRATOR"
},
"KindOfEmployer": "NONGOVT501C",
"KindOfPayer": "REGULAR941",
"IsBusinessTerminated": false,
"IsForeign": false,
"USAddress": {
"Address1": "1500 Market Street",
"Address2": "Suite 1200",
"City": "Philadelphia",
"State": "PA",
"ZipCd": "19102"
},
"ForeignAddress": {
"Address1": null,
"Address2": null,
"City": null,
"ProvinceOrStateNm": null,
"Country": null,
"PostalCd": null
}
}
},
"ReturnData": {
"FormW3": {
"WHIdNum": "00007000",
"DepositSchedule": "MONTHLY",
"TotPayrollAmt": "4000.00",
"TaxWH": "3500",
"TaxPaid": "2000.00",
"Overpayment": "0.00",
"BalanceDue": "1500.00",
"MonthlyWHDeposit": {
"Month1WHAmt": 1000,
"Month2WHAmt": 1500,
"Month3WHAmt": 1000
},
"SemiMonthlyWHDeposit": {
"Month1FHWHAmt": 0,
"Month1SHWHAmt": 0,
"Month2FHWHAmt": 0,
"Month2SHWHAmt": 0,
"Month3FHWHAmt": 0,
"Month3SHWHAmt": 0
},
"SemiWeeklyWHDeposit": {
"Period1": 0,
"Period2": 0,
"Period3": 0,
"Period4": 0,
"Period5": 0,
"Period6": 0,
"Period7": 0,
"Period8": 0,
"Period9": 0,
"Period10": 0,
"Period11": 0,
"Period12": 0,
"Period13": 0,
"Period14": 0,
"Period15": 0,
"Period16": 0,
"Period17": 0,
"Period18": 0,
"Period19": 0,
"Period20": 0,
"Period21": 0,
"Period22": 0,
"Period23": 0,
"Period24": 0,
"Period25": 0,
"Period26": 0,
"Period27": 0
},
"TotQtrTaxLiabAmt": 3500
}
}
}
]
}

Response JSON

Success Response - This is a sample response for successful API requests.

{
"StatusCode": "200",
"StatusName": "Ok",
"StatusMessage": "Successful API call",
"SubmissionId": "019d1a68-e397-754b-ab1c-4c2edc8876ec",
"SuccessRecords": [
{
"SequenceId": "001",
"BusinessId": "2fa5381e-8c36-4fbd-8d66-8b0db29d3d90",
"PayerRef": "bdfjjghghdhgfh",
"RecordId": "019d1a68-fa42-753f-8b18-5d3b60fa6d1f",
"FormType": "WTH10001",
"Status": "CREATED",
"StatusTs": "2026-03-23 16:51:30 +05:30",
"Info": null,
"Errors": null
}
],
"ErrorRecords": null,
"Errors": null
}