Endpoints
Environment | Host URL |
---|---|
Test | https://test-api.sandbox.co.in |
Production | https://api.sandbox.co.in |
Compliance API
Search TAN API
TAN | Response | Remark |
---|---|---|
MUMR09719B | 200 | Valid TAN (Company) |
AHMJ09719B | 200 | Valid TAN (Individual) |
AABC23456D | 200 | No Records Found |
DABC2345DD | 422 | Invalid TAN Pattern |
EABC23456N | 500 | Failed to get TAN |
TDS Return API using TXT & CSI (Submit Job)
TAN | Response | Remark |
---|---|---|
AHMA09719B | 200 | Job will be successful |
MUMR09719B | 200 | Job will fail with the message: Regular Statement with the same TAN, Financial Year, FORM, and Quarter is already furnished |
AABC23456D | 200 | Job will fail with the message: TAN present in the Statement/Application is not valid, kindly furnish a valid TAN |
PDES03028E | 200 | Job will fail with the message: The statement cannot be filed before the end of the relevant quarter of the current Financial Year |
BLRC23456F | 200 | Job will fail and will provide a Validation Report URL |
DABC2345DD | 422 | Invalid TAN Pattern |
EABC23456N | 422 | Invalid Form |
TDS Return API using TXT & CSI (Poll Job)
job_id | Response | Remark |
---|---|---|
2aa54d2b-68f6-4871-866a-4eba957a8672 | 200 | Job Queued Response |
f845f37e-7f05-4de9-a282-a3b23b9d370a | 200 | Job Done Response |
6e8d1908-c062-4846-a811-8f73054acd65 | 200 | Job Failed: Regular Statement with the same TAN, Financial Year, FORM, and Quarter is already furnished |
4d7b01e7-7297-46d3-86fc-47e11d2db3a5 | 200 | Job Failed: TAN present in the Statement/Application is not valid, kindly furnish a valid TAN |
12e4ec35-3322-4adc-983b-f3a4beff5c4d | 200 | Job Failed: The statement cannot be filed before the end of the relevant quarter of the current Financial Year |
37777de-4ab7-4532-9bc5-009c8cfaedf4 | 200 | Job Failed with Validation Report URL |
a75b67be-8b33-431f-bc40-76b7be68bcd2 | 422 | Invalid TAN Pattern |
e2c3ca8b-2d36-4b2d-b6a3-a778ab7adf51 | 422 | Invalid Form |
7baed565-4dc2-46a1-89c2-be35a0a38081 | 521 | Data not found |
TDS Return API using FVU & Form 27A (Submit Job)
TAN | Response | Remark |
---|---|---|
AHMA09719B | 200 | The job will be successful |
MUMR09719B | 200 | The job will fail with the message: Regular Statement with the same TAN, Financial Year, FORM, and Quarter is already furnished |
AABC23456D | 200 | The job will fail with the message: Unacceptable FVU |
PDES03028E | 200 | The job will fail with the message: Invalid Archive |
BLRC23456F | 200 | The job will fail with the message: Invalid Number of entries in Archive: 1 |
HYDC23456G | 200 | The job will fail with the message: Form Type Mismatch |
MUMC23456H | 200 | The job will fail with the message: Quarter Mismatch |
DELC23456I | 200 | The job will fail with the message: Barcode Mismatch |
PUNC23456J | 200 | The job will fail with the message: Financial Year Mismatch |
KOLT23456K | 200 | The job will fail with the message: TAN Mismatch |
BABC23456L | 200 | The job will fail with the message: FVU Missing |
CABC23456M | 200 | The job will fail with the message: Form 27A missing |
DABC2345DD | 422 | Invalid TAN Pattern |
EABC23456N | 422 | Invalid Form |
TDS Return API using FVU & Form 27A (Poll Job)
job_id | Response | Remark |
---|---|---|
2aa54d2b-68f6-4871-866a-4eba957a8672 | 200 | Job Queued Response |
f845f37e-7f05-4de9-a282-a3b23b9d370a | 200 | Job Done Response |
6e8d1908-c062-4846-a811-8f73054acd65 | 200 | Job Failed: Regular Statement with the same TAN, Financial Year, FORM, and Quarter is already furnished |
d75c3d26-4f81-451f-ab38-e217ea801ea1 | 200 | Job Failed: Unacceptable FVU |
d1213059-ec22-4e10-b0c1-a91814377001 | 200 | Job Failed: Invalid Archive |
3b979ce9-ef4e-4157-a4a3-51e8747e76d7 | 200 | Job Failed: Invalid Number of entries in Archive: 1 |
d6f5b340-440b-400c-9b86-16e691e768b0 | 200 | Job Failed: Form Type Mismatch |
7a62876a-d638-430c-ad77-8fe33d9e63d5 | 200 | Job Failed: Quarter Mismatch |
6b11d176-b3c5-483c-9052-b533a6e92377 | 200 | Job Failed: Barcode Mismatch |
7928082e-34ca-474c-ba05-4ede9598b9b5 | 200 | Job Failed: Financial Year Mismatch |
5fd2679f-040f-435c-a285-df5817a150b5 | 200 | Job Failed: TAN Mismatch |
9bf0b6f8-5957-484f-9aea-0d235054974c | 200 | Job Failed: FVU Missing |
b411fbee-68e4-4da3-9f62-8de8ca09a74c | 200 | Job Failed: Form 27A missing |
a75b67be-8b33-431f-bc40-76b7be68bcd2 | 422 | Invalid TAN Pattern |
e2c3ca8b-2d36-4b2d-b6a3-a778ab7adf51 | 422 | Invalid Form |
7baed565-4dc2-46a1-89c2-be35a0a38081 | 521 | Data not found |
TDS Certificate API - Authenticate TRACES Session
username | password | tan | Response | Remark |
---|---|---|---|---|
TestSucess12 | sessionSucessful | AHMA09719B | 200 | Success, Access token generated |
TestFailed39 | sessionFailed | AHMA09719B | 403 | Bad Credentials |
TestUser32 | TestPassword94 | MUMR09719B | 403 | Insufficient Privilege Error |
TestUser30 | TestPassword54 | MUMR09T19B | 422 | Incorrect Body/Pattern |
TestError45 | ErrorPass59 | PDES03028F | 500 | Internal Server Error |
TDS Certificate API - Download Form 16A (Submit Job)
Test Payloads
{
"bsr_code": "1234567",
"challan_date": 1670783400000,
"challan_serial_no": "01234",
"provisional_receipt_number": "990000123469999",
"challan_amount": 20000,
"unique_pan_amount_combination_for_challan": [
[
"sr_no",
"pan",
"total_amount_deposited_against_pan"
],
[
1,
"XXXPX1234A",
2000
],
[
2,
"XXXPX1234B",
6000
],
[
3,
"AXXPX1234Z",
12000
]
]
}
{
"bsr_code": "2345678",
"challan_date": 1670783400000,
"challan_serial_no": "12345",
"provisional_receipt_number": "990000123469999",
"challan_amount": 1000,
"unique_pan_amount_combination_for_challan": [
[
"sr_no",
"pan",
"total_amount_deposited_against_pan"
],
[
1,
"XXXPX1234A",
250
],
[
2,
"XXXPX1234J",
250
],
[
3,
"XXXPX1234D",
500
]
]
}
{
"bsr_code": "122456",
"challan_date": 1670783400000,
"challan_serial_no": "12234",
"provisional_receipt_number": "990000123469999",
"challan_amount": 9000.0,
"unique_pan_amount_combination_for_challan": [
[
"sr_no",
"pan",
"total_amount_deposited_against_pan"
],
[
1,
"XXXPX1234J",
3000
],
[
2,
"XXXPX1234J",
3000
],
[
3,
"XXXPX1234J",
3000
]
]
}
{
"bsr_code": "1234577",
"challan_date": 1670783400000,
"challan_serial_no": "01233",
"provisional_receipt_number": "990000123469999",
"challan_amount": 15000,
"unique_pan_amount_combination_for_challan": [
[
"sr_no",
"pan",
"total_amount_deposited_against_pan"
],
[
1,
"XXXPX1234A",
5000
],
[
2,
"XXXPX1234B",
5000
],
[
3,
"AXXPX1234Z",
5000
]
]
}
{
"bsr_code": "234567",
"challan_date": 1670783400000,
"challan_serial_no": "91234",
"provisional_receipt_number": "990000123469999",
"challan_amount": 18000.0,
"unique_pan_amount_combination_for_challan": [
[
"sr_no",
"pan",
"total_amount_deposited_against_pan"
],
[
1,
"XXXPX1234A",
2000
],
[
2,
"XXXPX1234B",
6000
],
[
3,
"AXXPX123EE",
10000
]
]
}
{
"bsr_code": "1234566",
"challan_date": 1670783400000,
"challan_serial_no": "01244",
"provisional_receipt_number": "990000123469999",
"challan_amount": 30000,
"unique_pan_amount_combination_for_challan": [
[
"sr_no",
"pan",
"total_amount_deposited_against_pan"
],
[
1,
"XXXPX1234A",
2000
],
[
2,
"XXXPX1234B",
6000
],
[
3,
"AXXPX1234Z",
12000
]
]
}
TDS Certificate API - Download Form 16A (Poll Job)
TAN | job_id | Response | Remark |
---|---|---|---|
MUMR09719B | 2aa54d2b-68f6-4871-866a-4eba957a8672 | 200 | Job Queued Response |
AHMA09719B | f845f37e-7f05-4de9-a282-a3b23b9d370a | 200 | Job Done Response |
PDES03028E | d75c3d26-4f81-451f-ab38-e217ea801ea1 | 200 | Job Failed: No Form 16A |
AABC23456D | 6e8d1908-c062-4846-a811-8f73054acd65 | 200 | Job Failed: Invalid KYC data |
Reporting API
Submit Job API
TAN | Form | Quarter | Remarks |
---|---|---|---|
AHMA09719B | 26Q | - | The job will be successful |
AHMA09719B | 27Q | - | The job will be successful |
AHMA09719B | 24Q | - | The job will be successful |
AHMA09719B | 24Q | Q4 | The job will be successful |
BLRC23456F | - | - | Job failed with Validation report |
DABC2345DD | - | - | Invalid TAN Pattern |
EABC23456N | - | - | Invalid Form |
Poll Job API
Job ID | Remarks |
---|---|
46d96540-e4e0-4188-81f5-959f4732490f | Job Done Response for Form 26Q |
5c9f6262-49c0-4ae7-8e60-9a6404ef748f | Job Done Response for Form 27Q |
ef528abe-d259-49f9-8e57-ec33c703f03f | Job Done Response for Form 24Q |
5631a2b1-b9e9-4189-8304-524d5cd080bf | Job Done Response for Form 24Q (Q4) |
77a45361-9646-4ee0-93ed-9471bb8a615e | Job failed with a Validation report |
Calculator API
Non-Salary Payments API
Data | Response | Remarks |
---|---|---|
Payload 1 | 200 | Success - TDS u/s 194BA |
Payload 2 | 200 | Success - TDS u/s 194C |
Payload 3 | 200 | Success - TDS u/s 194C |
Payload 4 | 200 | Success - TDS u/s 194LC |
Payload 5 | 200 | Success - TDS u/s 195 |
Test Payloads
{
"@entity": "in.co.sandbox.tds.calculator.non_salary.request",
"deductee_type": "individual",
"is_pan_available": true,
"residential_status": "resident",
"is_206ab_applicable": false,
"is_pan_operative": false,
"nature_of_payment": "winnings_from_online_games",
"credit_amount": 84232,
"credit_date": 1694131200000
}
{
"@entity": "in.co.sandbox.tds.calculator.non_salary.request",
"deductee_type": "individual",
"is_pan_available": true,
"residential_status": "resident",
"is_206ab_applicable": true,
"is_pan_operative": true,
"nature_of_payment": "sales_and_marketing_services",
"credit_amount": 250000,
"credit_date": 1699315200000
}
{
"@entity": "in.co.sandbox.tds.calculator.non_salary.request",
"deductee_type": "company",
"is_pan_available": false,
"residential_status": "resident",
"is_206ab_applicable": false,
"is_pan_operative": false,
"nature_of_payment": "tender_fees",
"credit_amount": 90500,
"credit_date": 1685577600000
}
{
"@entity": "in.co.sandbox.tds.calculator.non_salary.request",
"deductee_type": "individual",
"is_pan_available": true,
"residential_status": "non_resident",
"is_206ab_applicable": false,
"is_pan_operative": true,
"nature_of_payment": "interest_payment_from_indian_company_or_business_trust",
"credit_amount": 7423,
"credit_date": 1696636800000
}
{
"@entity": "in.co.sandbox.tds.calculator.non_salary.request",
"deductee_type": "body_of_individuals",
"is_pan_available": true,
"residential_status": "non_resident",
"is_206ab_applicable": false,
"is_pan_operative": true,
"nature_of_payment": "fees_for_technical_service",
"credit_amount": 25000,
"credit_date": 1699315200000
}
Calculate TCS API
Data | Response | Remarks |
---|---|---|
Payload 1 | 200 | Success - TCS on remittance under LRS |
Payload 2 | 200 | Success - TCS on sale of overseas tour package |
Payload 3 | 200 | Success - TCS on sale of motor vehicle |
Payload 4 | 200 | Success - TCS on sale of tendu leaves |
Payload 5 | 200 | Success - TCS on sale of goods |
Test Payloads
{
"@entity": "in.co.sandbox.tcs.calculator.request",
"collectee_type": "individual",
"is_pan_available": true,
"residential_status": "resident",
"is_206cca_applicable": true,
"is_pan_operative": true,
"nature_of_collection": "foreign_remittance_for_other_purposes",
"payment_amount": 895345,
"payment_date": 1708926739000
}
{
"@entity": "in.co.sandbox.tcs.calculator.request",
"collectee_type": "individual",
"is_pan_available": true,
"residential_status": "resident",
"is_206cca_applicable": true,
"is_pan_operative": true,
"nature_of_collection": "foreign_flight_tickets",
"payment_amount": 775000,
"payment_date": 1698777000000
}
{
"@entity": "in.co.sandbox.tcs.calculator.request",
"collectee_type": "company",
"is_pan_available": true,
"residential_status": "resident",
"is_206cca_applicable": false,
"is_pan_operative": true,
"nature_of_collection": "sale_of_motor_vehicle",
"payment_amount": 1250000,
"payment_date": 1685577600000
}
{
"@entity": "in.co.sandbox.tcs.calculator.request",
"collectee_type": "individual",
"is_pan_available": true,
"residential_status": "resident",
"is_206cca_applicable": true,
"is_pan_operative": true,
"nature_of_collection": "sale_of_tendu_leaves",
"payment_amount": 500000,
"payment_date": 1706639400000
}
{
"@entity": "in.co.sandbox.tcs.calculator.request",
"collectee_type": "individual",
"is_pan_available": true,
"residential_status": "company",
"is_206cca_applicable": false,
"is_pan_operative": true,
"nature_of_collection": "sale_of_goods",
"payment_amount": 4500000,
"payment_date": 1707244200000
}