Request Fields

Table 2

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

Data Type & Length

City of the billing address.

ccAuthService (O)

Country of the billing address. Use the two-character ISO Standard Country Codes.

ccAuthService (O)

Customer’s email address.

ccAuthService (O)

billTo_firstName

Customer’s first name. For a credit card transaction, this name must match the name on the card.

ccAuthService (O)

billTo_lastName

Customer’s last name. For a credit card transaction, this name must match the name on the card.

ccAuthService (O)

billTo_phoneNumber

Customer’s phone number. CyberSource recommends that you include the country code when the order is from outside the U.S.

ccAuthService (O)

billTo_postalCode

Postal code for the billing address. The postal code must consist of 5 to 9 digits.

When the billing country is the U.S., the 9-digit postal code must follow this format:
[5 digits][dash][4 digits]
Example: 12345-6789

When the billing country is Canada, the 6-digit postal code must follow this format:
[alpha][numeric][alpha][space]
[numeric][alpha][numeric]
Example: A1B 2C3

ccAuthService (O)

State or province of the billing address. Use the State, Province, and Territory Codes for the United States and Canada.

ccAuthService (O)

First line of the billing street address.

ccAuthService (O)

Additional address information. Example:

Attention: Accounts Payable

ccAuthService (O)

Type of card to authorize. Possible value:

■

001: Visa

ccAuthService (R)

ccAuthService_commerceIndicator

Type of transaction. For a Chase Pay POS transaction, you must set this field to retail.

ccAuthService (R)

ccAuthService_run

Set to true to request credit card authorization.

ccAuthService (R)

emvRequest_combinedTags

The EMV data is in the tag-length-value format and includes chip card tags, terminal tags, and transaction detail tags.

Include all tags required by Chase Pay POS as described in the Chase Pay API Specification, Version 0.94.

For information about the individual tags, see the “Application Specification” section in the EMV 4.3 Specifications: http://emvco.com

Important The following tags contain sensitive information and must not be included in this field:

■

56: Track 1 equivalent data

■

57: Track 2 equivalent data

■

5A: Application PAN

■

5F20: Cardholder name

■

5F24: Application expiration date

■

99: Transaction PIN

■

9F0B: Cardholder name (extended)

■

9F1F: Track 1 discretionary data

■

9F20: Track 2 discretionary data

ccAuthService (R)

item_#_productCode

Type of product. This value 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 Simple Order API.

When this field is not set to default or one of the values related to shipping and/or handling, the item_#_quantity, item_#_productName, and item_#_productSKU fields are required. For information about items and grand totals, see Getting Started with CyberSource Advanced for the Simple Order API.

ccAuthService (O)

item_#_productName

Required when item_#_productCode is not default or one of the values related to shipping and/or handling.

ccAuthService
(See description)

item_#_productSKU

Product identifier code. Required when item_#_productCode is not default or one of the values related to shipping and/or handling.

ccAuthService
(See description)

item_#_quantity

Default is 1. Required when item_#_productCode is not default or one of the values related to shipping and/or handling.

ccAuthService
(See description)

item_#_taxAmount

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

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

1

You include the following items in your request:

item_0_unitPrice=10.00
item_0_quantity=1
item_0_taxAmount=0.80

item_1_unitPrice=20.00
item_1_quantity=1
item_1_taxAmount=1.60

2

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

ccAuthService (O)

item_#_unitPrice

Per-item price of the product. You must include either this field or purchaseTotals_grandTotalAmount in your request. This value cannot be negative. For information about items and grand totals, see Getting Started with CyberSource Advanced for the Simple Order 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.

ccAuthService
(See description)

Your CyberSource merchant ID. Use the same merchant ID for evaluation, testing, and production.

ccAuthService (R)

merchantReferenceCode

Merchant-generated order reference or tracking number. CyberSource recommends that you send a unique value for each transaction so that you can perform meaningful searches for the transaction. For information about tracking orders, see Getting Started with CyberSource Advanced for the Simple Order API.

ccAuthService (R)

paymentNetworkToken_requestorID

Value that identifies your business and indicates that the cardholder’s account number is tokenized. This value is assigned by the token service provider and is unique within the token service provider’s database.

ccAuthService (O)

paymentNetworkToken_transactionType

Type of transaction that provided the token data. This value does not specify the token service provider; it specifies the entity that provided you with information about the token.

Possible value:

■

1: In-app transaction. An application on the customer’s mobile device provided the token data for an e‑commerce transaction.

ccAuthService (R)

paymentSolution

Digital solution identifier. Possible value:

■

007: Chase Pay

ccAuthService (R)

pos_cardPresent

Indicates whether the card is present at the time of the transaction. Possible value:

■

N: Card is not present.

ccAuthService (R)

Method of entering credit card information into the POS terminal. Possible value:

■

ccAuthService (R)

pos_terminalCapability

POS terminal’s capability. Possible value:

■

4: Terminal can read chip cards.

ccAuthService (R)

Identifier for the terminal at your retail location. You can define this value yourself, but consult the processor for requirements.

ccAuthService (R)

Track 2 data. This value must include:

■

Semicolon (;) for the start sentinel

■

Equals sign (=) after the card account number

■

Question mark (?) for the end sentinel

Example: ;4111111111111111=25122010123499999991?

ccAuthService (R)

purchaseTotals_currency

Currency used for the order. Use the three-character ISO Standard Currency Codes.

ccAuthService (R)

purchaseTotals_grandTotalAmount

Grand total for the order. This value cannot be negative. You can include a decimal point (.), but you cannot include any other special characters. CyberSource truncates the amount to the correct number of decimal places.

You must include either this field or item_#_unitPrice in your request. For information about items and grand totals, Getting Started with CyberSource Advanced for the Simple Order API.

ccAuthService
(See description)

City of shipping address.

ccAuthService (Required if any shipping address information is included in the request and shipping to the U.S. or Canada; otherwise, optional.)

Country of shipping address. Use the two-character ISO Standard Country Codes.

ccAuthService (Required if any shipping address information is included in the request; otherwise, optional.)

shipTo_firstName

First name of the person receiving the shipment.

ccAuthService (O)

shipTo_lastName

Last name of the person receiving the shipment.

ccAuthService (O)

shipTo_postalCode

Postal code for the shipping address. The postal code must consist of 5 to 9 digits.

When the shipping country is the U.S., the 9-digit postal code must follow this format:
[5 digits][dash][4 digits]
Example: 12345-6789

When the shipping country is Canada, the 6-digit postal code must follow this format:
[alpha][numeric][alpha][space][numeric][alpha]
[numeric]
Example: A1B 2C3

ccAuthService (Required if any shipping address information is included in the request and shipping to the U.S. or Canada; otherwise, optional.)

State or province of shipping address. Use the State, Province, and Territory Codes for the United States and Canada.

ccAuthService (Required if any shipping address information is included in the request and shipping to the U.S. or Canada; otherwise, optional.)

First line of shipping address.

ccAuthService (Required if any shipping address information is included in the request; otherwise, optional.)

Second line of shipping address.

ccAuthService (O)