Offer-Level Fields

Each offer submitted in a request contains several fields that describe the product that the customer ordered through your web store. The amount field is required. If multiple products are ordered in a single purchase, a Cybersource service application request can contain one or more offers, referred to as offer0 through offerN. If you use more than one consecutive space, the extra spaces will be removed.

 

Do not use carets (^) and colons (:) in offer fields. These are reserved characters. Carets separate name-value pairs, and colons separate field names from values.

Table 22Offer-Level Fields

Field Name

Description

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

Data Type & Length

amount

Per-item price of the product. You can include a decimal point (.) in this field, but you cannot include any other special characters. The amount will be truncated to the correct number of decimal places.

Note  This field is optional if you use the request-level field .

ics_pa_enroll (R)

ics_pa_validate (R)

Decimal (15)

merchant_product_sku

Merchant’s product identifier code.

ics_pa_enroll (O)

String (255)

passenger_firstname

Passenger

ics_pa_enroll (O)

String (60)

passenger_lastname

Passenger

ics_pa_enroll (O)

String (60)

product_description

Brief description of item.

ics_pa_enroll (O)

String (256)

product_name

Name of the product.

ics_pa_enroll (O)

String (255)

quantity

Quantity of the product being purchased. The default value is 1.

ics_pa_enroll (O)

ics_pa_validate (O)

Non-negative integer (10)

shipping_destination_types

Destination to which the item is shipped.

Example  Commercial, residential, store

ics_pa_enroll (O)

String (50)

tax_amount

Total tax to apply to the product. The tax_amount field is additive. For example, if you send these offer lines

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

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

the total amount authorized will be for $32.40, not 30.00 with 2.40 of tax included.

The tax_amount and the amount must be in the same currency.

ics_pa_enroll (O)

ics_pa_validate (O)

Decimal (15)