Home > API Fields > General Card-Present Offer-Level Fields


General Card-Present Offer-Level Fields

Table 9General Card-Present Offer-Level Fields

Field

Description

Used By:
Required (R) or Optional (O)

Data Type & Length

amount

Per-item price of the product. You must include either offer0 and this field or the request-level field grand_total_amount in your request. The value for this field cannot be negative. For information about offers and grand totals, see Getting Started with Cybersource Advanced for the SCMP API.

You can include a decimal point (.) in the value for this field, but you cannot include any other special characters. Cybersource truncates the amount to the correct number of decimal places.

ics_auth
(See description)

For GPN and JCN Gateway:
Decimal (10)

All other processors: Decimal (15)

merchant_product_sku

Product identifier code.

ics_auth (R when product_code is not default or one of the values related to shipping and/or handling.)

String (15)

product_code

Type of product. The value for this field is used to identify the product category (electronic, handling, physical, service, or shipping). The default value is default. For a list of valid values, see the information about product codes in Credit Card Services Using the SCMP API.

When the value for this field is not default or one of the values related to shipping and/or handling, the quantity, product_name, and merchant_product_sku fields are required. For information about offers and grand totals, see Getting Started with Cybersource Advanced for the SCMP API.

ics_auth (O)

String (30)

product_name

Name of product.

ics_auth (R when product_code is not default or one of the values related to shipping and/or handling.)

String (30)

quantity

Default is 1.

ics_auth (R when product_code is not default or one of the values related to shipping and/or handling.)

Nonnegative integer (10)

tax_amount

Total tax to apply to the product. This value cannot be negative. The tax amount and the offer amount must be in the same currency.

The tax amount field is additive. The following example uses a two-exponent currency such as USD:

1You include the following offer lines in your request:

offer0=amount:10.00^quantity:1^tax_amount:0.80

offer1=amount:20.00^quantity:1^tax_amount:1.60

2The total amount authorized will be 32.40, not 30.00 with 2.40 of tax included.

When you want to include tax_amount and also request the ics_tax service, see Tax Calculation Service Using the SCMP API.

ics_auth (O)

Decimal (15)