Skip to main content
Version: 1.7.3

Transmit

Transmits the Form W2-G return to the IRS. You can Transmit a return successfully only if there are no validation errors in the return.

POST FormW2G/Transmit 
Run in Postman

Request Body

FieldTypeDescription
SubmissionIdGuidA unique identifier generated by TaxBandits when a W2-G return is created. Mention the W2-G return's Submission ID that you want to transmit.
RecordIdsGuid[]A unique identifier generated by TaxBandits when a W2-G return is created. Mention the W2-G return's Record ID that you want to transmit.

Request JSON

{
"SubmissionId": "05c4cfa0-aac5-491c-b5c3-95630933d3e7",
"RecordIds": [
"1ece3ab0-381e-401d-81eb-93f500f9b493"
]
}

Response Body

FieldTypeDescription
StatusCodenumberReturns the HTTP status codes like 200,300 etc.
StatusNamestringName of the status code
StatusMessagestringDetailed status message
SubmissionIdGuidUnique identifier of a submission
FormW2GRecordsobjectPulls the Form W2-G records with Success and Error statuses
    SuccessRecordsobject[]It will show the detailed information about the success status of Form W2 G Records
        SequenceIdstringA unique reference ID for the submission that can be used to identify a particular record. The Sequence ID will be returned in the Response for your reference.
        RecordIdGuidUnique identifier of a record
        StatusstringReturns the status of the records.
        StatusTsstringDate and Time of the Return Transmission
        StateReturnsobject[]Returns the state code and return status.
            StateCodestringReturns the code of the state.
            RecordStatusstringReturns the status of the records.
        PostalobjectReturns the status and StatusTs of postal mailing service for Form W2G.
            StatusstringReturns the status of postal order.
            StatusTsstringReturns the date and time of the postal order created.
            InfostringReturns the information about Postal mailing service.
        OnlineAccessobjectReturns the Email address for whom the online access to be given and Status of online access.
            StatusstringReturns status of online access for Form W2G return.
            EmailstringEmail address for whom the online access to be given.
            InfostringInformation about the online access service.
    ErrorRecordsobject[]It will show the detailed information about the error status of Form W2 G Records.
        SequenceIdstringA unique reference ID for the submission that can be used to identify a particular record. 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

Response JSON

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

{
"StatusCode": 200,
"StatusName": "Ok",
"StatusMessage": "Successful API call",
"SubmissionId": "05c4cfa0-aac5-491c-b5c3-95630933d3e7",
"FormW2GRecords": {
"SuccessRecords": [
{
"SequenceId": "1",
"RecordId": "1ece3ab0-381e-401d-81eb-93f500f9b493",
"Status": "Transmitted",
"StatusTs": "2022-05-06 08:02:14 -04:00",
"StateReturns": null,
"OnlineAccess": null,
"Postal":null
}
],
"ErrorRecords": null
},
"Errors": null
}