General Card-Present Request Fields
|
Field |
Description |
Used By: |
Data Type & Length |
|
ccAuthService_aggregatedAuthIndicator |
Flag for a mass transit transaction that indicates whether the authorization is aggregated. Possible values: ntrue: Aggregated nfalse: Not aggregated This field is supported only for mass transit transactions. |
ccAuthService (O) |
String (5) |
|
ccAuthService_captureDate |
Date on which the customer initiated a contactless transit transaction. Format: MMDD This field is supported only for mass transit transactions. |
ccAuthService (O) |
String (4) |
|
billTo_city |
Payment card billing city. |
ccAuthService: nChase Paymentech Solutions: O nCredit Mutuel-CIC: O nOmniPay Direct: O nSIX: O nTSYS Acquiring Solutions: R when keyed and ccAuthService_billPayment is true. nWorldpay VAP: O nAll other processors: not used. |
String (50) |
|
billTo_country |
Payment card billing country. Use the two-character ISO Standard Country Codes. |
ccAuthService: nChase Paymentech Solutions: O nCredit Mutuel-CIC: O nOmniPay Direct: O nSIX: O nTSYS Acquiring Solutions: R when keyed and ccAuthService_billPayment is true. nWorldpay VAP: O nAll other processors: not used. |
String (2) |
|
billTo_email |
Customer’s email address, including full domain name. |
ccAuthService: nChase Paymentech Solutions: O nCredit Mutuel-CIC: O nOmniPay Direct: O nSIX: O nTSYS Acquiring Solutions: R when keyed and ccAuthService_billPayment is true. nWorldpay VAP: O nAll other processors: not used. |
String (255) |
|
billTo_firstName |
Customer’s first name. Value should match value on card. |
ccAuthService: nChase Paymentech Solutions: O nCredit Mutuel-CIC: O nOmniPay Direct: O nSIX: O nTSYS Acquiring Solutions: R when keyed and ccAuthService_billPayment is true. nWorldpay VAP: O nAll other processors: not used. |
String (60) |
|
billTo_lastName |
Customer’s last name. Value should match value on card. |
ccAuthService: nChase Paymentech Solutions: O nCredit Mutuel-CIC: O nOmniPay Direct: O nRBS WorldPay Atlanta: O nSIX: O nTSYS Acquiring Solutions: R when keyed and ccAuthService_billPayment is true. nWorldpay VAP: O nAll other processors: not used. |
String (60) |
|
billTo_phoneNumber |
Customer’s phone number. Cybersource recommends that you include the country code when order is from outside the U.S. |
ccAuthService: nChase Paymentech Solutions: O nCredit Mutuel-CIC: O nOmniPay Direct: O nSIX: O nTSYS Acquiring Solutions: O nWorldpay VAP: O nAll other processors: not used. |
String (15) |
|
billTo_postalCode |
Postal code for billing address. Postal code must consist of 5 to 9 digits. When the billing country is U.S., the Example 12345-6789 When the billing country is Canada, the 6-digit postal code must follow this format: Example A1B 2C3 |
ccAuthService: nFDMS Nashville: R when keyed and the address is in the U.S. or Canada. O when keyed and the address is not in the U.S. or Canada. Not used when swiped. nRBS WorldPay Atlanta: when keyed, include this field for best card-present keyed rates. nTSYS Acquiring Solutions: R when keyed and ccAuthService_billPayment is true. nAll other processors: O. |
String (10) |
|
billTo_state |
Payment card billing state or province. Use State, Province, and Territory Codes for the United States and Canada. |
ccAuthService: nChase Paymentech Solutions: O nCredit Mutuel-CIC: O nOmniPay Direct: O nSIX: O nTSYS Acquiring Solutions: R when keyed and ccAuthService_billPayment is true. nWorldpay VAP: O nAll other processors: not used. |
String (2) |
|
billTo_street1 |
Payment card billing street address as it appears in the issuer’s records. FDMS Nashville When the street name is numeric, it must be sent in numeric format. For example, if the address is One First Street, it must be sent as 1 1st Street. |
ccAuthService: nFDMS Nashville: R when keyed; not used when swiped. nTSYS Acquiring Solutions: R when keyed and ccAuthService_billPayment is true. nAll other processors: O. |
FDMS Nashville: String (20) All other processors: String (60) |
|
billTo_street2 |
Used for additional address information. For example: FDMS Nashville billTo_street1 and billTo_street2 together cannot exceed 20 characters. |
ccAuthService (O) |
FDMS Nashville: String (20) All other processors: String (60) |
|
card_accountNumber |
Payment card number. |
ccAuthService: nFDMS Nashville: R. nAll other processors: R when keyed. |
FDMS Nashville: String with numbers only (19) All other processors: String with numbers only (20) |
|
card_cardType |
Three-digit value that indicates the card type. For the possible values, see Card Types. |
ccAuthService (R for Carte Blanche and JCB. O for other card types.) Important |
String (3) |
|
card_cvIndicator |
Indicates whether a CVN code was sent. Possible values: n0 (default): CVN service not requested. Cybersource uses this default when you do not include card_cvNumber in the request. n1 (default): CVN service requested and supported. Cybersource uses this default when you include card_cvNumber in the request. n2: CVN on payment card is illegible. n9: CVN not imprinted on payment card. |
ccAuthService: nFDMS Nashville: R for American Express; otherwise, O. nTSYS Acquiring Solutions: O when keyed; otherwise, not used. nAll other processors: O. |
String with numbers only (1) |
|
card_cvNumber |
CVN. See CVN information in Credit Card Services Using the Simple Order API. |
ccAuthService: nFDMS Nashville: R for American Express or when swiped; otherwise, O. nTSYS Acquiring Solutions: O when keyed; otherwise, not used. nAll other processors: O. |
String with numbers only (4) |
|
card_expirationMonth |
Two-digit month in which payment card expires. Format: MM. |
ccAuthService: nFDMS Nashville: R. nAll other processors: R when keyed.1 |
String (2) |
|
card_expirationYear |
Four-digit year in which payment card expires. Format: YYYY. |
ccAuthService: nFDMS Nashville: R. nAll other processors: R when keyed.1 |
String (4) |
|
ccAuthService_billPayment |
Indicates payment for bill or payment towards existing contractual loan. For information about Visa Bill Payments and Visa Debt Repayments, see Credit Card Services Using the Simple Order API. Possible values: ntrue: Bill payment or loan payment. nfalse (default): Not a bill payment or loan payment. |
ccAuthService (O) |
String (5) |
|
ccAuthService_commerceIndicator |
Type of transaction. For a card-present transaction, you must set this field to retail. |
ccAuthService (R) |
String (13) |
|
ccAuthService_run |
Set to true to request payment card authorization. |
ccAuthService (R) |
String (255) |
|
ccAuthService_debtRecoveryIndicator |
Flag for a mass transit transaction that indicates whether the purpose of the authorization is to recover debt. Possible values: ntrue: Debt recovery transaction nfalse: Not a debt recovery transaction The value for this field corresponds to the following data in the TC 33 capture file1: nRecord: CP01 TCR7 nPosition: 150-151 nField: Transit Transaction Type Indicator This field is supported only for mass transit transactions. |
ccAuthService (O) |
String (5) |
|
ccAuthService_deferredAuthIndicator |
Indicates whether the authorization request was delayed because connectivity was interrupted. Possible values: ntrue: Deferred authorization nfalse (default): Not a deferred authorization The value for this field corresponds to the following two data items in the TC 33 capture file1: nFirst data item: lRecord: CP01 TCR0 lPosition: 160-163 lField: Message Reason Code nSecond data item: lRecord: CP01 TCR7 lPosition: 150-151 lField: Transit Transaction Type Indicator This field is supported only for mass transit transactions. |
ccAuthService (O) |
String (5) |
|
ccAuthService_industryDatatype |
Indicates whether the transaction includes mass transit transaction (MTT) data. You must set this field to transit in order for MTT data to be sent to the processor. When this field is not set to transit or is not included in the request, Cybersource does not send MTT data to the processor. This field is supported only for mass transit transactions. |
ccAuthService (R for MTT transactions) |
String (7) |
|
ccAuthService_transportationMode |
Mode of transportation or type of transportation-related payment. Possible values: n00: Use this value for: lDebt recovery lMore than one transportation mode lUnknown transportation mode n01: Urban bus n02: Interurban bus n03: Light train mass transit n04: Train n05: Commuter train n06: Water-borne vehicle n07: Toll n08: Parking n09: Taxi n10: High-speed train n11: Rural bus n12: Express commuter train n13: Paratransit n14: Self-driving vehicle n15: Coach n16: Locomotive n17: Powered motor coach n18: Trailer n19: Regional train n20: Inter-city transportation n21: Funicular train n22: Cable car This field is supported only for mass transit transactions. |
ccAuthService (O) |
String (2) |
|
comments |
Brief description or comments for the order. Cybersource does not forward this value to the processor. Instead, the value is forwarded to the Cybersource reporting software. This field is supported only for Cybersource integrations as described in Cybersource Integration. |
ccAuthService (O) |
String (255) |
|
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) |
String (30) |
|
item_#_productName |
Product name. |
ccAuthService (R when item_#_productCode is not default or one of the values related to shipping and/or handling.) |
String (30) |
|
item_#_productSKU |
Product identifier code. |
ccAuthService (R when item_#_productCode is not default or one of the values related to shipping and/or handling.) |
String (15) |
|
item_#_quantity |
Default is 1. |
ccAuthService (R when item_#_productCode is not default or one of the values related to shipping and/or handling.) |
Integer (10) |
|
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: 1You include the following items in your request: item_0_unitPrice=10.00 item_1_unitPrice=20.00 2The total amount authorized is 32.40, not 30.00 with 2.40 of tax included. When you want to include item_#_taxAmount and also request the taxService service, see Tax Calculation Service Using the Simple Order API. |
ccAuthService (O) |
String (15) |
|
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 |
For GPN and JCN Gateway: All other processors: String (15) |
|
jpo_jccaTerminalID |
Unique Japan Credit Card Association (JCCA) terminal identifier that is provided by Cybersource. The difference between this field and the pos_terminalID field is that you can define pos_terminalID, but jpo_jccaTerminalID is defined by the JCCA and is used only in Japan. This field is supported only on JCN Gateway. |
ccAuthService (O) |
Integer (13) |
|
jpo_jis2TrackData |
Japanese Industrial Standard Type 2 (JIS2) track data from the front of the card. This field is supported only on JCN Gateway. |
ccAuthService (O) ccCreditService (O) |
String (69) |
|
Identifier for the merchandise. This field is supported only on the processors listed in this field description. American Express Direct Value: n1000: Gift card JCN Gateway This value must be right justified. In Japan, this value is called a goods code. |
ccAuthService (O) |
Integer (7) |
|
|
merchantID |
Your Cybersource merchant ID. |
ccAuthService (R) |
String (30) |
|
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. FDC Nashville Global This value must be numeric and must be less than 9 digits. When you do not send a valid value, Cybersource creates one for you. However, the value is not returned to you, so you cannot use the merchant reference number to track the order.
|
ccAuthService (R) |
String (50) |
|
partnerOriginalTransactionID |
Value that links the previous transaction to the current follow-on request. This value is assigned by the client software that is installed on the POS terminal, which makes it available to the terminal’s software and to Cybersource. Therefore, you can use this value to reconcile transactions between Cybersource and the terminal’s software. Cybersource does not forward this value to the processor. Instead, the value is forwarded to the Cybersource reporting software. This field is supported only for Cybersource integrations as described in Cybersource Integration. |
ccAuthService (O) ccAuthReversalService (O) ccCaptureService (O) ccCreditService (O) |
String (32) |
|
partnerSDKversion |
Version of the software installed on the POS terminal. Cybersource does not forward this value to the processor. Instead, the value is forwarded to the Cybersource reporting software. This field is supported only for Cybersource integrations as described in Cybersource Integration. |
ccAuthService (O) ccCreditService (O) |
String (32) |
|
pos_cardPresent |
Indicates whether the card is present at the time of the transaction. Possible values: nN: Card is not present. nY: Card is present. |
ccAuthService: nFDMS Nashville: not used. nAll other processors: R. |
String (1) |
|
pos_catLevel |
Type of cardholder-activated terminal. Possible values: n1: Automated dispensing machine n2: Self-service terminal n3: Limited amount terminal n4: In-flight commerce (IFC) terminal n5: Radio frequency device n6: Mobile acceptance terminal n7: Electronic cash register n8: E-commerce device at your location n9: Terminal or cash register that uses a dial-up connection to connect to the transaction processing network Chase Paymentech Solutions Only values 1, 2, and 3 are supported. FDC Nashville Global Only values 7, 8, and 9 are supported. GPN Only values 6, 7, 8, and 9 are supported. JCN Gateway Only values 6, 7, 8, and 9 are supported. Prosa Values 1 through 9 are supported. TSYS Acquiring Solutions Only value 6 is supported. |
ccAuthService: nChase Paymentech Solutions: R when pos_terminalID is included in the request; otherwise, O. nFDC Nashville Global: O for EMV transactions; otherwise, not used. nGPN: R. nJCN Gateway: R. nProsa: R. nTSYS Acquiring Solutions: R for transactions from mobile devices; otherwise, not used. nAll other processors: not used. |
Nonnegative integer (1) |
|
pos_deviceID |
Value created by the client software that uniquely identifies the POS device. Cybersource does not forward this value to the processor. Instead, the value is forwarded to the Cybersource reporting software. This field is supported only for Cybersource integrations as described in Cybersource Integration. |
ccAuthService (O) ccCreditService (O) |
String (32) |
|
pos_entryMode |
Method of entering payment card information into the POS terminal. Possible values: ncontact: Read from direct contact with chip card. ncontactless: Read from a contactless interface using chip data. nkeyed: Manually keyed into POS terminal. This value is not supported on OmniPay Direct. nmsd: Read from a contactless interface using magnetic stripe data (MSD). This value is not supported on OmniPay Direct. nswiped: Read from payment card magnetic stripe. The contact, contactless, and msd values are supported only for EMV transactions. See Europay, Mastercard, Visa (EMV). |
ccAuthService (R) |
String (11) |
|
pos_storeAndForwardIndicator |
When connectivity is unavailable, the client software that is installed on the POS terminal can store a transaction in its memory and send it for authorization when connectivity is restored. Cybersource does not forward this value to the processor. Instead, the value is forwarded to the Cybersource reporting software. Possible values: ntrue: Transaction was stored and then forwarded. nfalse (default): Transaction was not stored and then forwarded. This field is supported only for Cybersource integrations as described in Cybersource Integration, but is not supported for Credit Mutuel-CIC. |
ccAuthService (O) ccCreditService (O) |
String (5) |
|
pos_terminalCapability |
POS terminal’s capability. Possible values: n1: Terminal has a magnetic stripe reader only. n2: Terminal has a magnetic stripe reader and manual entry capability. n3: Terminal has manual entry capability only. n4: Terminal can read chip cards. n5: Terminal can read contactless chip cards; cannot use contact to read chip cards. For an EMV transaction, the value of this field must be 4 or 5. See Europay, Mastercard, Visa (EMV). |
ccAuthService: nR for the following processors: lAmerican Express Direct lChase Paymentech Solutions lCredit Mutuel-CIC lFDC Nashville Global lFDMS Nashville lOmniPay Direct lProsa lSIX lWorldpay VAP nO for the following processors: lGPN lJCN Gateway lRBS WorldPay Atlanta lTSYS Acquiring Solutions |
Integer (1) |
|
pos_terminalCardCaptureCapability |
Indicates whether the terminal can capture the card. Possible values: n1: Terminal can capture card. n0: Terminal cannot capture card. This field is supported only for Cybersource integrations as described in Cybersource Integration, but is not supported for FDC Nashville Global or SIX. |
ccAuthService (O) ccCreditService (O) |
String (5) |
|
pos_terminalCVM |
Complete list of cardholder verification methods (CVMs) supported by the terminal. Possible values: nPIN nSignature This field is supported only for Cybersource integrations as described in Cybersource Integration. |
ccAuthService (O) ccCreditService (O) |
String (15) |
|
pos_terminalID |
Identifier for the terminal at your retail location. You can define this value yourself, but consult the processor for requirements. FDC Nashville Global To have your account configured to support this field, contact Cybersource Customer Support. This value must be a value that FDC Nashville Global issued to you. |
ccAuthService: nO for the following processors. When not included in the request, Cybersource uses the value in your Cybersource account. lAmerican Express Direct lCredit Mutuel-CIC lFDC Nashville Global lProsa lSIX nChase Paymentech Solutions: O. When you include this field in the request, you must also include pos_catLevel. nFDMS Nashville: Cybersource uses the value in your Cybersource account. nOmniPay Direct: O nFor the following processors, this field is not used. lGPN lJCN Gateway lRBS WorldPay Atlanta lTSYS Acquiring Solutions lWorldpay VAP |
String (8) |
|
pos_terminalIDAlternate |
Identifier for an alternate terminal at your retail location. You define the value for this field. This field is supported only for Mastercard transactions on FDC Nashville Global. Use the pos_terminalID field to identify the main terminal at your retail location. When your retail location has multiple terminals, use this pos_terminalIDAlternate field to identify the terminal used for the transaction. This field is a pass-through, which means that Cybersource does not check the value or modify the value in any way before sending it to the processor. |
ccAuthService: nFDC Nashville Global: O for Mastercard transactions; otherwise, not used. nAll other processors: not used. |
String (8) |
|
pos_terminalInput |
Complete list of card input methods supported by the terminal. Possible values: nKeyed: Terminal can accept card data that is entered manually. nSwiped: Terminal can accept card data from a magnetic stripe reader. nContact: Terminal can accept card data in EMV contact mode. nContactless: Terminal can accept card data in EMV contactless mode. nBarCode: Terminal can read bar codes. nQRcode: Terminal can read QR codes. nOCR: Terminal can perform optical character recognition (OCT). This field is supported only for Cybersource integrations as described in Cybersource Integration. |
ccAuthService (O) ccCreditService (O) |
String (15) |
|
pos_terminalOutputCapability |
Indicates whether the terminal can print or display messages. Possible values: n1: Neither n2: Print only n3: Display only n4: Print and display This field is supported only for Cybersource integrations as described in Cybersource Integration. |
ccAuthService (O) ccCreditService (O) |
String (1) |
|
pos_terminalPINcapability |
Maximum PIN length that the terminal can capture. Possible values: n0: No PIN capture capability n1: PIN capture capability unknown n4: Four characters n5: Five characters n6: Six characters n7: Seven characters n8: Eight characters n9: Nine characters n10: Ten characters n11: Eleven characters n12: Twelve characters This field is supported only for Cybersource integrations as described in Cybersource Integration, but is not supported on FDC Nashville Global. |
ccAuthService (R for PIN transactions) ccCreditService (R for PIN transactions) |
Integer (2) |
|
pos_terminalSerialNumber |
Terminal serial number assigned by the hardware manufacturer. Cybersource does not forward this value to the processor. Instead, the value is forwarded to the Cybersource reporting software. This field is supported only for Cybersource integrations as described in Cybersource Integration. |
ccAuthService (O) ccCreditService (O) |
String (32) |
|
pos_terminalType |
Type of terminal. Possible values: n21: Attended terminal, online only n22: Attended terminal, offline with online capability n23: Attended terminal, offline only n24: Unattended terminal, online only n25: Unattended terminal, offline with online capability n26: Unattended terminal, offline only This field is supported only for Cybersource integrations as described in Cybersource Integration. |
ccAuthService (O) ccAuthReversalService (O) ccCreditService (O) |
String (2) |
|
purchaseTotals_currency |
Currency used for order. For possible values, see ISO Standard Currency Codes. |
ccAuthService (R) |
String (5) |
|
purchaseTotals_grandTotalAmount |
Grand total for the order. 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 |
String (15) |
|
salesSlipNumber |
Transaction identifier that you generate. This field is supported only on JCN Gateway. |
ccAuthService (R) ccCreditService (R for stand-alone credits) |
Integer (5) |
|
shipTo_city |
City of shipping address. |
ccAuthService (R when shipping address information is included in the request and shipping to the U.S. or Canada; otherwise, O.) |
String (50) |
|
shipTo_country |
Country of shipping address. Use the two-character ISO Standard Country Codes. |
ccAuthService (R when shipping address information is included in the request; otherwise, O.) |
String (2) |
|
shipTo_firstName |
First name of the person receiving the shipment. |
ccAuthService (O) |
String (60) |
|
shipTo_lastName |
Last name of the person receiving the shipment. |
ccAuthService (O) |
String (60) |
|
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: Example 12345-6789 When the shipping country is Canada, the 6-digit postal code must follow this format: Example A1B 2C3 |
ccAuthService (R when shipping address information is included in the request and shipping to the U.S. or Canada; otherwise, O.) |
String (10) |
|
shipTo_state |
State or province to ship the product to. Use the State, Province, and Territory Codes for the United States and Canada. |
ccAuthService (R when shipping address information is included in the request and shipping to the U.S. or Canada; otherwise, O.) |
String (2) |
|
shipTo_street1 |
First line of shipping address. |
ccAuthService (R when shipping address information is included in the request; otherwise, O.) |
String (60) |
|
shipTo_street2 |
Second line of shipping address. |
ccAuthService (O) |
String (60) |
|
transactionLocalDateTime |
Date and time at your physical location. Format: YYYYMMDDhhmmss, where |
ccAuthService: nR for the following processors: lAmerican Express Direct lCredit Mutuel-CIC lFDC Nashville Global lSIX nO for all other processors. |
String (14) |