On This Page

Commit Tax Calculation

Commit a tax calculation to indicate in the Tax Detail Report that the calculated tax amount in the tax request was added to a successful capture or refund transaction.

Tax Detail Report

The commit request will set the Status field in the Tax Detail Report to Committed.

Commit Tax Calculation Scenarios

You can commit tax calculation requests at different moments in a transaction.
Use these scenario examples to determine when it would be best for you to commit a tax calculation.
Possible scenarios:

Scenario 1: Pre-authorization

You can commit a tax calculation request before requesting an authorization. For example:
  1. Request the tax calculation service with the
    taxService_commitIndicator
     field set to
    true
    .
  2. Authorize and capture payment.
  3. If the authorization or capture fails, void the previously committed tax calculation request. See Void Tax Calculation.

Scenario 2: Post-capture

You can commit a tax request after a capture. If you implement the tax service in this way, you will have to request the tax calculation service at least twice per request. For example:
  1. Request the tax calculation service with the commit indicator field set to
    taxService_commitIndicator
     set to
    false
    .
  2. Authorize and capture the payment.
  3. If the authorization and capture are successful, request the tax calculation service with the
    taxService_commitIndicator
     set to
    true
    .

Scenario 3: Partial Captures

You can commit a tax request for partial captures. For example:
  1. Request the tax calculation service with the commit indicator field set to
    taxService_commitIndicator
     set to
    false
    .
  2. Authorize the payment for $0 or wait to authorize partial payments as items are transferred to the customer.
  3. Implement Scenario 1 or Scenario 2 as you make authorizations and captures.

US and Canada Tax Commit

This section shows the fields necessary to commit US and Canadian tax calculation.
To commit a tax calculation, include the
taxService_commitIndicator
 field set to
true
 in a tax calculation request.

Endpoint

Set the
taxService
 field to
true
.
Send the request to
https://ics2ws.ic3.com/commerce/1.x/transactionProcessor
.

Required Fields for a Committed Tax Request Using the
SO
 API

Use these fields to perform a committed tax request.
billTo_country
billTo_city
billTo_postalCode
billTo_state
item_#_unitPrice
merchantReferenceCode
taxService_commitIndicator
Set to
true
.
taxService_nexus
If you include this field, do not include the
taxService.noNexus
 field.
taxService_noNexus
If you include this field, do not include the
taxService.Nexus
 field.

Optional Fields for a Committed Tax Request Using the
SO
 API

Select from these optional fields to commit a tax request.
item_#_unitPrice
merchantReferenceCode
taxService_commitIndicator
Set field to
true
 to commit tax calculation.

Example: Processing a Committed Tax Request Using the SO API

Request
taxService_run=true
billTo_street1=123 Main St.
billTo_city=Small Town
billTo_country=us
billTo_state=ca
billTo_postalCode=98765
purchaseTotals_currency=usd
merchantID=infodev
merchantReferenceCode=TAX_TC097
item_0_unitPrice=1200
item_0_quantity=1
item_0_productCode=50161815
item_0_productName=Chewing Gum
item_0_productSKU=07-12-00657
item_1_unitPrice=1240
item_1_quantity=1
item_1_productCode=50181905
item_1_productName=Sugar Cookies
item_1_productSKU=07-12-00657
taxService_commitIndicator=true
Response
taxReply_totalCountryTaxAmount=0.00
taxReply_reasonCode=100
taxReply_totalSpecialTaxAmount=0.00
taxReply_totalTaxableAmount=0.00
purchaseTotals_currency=usd
taxReply_totalStateTaxAmount=0.00
taxReply_totalExemptAmount=2440.00
taxReply_commitIndicator=true
taxReply_grandTotalAmount=2440.00
taxReply_totalCityTaxAmount=0.00
taxReply_totalTaxAmount=0.00
decision=ACCEPT
taxReply_totalCountyTaxAmount=0.00
merchantReferenceCode=TAX_TC097
reasonCode=100
requestID=5244716855106000201086
taxReply_item_0_taxableAmount=0.00
taxReply_item_0_exemptAmount=1200.00
taxReply_item_0_specialTaxAmount=0.00
taxReply_item_0_cityTaxAmount=0.00
taxReply_item_0_countyTaxAmount=0.00
taxReply_item_0_stateTaxAmount=0.00
taxReply_item_0_countryTaxAmount=0.00
taxReply_item_0_totalTaxAmount=0.00
taxReply_item_0_jurisdiction_0_country=US
taxReply_item_0_jurisdiction_0_region=CA
taxReply_item_0_jurisdiction_0_type=State
taxReply_item_0_jurisdiction_0_code=06
taxReply_item_0_jurisdiction_0_taxable=0.00
taxReply_item_0_jurisdiction_0_rate=0.060000
taxReply_item_0_jurisdiction_0_taxAmount=0.00
taxReply_item_0_jurisdiction_0_name=CALIFORNIA
taxReply_item_0_jurisdiction_0_taxName=CA STATE TAX
taxReply_item_0_jurisdiction_1_country=US
taxReply_item_0_jurisdiction_1_region=CA
taxReply_item_0_jurisdiction_1_type=County
taxReply_item_0_jurisdiction_1_code=001
taxReply_item_0_jurisdiction_1_taxable=0.00
taxReply_item_0_jurisdiction_1_rate=0.002500
taxReply_item_0_jurisdiction_1_taxAmount=0.00
taxReply_item_0_jurisdiction_1_name=ALAMEDA
taxReply_item_0_jurisdiction_1_taxName=CA COUNTY TAX
taxReply_item_0_jurisdiction_2_country=US
taxReply_item_0_jurisdiction_2_region=CA
taxReply_item_0_jurisdiction_2_type=Special
taxReply_item_0_jurisdiction_2_code=EMAK0
taxReply_item_0_jurisdiction_2_taxable=0.00
taxReply_item_0_jurisdiction_2_rate=0.020000
taxReply_item_0_jurisdiction_2_taxAmount=0.00
taxReply_item_0_jurisdiction_2_name=ALAMEDA COUNTY DISTRICT TAX SP
taxReply_item_0_jurisdiction_2_taxName=CA SPECIAL TAX
taxReply_item_0_jurisdiction_3_country=US
taxReply_item_0_jurisdiction_3_region=CA
taxReply_item_0_jurisdiction_3_type=Special
taxReply_item_0_jurisdiction_3_code=EMSJ0
taxReply_item_0_jurisdiction_3_taxable=0.00
taxReply_item_0_jurisdiction_3_rate=0.010000
taxReply_item_0_jurisdiction_3_taxAmount=0.00
taxReply_item_0_jurisdiction_3_name=ALAMEDA CO LOCAL TAX SL
taxReply_item_0_jurisdiction_3_taxName=CA SPECIAL TAX
taxReply_item_1_taxableAmount=0.00
taxReply_item_1_exemptAmount=1240.00
taxReply_item_1_specialTaxAmount=0.00
taxReply_item_1_cityTaxAmount=0.00
taxReply_item_1_countyTaxAmount=0.00
taxReply_item_1_stateTaxAmount=0.00
taxReply_item_1_countryTaxAmount=0.00
taxReply_item_1_totalTaxAmount=0.00
taxReply_item_1_jurisdiction_0_country=US
taxReply_item_1_jurisdiction_0_region=CA
taxReply_item_1_jurisdiction_0_type=State
taxReply_item_1_jurisdiction_0_code=06
taxReply_item_1_jurisdiction_0_taxable=0.00
taxReply_item_1_jurisdiction_0_rate=0.060000
taxReply_item_1_jurisdiction_0_taxAmount=0.00
taxReply_item_1_jurisdiction_0_name=CALIFORNIA
taxReply_item_1_jurisdiction_0_taxName=CA STATE TAX
taxReply_item_1_jurisdiction_1_country=US
taxReply_item_1_jurisdiction_1_region=CA
taxReply_item_1_jurisdiction_1_type=County
taxReply_item_1_jurisdiction_1_code=001
taxReply_item_1_jurisdiction_1_taxable=0.00
taxReply_item_1_jurisdiction_1_rate=0.002500
taxReply_item_1_jurisdiction_1_taxAmount=0.00
taxReply_item_1_jurisdiction_1_name=ALAMEDA
taxReply_item_1_jurisdiction_1_taxName=CA COUNTY TAX
taxReply_item_1_jurisdiction_2_country=US
taxReply_item_1_jurisdiction_2_region=CA
taxReply_item_1_jurisdiction_2_type=Special
taxReply_item_1_jurisdiction_2_code=EMAK0
taxReply_item_1_jurisdiction_2_taxable=0.00
taxReply_item_1_jurisdiction_2_rate=0.020000
taxReply_item_1_jurisdiction_2_taxAmount=0.00
taxReply_item_1_jurisdiction_2_name=ALAMEDA COUNTY DISTRICT TAX SP
taxReply_item_1_jurisdiction_2_taxName=CA SPECIAL TAX
taxReply_item_1_jurisdiction_3_country=US
taxReply_item_1_jurisdiction_3_region=CA
taxReply_item_1_jurisdiction_3_type=Special
taxReply_item_1_jurisdiction_3_code=EMSJ0
taxReply_item_1_jurisdiction_3_taxable=0.00
taxReply_item_1_jurisdiction_3_rate=0.010000
taxReply_item_1_jurisdiction_3_taxAmount=0.00
taxReply_item_1_jurisdiction_3_name=ALAMEDA CO LOCAL TAX SL
taxReply_item_1_jurisdiction_3_taxName=CA SPECIAL TAX

International Tax and VAT Committed Tax Calculation

Use a committed tax calculation to include the owed tax amount with a capture.
To commit a tax calculation, include the
taxService_commitIndicator
 field set to
true
 in a tax calculation request.

Endpoint

Set the
taxService
 field to
true
.
Send the request to
https://ics2ws.ic3.com/commerce/1.x/transactionProcessor
.

Required Fields for an International Tax and VAT Committed Tax Calculation Using the
SO
 API

Use these fields to perform a committed tax request.
billTo_country
ccAuthReply_requestAmount
invoiceHeader_merchantVATRegistrationNumber
merchantReferenceCode
taxService_commitIndicator
Set to
true
.
taxService
Set to
true
.

Optional Fields for an International Tax and VAT Committed Tax Calculation Using the
SO
 API

Use these fields to perform a committed tax request.
billTo_country
ccAuthReply_requestAmount
invoiceHeader_merchantVATRegistrationNumber
merchantReferenceCode
taxService_commitIndicator

Example: Processing an International Tax and VAT Committed Tax Calculation Using the SO API

Request
billTo_country=FR
invoiceHeader_merchantVATRegistrationNumber=123456789
item_#_unitPrice=1200
purchaseTotals_currency=EUR
taxService=true
taxService_commitIndicator=true
Response
merchantReferenceCode=482046C3A7E94F5
requestID=4817605701820004775333
decision=ACCEPT
reasonCode=100
purchaseTotals_currency=EUR
taxReply_totalCountryTaxAmount=0.00
taxReply_reasonCode=100
taxReply_totalSpecialTaxAmount=73.20
taxReply_totalTaxableAmount=2440.00
taxReply_totalStateTaxAmount=152.50
taxReply_totalExemptAmount=0.00
taxReply_grandTotalAmount=2671.80
taxReply_totalCityTaxAmount=0.00
taxReply_totalTaxAmount=231.80
taxReply_item_0_taxableAmount=1200.00
taxReply_item_0_exemptAmount=0.00
taxReply_item_0_specialTaxAmount=36.00
taxReply_item_0_cityTaxAmount=0.00
taxReply_item_0_countyTaxAmount=3.00
taxReply_item_0_stateTaxAmount=75.00
taxReply_item_0_countryTaxAmount=0.00
taxReply_item_0_totalTaxAmount=114.00
taxReply_item_0_jurisdiction_0_country=FR
taxReply_item_0_jurisdiction_0_region=FR
taxReply_item_0_jurisdiction_0_type=Country
taxReply_item_0_jurisdiction_0_code=06
taxReply_item_0_jurisdiction_0_taxable=1200.00
taxReply_item_0_jurisdiction_0_rate=0.062500
taxReply_item_0_jurisdiction_0_taxAmount=75.00
taxReply_item_0_jurisdiction_0_name=FR
taxReply_item_0_jurisdiction_0_taxName=FR STATE TAX
taxReply_item_0_jurisdiction_1_country=FR
taxReply_item_0_jurisdiction_1_region=FR
taxReply_item_0_jurisdiction_1_type=Country
taxReply_item_0_jurisdiction_1_code=001
taxReply_item_0_jurisdiction_1_taxable=1200.00
taxReply_item_0_jurisdiction_1_rate=0.002500
taxReply_item_0_jurisdiction_1_taxAmount=3.00
taxReply_item_0_jurisdiction_1_name=ALAMEDA
taxReply_item_0_jurisdiction_1_taxName=FR COUNTY TAX
taxReply_item_0_jurisdiction_2_country=FR
taxReply_item_0_jurisdiction_2_region=FR
taxReply_item_0_jurisdiction_2_type=Special
taxReply_item_0_jurisdiction_2_code=EMAK0
taxReply_item_0_jurisdiction_2_taxable=1200.00
taxReply_item_0_jurisdiction_2_rate=0.020000
taxReply_item_0_jurisdiction_2_taxAmount=24.00
taxReply_item_0_jurisdiction_2_name=ALAMEDA COUNTY DISTRICT TAX SP
taxReply_item_0_jurisdiction_2_taxName=FR SPECIAL TAX
taxReply_item_0_jurisdiction_3_country=FR
taxReply_item_0_jurisdiction_3_region=FR
taxReply_item_0_jurisdiction_3_type=Special
taxReply_item_0_jurisdiction_3_code=EMSJ0
taxReply_item_0_jurisdiction_3_taxable=1200.00
taxReply_item_0_jurisdiction_3_rate=0.010000
taxReply_item_0_jurisdiction_3_taxAmount=12.00
taxReply_item_0_jurisdiction_3_name=ALAMEDA CO LOCAL TAX SL
taxReply_item_0_jurisdiction_3_taxName=FR SPECIAL TAX