Request Fields

 

When generating the security signature, create a comma-separated name=value string of the POST fields that are included in the signed_field_names field. The ordering of the fields in the string is critical to the signature generation process. For example: ■ bill_to_forename=john ■ bill_to_surname=doe ■ bill_to_email=jdoe@example.com ■ signed_field_names=bill_to_forename,bill_to_email,bill_to_surname The string to sign is bill_to_forename=john,bill_to_email=jdoe@example.com,bill_to_surname =doe For information on the signature generation process, see the security script of the sample code for the scripting language you are using. See Samples in Scripting Languages.

 

For data type definitions and permitted characters, see Data Type Definitions.

 

Table 6

Request Fields

Field	Description	Used By: Required (R) or Optional (O)	Data Type & Length
access_key	Required for authentication with Secure Acceptance. See Creating a Security Key.	Required by the Secure Acceptance application.	Alphanumeric String (32)
aggregator_id	Value that identifies you as a payment aggregator. Obtain this value for the processor. CyberSource through VisaNet The value for this field corresponds to the following data in the TC 33 capture file1: ■ Record: CP01 TCR6 ■ Position: 95-105 ■ Field: Mastercard Payment Facilitator ID FDC Compass This value must consist of uppercase characters. Field Length American Express Direct: 20 CyberSource through VisaNet: 11 FDC Compass: 20 FDC Nashville Global: 15 Required/Optional American Express Direct: R for all aggregator transactions. CyberSource through VisaNet: R for Mastercard aggregator authorizations; otherwise, not used. FDC Compass: R for all aggregator transactions. FDC Nashville Global: R for all aggregator transactions.	authorization (See description)	String (See description)
allow_payment_token_update	Indicates whether the customer can update the billing, shipping, and payment information on the order review page. This field can contain one of the following values: ■ true: Customer can update details. ■ false: Customer cannot update details.	update_payment_token (R)	Enumerated String String (5)
amount	Total amount for the order. Must be greater than or equal to zero and must equal the total amount of each line item including the tax amount.	■ create_payment_token (R) ■ authorization or sale (R) ■ authorization,create_payment_token (R) ■ sale,create_payment_token (R) ■ update_payment_token (O)	Amount String (15)
auth_indicator	Flag that specifies the purpose of the authorization. Possible values: ■ 0: Preauthorization ■ 1: Final authorization Mastercard requires European merchants to indicate whether the authorization is a final authorization or a preauthorization. To set the default for this field, contact CyberSource Customer Support.	authorization (See description)	String (1)
auth_type	Authorization type. Possible values: ■ AUTOCAPTURE: Automatic capture. ■ STANDARDCAPTURE: Standard capture. ■ verbal: Forced capture. Asia, Middle East, and Africa Gateway; Cielo; Comercio Latino; and CyberSource Latin American Processing Set this field to AUTOCAPTURE and include it in a bundled request to indicate that you are requesting an automatic capture. If your account is configured to enable automatic captures, set this field to STANDARDCAPTURE and include it in a standard authorization or bundled request to indicate that you are overriding an automatic capture.	ics_auth (See description.) ics_bill (Required for a verbal authorization; otherwise, not used.)	Cielo, Comercio Latino, and CyberSource Latin American Processing: String (15) All other processors: String (11)
bill_payment	Flag that indicates a payment for a bill or for an existing contractual loan.Visa provides a Bill Payment program that enables customers to use their Visa cards to pay their bills. Possible values: ■ true: Bill payment or loan payment. ■ false (default): Not a bill payment or loan payment.	This field is optional.	Enumerated String String (5)
bill_to_address_city	City in the billing address.	■ create_payment_token (R) ■ authorization or sale (R) ■ authorization,create_payment_token (R) ■ sale,create_payment_token (R) ■ update_payment_token (O)	AlphaNumericPunctuation Atos: String (32) All other processors: String (50)
bill_to_address_country	Country code for the billing address. Use the two-character ISO country codes.	■ create_payment_token (R) ■ authorization or sale (R) ■ authorization,create_payment_token (R) ■ sale,create_payment_token (R) ■ update_payment_token (O)	Alpha String (2)
bill_to_address_line1	First line of the billing address. Note On JCN Gateway, this field is required when the authorization or sale request includes create_payment_token or Decision Manager. This field is optional when requesting an authorization or a sale without create_payment_token or Decision Manager.	■ create_payment_token (R) ■ authorization or sale (R) ■ authorization,create_payment_token (R) ■ sale,create_payment_token (R) ■ update_payment_token (O)	AlphaNumericPunctuation Atos: String (29) CyberSource through VisaNet: String (40) Moneris: String (50) Worldpay VAP: String (35) All other processors: String (60)
bill_to_address_line2	Second line of the billing address.	This field is optional.	AlphaNumericPunctuation Atos: String (29) CyberSource through VisaNet: String (40) Moneris: String (50) Worldpay VAP: String (35) All other processors: String (60)
bill_to_address_postal_code	Postal code for the billing address. Note This field is required if bill_to_address_country is U.S. or CA. 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 For the rest of the world countries, the maximum length is 10.	■ create_payment_token (R) ■ authorization or sale (R) ■ authorization,create_payment_token (R) ■ sale,create_payment_token (R) ■ update_payment_token (O)	AlphaNumericPunctuation See description.
bill_to_address_state	State or province in the billing address. Use the two-character ISO state and province code. Note This field is required for U.S. and Canada.	See description.	AlphaNumericPunctuation String (2)
bill_to_company_name	Name of the customer’s company.	This field is optional.	AlphaNumericPunctuation String (40)
bill_to_email	Customer email address, including the full domain name.	■ create_payment_token (R) ■ authorization or sale (R) ■ authorization,create_payment_token (R) ■ sale,create_payment_token (R) ■ update_payment_token (O)	Email String (255)
bill_to_forename	Customer first name. This name must be the same as the name on the card.	■ create_payment_token (R) ■ authorization or sale (R) ■ authorization,create_payment_token (R) ■ sale,create_payment_token (R) ■ update_payment_token (O)	AlphaNumericPunctuation String (60)
bill_to_phone	Customer phone number. CyberSource recommends that you include the country code if the order is from outside the U.S. Note This field is optional for card payments. For eCheck payments this field is required if your processor is CyberSource ACH Service or Telecheck.	See description.	Phone String (6 to 15) String (10) if using Telecheck for echeck payments.
bill_to_surname	Customer last name. This name must be the same as the name on the card.	■ create_payment_token (R) ■ authorization or sale (R) ■ authorization,create_payment_token (R) ■ sale,create_payment_token (R) ■ update_payment_token (O)	AlphaNumericPunctuation String (60)
card_account_type	Flag that specifies the type of account associated with the card. The cardholder provides this information during the payment process. Cielo and Comercio Latino Possible values: ■ CR: Credit card ■ DB: Debit card CyberSource through VisaNet Possible values: ■ CH: Checking account ■ CR: Credit card account ■ SA: Savings account This field is required for: ■ Debit transactions on Cielo and Comercio Latino. ■ Transactions with Brazilian-issued cards on CyberSource through VisaNet. Note Combo cards in Brazil contain credit and debit functionality in a single card. Visa systems use a credit bank identification number (BIN) for this type of card. Using the BIN to determine whether a card is debit or credit can cause transactions with these cards to be processed incorrectly. CyberSource strongly recommends that you include this field for combo card transactions.	ics_auth (O)	String (2)
card_cvn	Card verification number. Important For American Express card types, the cvn must be 4 digits. This field can be configured as required or optional. See Configuring Payment Methods.	See description.	Numeric String (4)
card_expiry_date	Card expiration date. Format: MM-YYYY	■ create_payment_token (R) ■ authorization or sale (R) ■ authorization,create_payment_token (R) ■ sale,create_payment_token (R) ■ update_payment_token (O)	Date (a) String (7)
card_number	Card number. Important Use only numeric values. Make sure that you include valid and well formed data for this field.	■ create_payment_token (R) ■ authorization or sale (R) ■ authorization,create_payment_token (R) ■ sale,create_payment_token (R) ■ update_payment_token (O)	Numeric String (20)
card_type	Type of card to authorize. Use one of these values: 001: Visa 002: Mastercard 003: American Express 004: Discover 005: Diners Club—cards starting with 54 or 55 are rejected. 006: Carte Blanche 007: JCB 014: EnRoute 021: JAL 024: Maestro UK Domestic 031: Delta 033: Visa Electron 034: Dankort 036: Cartes Bancaires 037: Carta Si 042: Maestro International 043: GE Money UK card 050: Hipercard (sale only) 054: Elo 055: Private Label	■ create_payment_token (R) ■ authorization or sale (R) ■ authorization,create_payment_token (R) ■ sale,create_payment_token (R) ■ update_payment_token (O)	Enumerated String String (3)
card_type_selection_indicator	Identifies whether the card type is the result of the default acquirer parameter settings or the selection of the cardholder. Possible values: ■ 0: Card type selected by default acquirer settings. ■ 1: Card type selected by cardholder. This field is supported only on Credit Mutuel-CIC. The default value is 1.	ics_auth (O)	String (1)
company_tax_id	Company’s tax identifier. Note Contact your TeleCheck representative to find out whether this field is required or optional.	■ sale (See description) ■ create_payment_token (See description) ■ sale,create_payment_token (See description) ■ update_payment_token (See description)	AlphaNumericPunctuation String (9)
complete_route	Concatenation of individual travel legs in the format for example: SFO-JFK:JFK-LHR:LHR-CDG. For a complete list of airport codes, see IATA’s City Code Directory. In your request, send either the complete route or the individual legs (journey_leg#_orig and journey_leg#_dest). If you send all the fields, the value of complete_route takes precedence over that of the journey_leg# fields.	This field is optional. See Using Decision Manager.	AlphaNumericPunctuation String (255)
conditions_accepted	Indicates whether the customer accepted the service few amount. Possible values: ■ false: The customer did not accept. ■ true: The customer did accept.	This is a required field if service fee is enabled for the profile. See Enabling the Service Fee.	Enumerated String String (5)
consumer_id	Identifier for the customer’s account. This field is defined when you create a subscription.	■ create_payment_token (O) ■ authorization,create_payment_token (O) ■ sale,create_payment_token (O) ■ update_payment_token (O)	AlphaNumericPunctuation String (100)
currency	Currency used for the order. For the possible values, see the ISO currency codes.	■ create_payment_token (R) ■ authorization or sale (R) ■ authorization,create_payment_token (R) ■ sale,create_payment_token (R) ■ update_payment_token (O)	Alpha String (3)
customer_cookies_accepted	Indicates whether the customer’s browser accepts cookies. This field can contain one of the following values: ■ true: Customer browser accepts cookies. ■ false: Customer browser does not accept cookies.	This field is optional. See Using Decision Manager.	Enumerated String String (5)
customer_gift_wrap	Indicates whether the customer requested gift wrapping for this purchase. This field can contain one of the following values: ■ true: Customer requested gift wrapping. ■ false: Customer did not request gift wrapping.	This field is optional. See Using Decision Manager.	Enumerated String String (5)
customer_ip_address	Customer’s IP address reported by your web server via socket information.	This field is optional. See Using Decision Manager.	IP String (15)
date_of_birth	Date of birth of the customer. Use the format: YYYYMMDD.	This field is optional. See Using Decision Manager.	Date (b) String (8)
debt_indicator	Flag that indicates a payment for an existing contractual loan under the VISA Debt Repayment program. Contact your processor for details and requirements. Possible formats: ■ false (default): Not a loan payment. ■ true: Loan payment.	This field is optional.	Enumerated String String (5)
departure_time	Departure date and time of the first leg of the trip. Use one of the following formats: yyyy-MM-dd HH:mm z (2019-01-20 11:30 GMT) yyyy-MM-dd hh:mm a z (2019-01-20 11:30 PM GMT) yyyy-MM-dd hh:mma z (2019-01-20 11:30pm GMT) HH = 24-hour format hh = 12-hour format a = am or pm (case insensitive) z = time zone of the departing flight.	This field is optional. See Using Decision Manager.	Date (c) DateTime (29)
device_fingerprint_id	Field that contains the session ID for the fingerprint. The string can contain uppercase and lowercase letters, digits, and these special characters: hyphen (-) and underscore (_) However, do not use the same uppercase and lowercase letters to indicate different session IDs. The session ID must be unique for each merchant ID. You can use any string that you are already generating, such as an order number or web session ID. Important The CyberSource generated device fingerprint ID overrides the merchant generated device fingerprint ID. See Using Decision Manager.	This field is optional. See Using Decision Manager.	AlphaNumericPunctuation String (88)
driver_license_number	Driver’s license number of the customer. Contact your TeleCheck representative to find out whether this field is required or optional. If you include this field in your request then you must also include the driver_license_state field.	■ sale (See description) ■ create_payment_token (See description) ■ sale,create_payment_token (See description) ■ update_payment_token (See description)	AlphaNumeric String (30)
driver_license_state	State or province from which the customer’s driver’s license was issued. Use the two-character State, Province, and Territory Codes for the United States and Canada. Contact your TeleCheck representative to find out whether this field is required or optional.	■ sale (See description) ■ create_payment_token (See description) ■ sale,create_payment_token (See description) ■ update_payment_token (See description)	Alpha String (2)
e_commerce_indicator	The commerce indicator for the transaction type. Value: install Note This field is required only for installment payments on CyberSource Latin American Processing.	■ authorization (See description)	String (20)
echeck_account_number	Account number.	■ sale (R) ■ create_payment_token (R) ■ sale,create_payment_token (R) ■ update_payment_token (O)	Numeric Non-negative integer (8 to 17)
echeck_account_type	Account type. Possible values: ■ C: Checking ■ S: Savings (USD only) ■ X: Corporate checking (USD only) ■ G: General Ledger	■ sale (R) ■ create_payment_token (R) ■ sale,create_payment_token (R) ■ update_payment_token (O)	Enumerated String String (1)
echeck_check_number	Check number. Note If your payment processor is TeleCheck we recommend that you include this field.	■ sale (See description) ■ create_payment_token (See description) ■ sale,create_payment_token (See description) ■ update_payment_token (See description)	Numeric Integer (8)
echeck_effective_date	The postdate for the transaction. This date must be within 45 days of the current date. Use the format: MMDDYYYY	■ sale (O) ■ sale,create_payment_token (O)	Date (b) String (8)
echeck_routing_number	Bank routing number. If the currency being used is CAD, the maximum length of the routing number is 8 digits. If the currency being used is USD, the maximum length of the routing number is 9 digits.	■ sale (R) ■ create_payment_token (R) ■ sale,create_payment_token (R) ■ update_payment_token (O)	Numeric Non-negative integer (See description)
echeck_sec_code	If your payment processor is TeleCheck then this field is required. Possible values: ■ CCD: Corporate cash disbursement—charge or credit against a business checking account. You can use one-time or recurring CCD transactions to transfer funds to or from a corporate entity. A standing authorization is required for recurring transactions. ■ PPD: Prearranged payment and deposit entry—charge or credit against a personal checking or savings account. You can originate a PPD entry only when the payment and deposit terms between you and the customer are prearranged. A written authorization from the customer is required for one-time transactions and a written standing authorization is required for recurring transactions. ■ TEL: Telephone-initiated entry—one-time charge against a personal checking or savings account. You can originate a TEL entry only when there is a business relationship between you and the customer or when the customer initiates a telephone call to you. For a TEL entry, you must obtain an authorization from the customer over the telephone. ■ WEB: Internet-initiated entry—charge against a personal checking or savings account. You can originate a one-time or recurring WEB entry when the customer initiates the transaction over the Internet. You must obtain an authorization from the customer over the Internet.	■ sale (See description) ■ create_payment_token (See description) ■ sale,create_payment_token (See description) ■ update_payment_token (See description)	Enumerated String String (3)
ignore_avs	Ignore the results of AVS verification. Possible values: ■ true ■ false Important To prevent data tampering CyberSource recommends that you include this field within the signed_field_names field when generating a signature.	This field is optional.	Enumerated String String (5)
ignore_cvn	Ignore the results of CVN verification. Possible values: ■ true ■ false Important To prevent data tampering CyberSource recommends that you include this field within the signed_field_names field when generating a signature.	This field is optional.	Enumerated String String (5)
installment_amount	Amount for the current installment payment. Note This field is required only for installment payments on CyberSource Latin American Processing or CyberSource through VisaNet.	authorization (See description)	Amount (12)
installment_frequency	Frequency of the installment payments. Possible values: ■ B: Biweekly ■ M: Monthly ■ W: Weekly Note This field is supported only on CyberSource through VisaNet.	authorization (See description)	AlphaNumeric (2)
installment_plan_type	Flag that indicates the type of funding for the installment plan associated with the payment. Possible values: ■ 1: Merchant-funded installment plan ■ 2: Issuer-funded installment plan If you do not include this field in the request, CyberSource uses the value in your CyberSource account. To change this value contact CyberSource Customer Service. CyberSource through VisaNet American Express-defined code that indicates the type of installment plan for this transaction. Contact American Express for: ■ Information about the types of installment plans that American Express provides ■ Values for this field	authorization (See description)	CyberSource Latin American Processing: String (1) CyberSource through VisaNet: String (2)
installment_sequence	Installment number when making payments in installments. Used along with installment_total_count to keep track of which payment is being processed. For example, the second of 5 payments would be passed to CyberSource as installment_sequence = 2 and installment_total_count = 5. Note This field is required only for installment payments CyberSource through VisaNet.	authorization (See description)	Integer (2)
installment_total_amount	Total amount of the loan that is being paid in installments. Note This field is required only for installment payments on CyberSource Latin American Processing or CyberSource through VisaNet.	authorization (see description)	Amount (12)
installment_total_count	Total number of installment payments as part of an authorization. Possible values: 1 to 99 Note This field is required only for installment payments on CyberSource Latin American Processing.	authorization (See description)	Numeric String (2)
issuer_additional_data	Data defined by the issuer. See the “Formats for Discretionary Data” section in Credit Card Services Using the SCMP API or Credit Card Services Using the Simple Order API.	authorization (O)	Alphanumeric String (256)
item_#_code	Type of product. # can range from 0 to 199.	This field is optional. If you include this field, you must also include the line_item_count field.	AlphaNumericPunctuation String (255)
item_#_name	Name of the item. # can range from 0 to 199. Note This field is required when the item_#_code value is not default or relating to shipping or handling.	See description. If you include this field, you must also include the line_item_count field.	AlphaNumericPunctuation String (255)
item_#_passenger_email	Passenger’s email address.	This field is optional. See Using Decision Manager.	String (255)
item_#_passenger_forename	Passenger’s first name.	This field is optional. See Using Decision Manager.	String (60)
item_#_passenger_id	ID of the passenger to whom the ticket was issued. For example, you can use this field for the frequent flyer number.	This field is optional. See Using Decision Manager.	String (32)
item_#_passenger_phone	Passenger’s phone number. If the order is from outside the U.S., CyberSource recommends that you include the country code.	This field is optional. See Using Decision Manager.	String (15)
item_#_passenger_status	Your company’s passenger classification, such as with a frequent flyer classification. In this case, you might use values such as standard, gold, or platinum.	This field is optional. See Using Decision Manager.	String (32)
item_#_passenger_surname	Passenger’s last name.	This field is optional. See Using Decision Manager.	String (60)
item_#_passenger_type	Passenger classification associated with the price of the ticket. You can use one of the following values: ■ ADT: Adult ■ CNN: Child ■ INF: Infant ■ YTH: Youth ■ STU: Student ■ SCR: Senior Citizen ■ MIL: Military	This field is optional. See Using Decision Manager.	String (32)
item_#_quantity	Quantity of line items. The default value is 1. Required field if one of the following product codes is used: ■ adult_content ■ coupon ■ electronic_good ■ electronic_software ■ gift_certificate ■ service ■ subscription # can range from 1 to 199. Note This field is required when the item_#_code value is not default or relating to shipping or handling.	See description. If you include this field, you must also include the line_item_count field.	Numeric String (10)
item_#_sku	Identification code for the product. Required field if one of the following product codes is used: ■ adult_content ■ coupon ■ electronic_good ■ electronic_software ■ gift_certificate ■ service ■ subscription # can range from 0 to 199.	See description. If you include this field, you must also include the line_item_count field.	AlphaNumericPunctuation String (255)
item_#_tax_amount	Tax amount to apply to the line item. # can range from 0 to 199. This value cannot be negative. The tax amount and the offer amount must be in the same currency.	This field is optional. If you include this field, you must also include the line_item_count field.	Amount String (15)
item_#_unit_price	Price of the line item. # can range from 0 to 199. This value cannot be negative. You must include either this field or the amount field in the request.	See description. If you include this field, you must also include the line_item_count field.	Amount String (15)
journey_leg#_dest	Airport code for the destination leg of the trip designated by the pound (#) symbol in the field name. A maximum of 30 legs can be included in the request. This code is usually three digits long, for example: SFO = San Francisco. Do not use the colon (:) or the hyphen (-). For a complete list of airport codes, see IATA’s City Code Directory. In your request, send either the complete_route field or the individual legs (journey_leg#_orig and journey_leg#_dest). If you send all the fields, the complete route takes precedence over the individual legs.	This field is optional. See Using Decision Manager.	Alpha String (3)
journey_leg#_orig	Airport code for the origin leg of the trip designated by the pound (#) symbol in the field name. A maximum of 30 legs can be included in the request. This code is usually three digits long, for example: SFO = San Francisco. Do not use the colon (:) or the hyphen (-). For a complete list of airport codes, see IATA’s City Code Directory. In your request, send either the complete_route field or the individual legs (journey_leg#_orig and journey_leg#_dest). If you send all the fields, the complete route takes precedence over the individual legs.	This field is optional. See Using Decision Manager.	Alpha String (3)
journey_type	Type of travel, such as one way or round trip.	This field is optional. See Using Decision Manager.	AlphaNumericPunctuation String (32)
jpo_installments	Total number of Japanese installment payments. Possible values: ■ 2 ■ 3 ■ 5 ■ 6 ■ 10 ■ 12 ■ 15 ■ 18 ■ 20 ■ 24	Required when the jpo_payment_method value is 4 and the currency type is JPY.	Numeric String (2)
jpo_payment_method	Japanese payment method. Possible values: ■ 1: Single payment ■ 2: Bonus payment ■ 4: Installment payment ■ 5: Revolving repayment	Required when the currency type is JPY.	Numeric String (1)
line_item_count	Total number of line items. Maximum number is 200.	This field is required when you include any item fields in the request.	Numeric String (2)
locale	Indicates the language to use for customer-facing content. Possible value: en-us. See Activating a Profile.	Required by the Secure Acceptance application.	Locale String (5)
merchant_defined_data#	Optional fields that you can use to store information (see Custom Email Receipt). # can range from 1 to 100. Merchant defined data fields 1 to 4 are stored against the payment token and are used for subsequent token based transactions. Merchant-defined data fields 5 to 100 are passed trough to Decision Manager as part of the initial payment request and are not stored against the payment token. Important Merchant-defined data fields are not intended to and MUST NOT be used to capture personally identifying information. Accordingly, merchants are prohibited from capturing, obtaining, and/or transmitting any personally identifying information in or via the merchant-defined data fields and any Secure Acceptance field that is not specifically designed to capture personally identifying information. Personally identifying information includes, but is not limited to, card number, bank account number, social security number, driver's license number, state-issued identification number, passport number, card verification numbers (CVV, CVC2, CVV2, CID, CVN). In the event CyberSource discovers  that a merchant is capturing and/or transmitting personally identifying information via the merchant-defined data fields, whether or not intentionally, CyberSource WILL immediately suspend the  merchant's account, which will result in a rejection of any and all transaction requests submitted by the merchant after the point of suspension.	This field is optional. See Using Decision Manager.	AlphaNumericPunctuation String (100)
merchant_descriptor merchant_descriptor_alternate merchant_descriptor_city merchant_descriptor_contact merchant_descriptor_country merchant_descriptor_state merchant_descriptor_postal_code merchant_descriptor_street	For the descriptions, used-by information, data types, and lengths for these fields, see the “Merchant Descriptors” section in either Credit Card Services Using the SCMP API or Credit Card Services Using the Simple Order API.	authorization (See description)
merchant_secure_data4	Optional field that you can use to store information. CyberSource encrypts the data before storing it in the database.	This field is optional.	AlphaNumericPunctuation String (2000)
merchant_secure_data1 merchant_secure_data2 merchant_secure_data3	Optional fields that you can use to store information. CyberSource encrypts the data before storing it in the database.	This field is optional.	AlphaNumericPunctuation String (100)
override_backoffice_post_url	Overrides the backoffice post URL profile setting with your own URL. URL needs to be HTTPS and support TLS1.2 (transport layer security) or later.	This field is optional.	URL String (255)
override_custom_cancel_page	Overrides the custom cancel page profile setting with your own URL.	This field is optional.	URL String (255)
override_custom_receipt_page	Overrides the custom receipt profile setting with your own URL. URL needs to be HTTPS and support TLS 1.2 or later. Important CyberSource recommends signing this field.	This field is optional.	URL String (255)
override_customer_utc_offset	Overrides the transaction date and time with the number of minutes the customer is ahead of or behind UTC. Use this field to override the local browser time detected by Secure Acceptance. This time determines the date on receipt pages and emails. For example, if the customer is 2 hours ahead, the value is 120; if 2 hours behind, then -120; if UTC, the value is 0.	This field is optional.	Integer (5)
override_paypal_order_setup	Overrides the PayPal order setup profile setting. Possible values: ■ include_authorization: The PayPal order is created and authorized. ■ exclude_authorization: The PayPal order is created but not authorized.	This field is optional. See Enabling PayPal Express Checkout.	String (21)
payer_authentication_challenge_code	Possible values: ■ 01: No preference ■ 02: No challenge request ■ 03: Challenge requested (3D Secure requestor preference) ■ 04: Challenge requested (mandate)	This field is optional.	Integer (2)
payer_authentication_customer_annual_transaction_count	Number of transactions (successful and abandoned) for this cardholder account within the past year. Recommended for Discover ProtectBuy.	This field is optional.	Integer (3)
payer_authentication_customer_daily_transaction_count	Number of transaction (successful or abandoned) for this cardholder account within the past 24 hours. Recommended for Discover ProtectBuy.	This field is optional.	Integer (3)
payer_authentication_marketing_source	Indicates origin of the marketing offer. Recommended for Discover ProtectBuy.	This field is optional.	String (40)
payer_authentication_mobile_phone	Cardholder’s mobile phone number. Important Required for Visa Secure transactions in Brazil. Do not use this request field for any other types of transactions.	This field is optional.	Integer (25)
payer_authentication_new_customer	Indicates whether the customer is a new or existing customer with the merchant. Possible values: ■ true ■ false	This field is optional.	String (5)/
payer_authentication_pre_order	Indicates whether cardholder is placing an order with a future availability or release date. Possible values: ■ 01: Merchandise available ■ 02: Future availability	This field is optional.	Integer (2)
payer_authentication_pre_order_date	Expected date that a pre-ordered purchase will be available. Format: YYYYMMDD	This field is optional.	Integer (8)
payer_authentication_recurring_end_date	The date after which no further recurring authorizations should be performed. Format: YYYYMMDD. Note This field is required for recurring transactions. If recurring_frequency and recurring_number_of_installments are included in the request, Secure Acceptance will automatically populate this field. Specify a value to override this logic.	This field is optional.	Integer (8)
payer_authentication_recurring_frequency	Integer value indicating the minimum number of days between recurring authorizations. A frequency of monthly is indicated by the value 28. Multiple of 28 days will be used to indicate months. Example: 6 months= 168 Note This field is required for recurring transactions. If recurring_frequency is included in the request, Secure Acceptance will automatically populate this field. Specify a value to override this logic.	This field is optional.	Integer (3)
payer_authentication_reorder	Indicates whether the cardholder is reordering previously purchased merchandise. Possible values: ■ 01: First time ordered ■ 02: Reordered	This field is optional.	Integer (2)
payer_authentication_ship_to_address_first_used	Date when the shipping address for this transaction was first used. Possible values: ■ -1: Guest account ■ 0: First used during this transaction If neither of these apply, enter the date in YYYYMMDD format. Recommended for Discover ProtectBuy.	This field is optional.	Integer (8)
payer_authentication_transaction_mode	Transaction mode identifier. Identifies the channel from which the transaction originates. Possible values: ■ M: MOTO (Mail Order Telephone Order) ■ R: Retail ■ S: E-commerce ■ P: Mobile Device ■ T: Tablet	Required by the Secure Acceptance application.	String (1)
payment_method	Method of payment. Possible values: ■ card ■ echeck ■ paypal	Required by the Secure Acceptance application.	Enumerated String String (30)
payment_token	Identifier for the payment details. The payment token retrieves the card data, billing information, and shipping information from the CyberSource database. When this field is included in the request, the card data, and billing and shipping information are optional. You must be currently using CyberSource Payment Tokenization services. Populate this field with the customer subscription ID. Note This field is required for token-based transactions.	■ authorization or sale (R) ■ authorization,update_payment_token (R) ■ sale,update_payment_token (R) ■ update_payment_token (R)	Numeric String (26)
payment_token_comments	Optional comments you have for the customer subscription.	This field is optional.	AlphaNumericPunctuation String (255)
payment_token_title	Name or title for the customer subscription.	This field is optional.	AlphaNumericPunctuation String (60)
profile_id	Identifies the profile to use with each transaction.	Assigned by the Secure Acceptance application.	ASCIIAlphaNumericPunctuation String (36)
recipient_account_id	Identifier for the recipient’s account. Use the first six digits and last four digits of the recipient’s account number.	authorization (R for recipient transactions, otherwise not used)	Numeric String (10)
recipient_date_of_birth	Recipient’s date of birth. Format: YYYYMMDD.	authorization (R for recipient transactions, otherwise not used)	Date (b) String (8)
recipient_postal_code	Partial postal code for the recipient’s address. For example, if the postal code is NN5 7SG, the value for this field should be the first part of the postal code: NN5.	authorization (R for recipient transactions, otherwise not used)	Alphanumeric String (6)
recipient_surname	Recipient’s last name.	authorization (R for recipient transactions, otherwise not used)	Alpha String (6)
recurring_amount	Payment amount for each installment or recurring subscription payment.	■ create_payment_token (R) ■ authorization,create_payment_token (R) ■ sale,create_payment_token (R) ■ update_payment_token (O)	Amount String (15)
recurring_automatic_renew	Indicates whether to automatically renew the payment schedule for an installment subscription. Possible values: ■ true (default): Automatically renew. ■ false: Do not automatically renew.	■ create_payment_token (O) ■ authorization,create_payment_token (O) ■ sale,create_payment_token (O) ■ update_payment_token (O)	Enumerated String String (5)
recurring_frequency	Frequency of payments for an installment or recurring subscription. Possible values: ■ weekly: Every 7 days. ■ bi-weekly: Every 2 weeks. ■ quad-weekly: Every 4 weeks. ■ monthly ■ semi-monthly: Twice every month (1st and 15th). ■ quarterly ■ semi-annually: Twice every year. ■ annually	■ create_payment_token (R) ■ authorization,create_payment_token (R) ■ sale,create_payment_token (R) ■ update_payment_token (O)	Enumerated String String (20)
recurring_number_of_installments	Total number of payments set up for an installment subscription. Maximum values: ■ 261: Weekly ■ 130: Bi-weekly ■ 65: Quad-weekly ■ 60: Monthly ■ 120: Semi-monthly ■ 20: Quarterly ■ 10: Semi-annually ■ 5: Annually	■ create_payment_token (R) ■ authorization,create_payment_token (R) ■ sale,create_payment_token (R) ■ update_payment_token (O)	Numeric String (3)
recurring_start_date	First payment date for an installment or recurring subscription payment. Date must use the format YYYYMMDD. If a date in the past is supplied, the start date defaults to the day after the date that was entered.	■ create_payment_token (O) ■ authorization,create_payment_token (O) ■ sale,create_payment_token (O) ■ update_payment_token (O)	Date (b) String (8)
reference_number	Unique merchant-generated order reference or tracking number for each transaction.	Required by the Secure Acceptance application.	AlphaNumericPunctuation Asia, Middle East, and Africa Gateway: String (40) Atos: String (32) All other processors: String (50)
returns_accepted	Indicates whether product returns are accepted. This field can contain one of the following values: ■ true ■ false	This field is optional. See Using Decision Manager.	Enumerated String String (5)
sales_organization_id	Company ID assigned to an independent sales organization. Obtain this value from Mastercard. CyberSource through VisaNet The value for this field corresponds to the following data in the TC 33 capture file1: ■ Record: CP01 TCR6 ■ Position: 106-116 ■ Field: Mastercard Independent Sales Organization ID	authorization (Required for Mastercard aggregator transactions on CyberSource through VisaNet.)	Nonnegative integer (11)
ship_to_address_city	City of shipping address.	This field is optional.	AlphaNumericPunctuation String (50)
ship_to_address_country	Country code for the shipping address. Use the two-character ISO country codes.	This field is optional.	Alpha String (2)
ship_to_address_line1	First line of shipping address.	This field is optional.	AlphaNumericPunctuation String (60)
ship_to_address_line2	Second line of shipping address.	This field is optional.	AlphaNumericPunctuation String (60)
ship_to_address_postal_code	Postal code for the shipping address. 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 For the rest of the world countries, the maximum length is 10.	This field is optional.	AlphaNumericPunctuation See description.
ship_to_address_state	State or province of shipping address. Use the two-character ISO state and province codes. Note This field is required if the shipping address value is U.S. and Canada.	This field is optional.	AlphaNumericPunctuation String (2)
ship_to_company_name	Name of the company receiving the product.	This field is optional.	AlphaNumericPunctuation String (40)
ship_to_forename	First name of the person receiving the product.	This field is optional.	AlphaNumericPunctuation String (60)
ship_to_phone	Phone number of the shipping address.	This field is optional.	Phone String (6 to 15)
ship_to_surname	Last name of the person receiving the product.	This field is optional.	AlphaNumericPunctuation String (60)
shipping_method	Shipping method for the product. Possible values: ■ sameday: Courier or same-day service ■ oneday: Next day or overnight service ■ twoday: Two-day service ■ threeday: Three-day service ■ lowcost: Lowest-cost service ■ pickup: Store pickup ■ other: Other shipping method ■ none: No shipping method	This field is optional.	Enumerated String String (10)
signature	Merchant-generated Base64 signature. This is generated using the signing method for the access_key field supplied.	Required by the Secure Acceptance application.	AlphaNumericPunctuation
signed_date_time	The date and time that the signature was generated. Must be in UTC Date & Time format. This field is used to check for duplicate transaction attempts. Format: YYYY-MM-DDThh:mm:ssZ Example 2019-08-11T22:47:57Z equals August 11, 2019, at 22:47:57 (10:47:57 p.m.). The T separates the date and the time. The Z indicates UTC. Your system time must be accurate to avoid payment processing errors related to the signed_date_time field.	Required by the Secure Acceptance application.	ISO 8601 Date String (20)
signed_field_names	A comma-separated list of request fields that are signed. This field is used to generate a signature that is used to verify the content of the transaction to protect it from tampering. All request fields should be signed to prevent data tampering, with the exception of the card_number field and the signature field.	Required by the Secure Acceptance application.	AlphaNumericPunctuation Variable
skip_auto_auth	Indicates whether to skip or perform the preauthorization check when creating this token. Possible values: ■ true: Skip the preauthorization check. ■ false: Perform the preauthorization check.	This field is optional.	Enumerated String String (5)
skip_bin_lookup	Indicates whether to skip the BIN lookup service. See BIN Lookup. This field can contain one of the following values: ■ true ■ false	This field is optional.	Enumerated String String (5)
skip_decision_manager	Indicates whether to skip Decision Manager. See Using Decision Manager. This field can contain one of the following values: ■ true: Decision Manager is not enabled for this transaction and the device fingerprint ID will not be displayed. ■ false	This field is optional.	Enumerated String String (5)
submerchant_city	Sub-merchant’s city. FDC Compass This value must consist of uppercase characters.	authorization   American Express Direct: R for all aggregator transactions. CyberSource through VisaNet: not used. FDC Compass: R for all aggregator transactions. FDC Nashville Global: R for all aggregator transactions.	American Express Direct: String (15) FDC Compass: String (21) FDC Nashville Global: String (11)
submerchant_country	Sub-merchant’s country. Use the two-character ISO Standard Country Codes. FDC Compass This value must consist of uppercase characters.	authorization   American Express Direct: R for all aggregator transactions. CyberSource through VisaNet: not used. FDC Compass: O for all aggregator transactions. FDC Nashville Global: R for all aggregator transactions.	String (3)
submerchant_email	Sub-merchant’s email address. CyberSource through VisaNet With American Express, the value for this field corresponds to the following data in the TC 33 capture file1: ■ Record: CP01 TCRB ■ Position: 25-64 ■ Field: American Express Seller E-mail Address	authorization   American Express Direct: R for all aggregator transactions. CyberSource through VisaNet: O for all aggregator transactions with American Express; otherwise, not used. FDC Compass: O for all aggregator transactions. FDC Nashville Global: R for all aggregator transactions.	American Express Direct: String (40) CyberSource through VisaNet: String (40) FDC Compass: String (40) FDC Nashville Global: String (19)
submerchant_id	The ID you assigned to your sub-merchant. FDC Compass This value must consist of uppercase characters. CyberSource through VisaNet With American Express, the value for this field corresponds to the following data in the TC 33 capture file1: ■ Record: CP01 TCRB ■ Position: 65-84 ■ Field: American Express Seller ID With Mastercard, the value for this field corresponds to the following data in the TC 33 capture file1: ■ Record: CP01 TCR6 ■ Position: 117-131 ■ Field: Mastercard Sub-Merchant ID	authorization   American Express Direct: R for all aggregator transactions. CyberSource through VisaNet: ■ O for all American Express aggregator transactions; ■ R for all Mastercard aggregator authorizations; ■ otherwise, not used. FDC Compass: R for all aggregator transactions. FDC Nashville Global: R for all aggregator transactions.	American Express Direct: String (20) CyberSource through VisaNet with American Express: String (20) CyberSource through VisaNet with Mastercard: String (15) FDC Compass: String (20) FDC Nashville Global: String (14)
submerchant_name	Sub-merchant’s business name. FDC Compass This value must consist of uppercase characters.	authorization   American Express Direct: R for all aggregator transactions. CyberSource through VisaNet: not used. FDC Compass: R for all aggregator transactions. FDC Nashville Global: R for all aggregator transactions.	American Express Direct: String (37) FDC Compass with American Express: String (19) FDC Compass with Mastercard: String (37) FDC Nashville Global: String (12)
submerchant_phone	Sub-merchant’s telephone number. CyberSource through VisaNet With American Express, the value for this field corresponds to the following data in the TC 33 capture file1: ■ Record: CP01 TCRB ■ Position: 5-24 ■ Field: American Express Seller Telephone Number FDC Compass This value must consist of uppercase characters. Use one of these recommended formats: NNN-NNN-NNNN NNN-AAAAAAA	authorization   American Express Direct: R for all aggregator transactions. CyberSource through VisaNet: O for all aggregator transactions with American Express; otherwise, not used. FDC Compass: R for all aggregator transactions. FDC Nashville Global: R for all aggregator transactions.	American Express Direct: String (20) CyberSource through VisaNet: String (20) FDC Compass: String (13) FDC Nashville Global: String (10)
submerchant_postal_code	Partial postal code for the sub-merchant’s address. FDC Compass This value must consist of uppercase characters.	authorization   American Express Direct: R for all aggregator transactions. CyberSource through VisaNet: not used. FDC Compass: O for all aggregator transactions. FDC Nashville Global: R for all aggregator transactions.	American Express Direct: String (9) FDC Compass: String (15) FDC Nashville Global: String (9)
submerchant_state	Sub-merchant’s state or province. Use the State, Province, and Territory Codes for the United States and Canada. FDC Compass This value must consist of uppercase characters.	authorization   American Express Direct: R for all aggregator transactions. CyberSource through VisaNet: not used. FDC Compass: O for all aggregator transactions. FDC Nashville Global: R for all aggregator transactions.	String (2)
submerchant_street	First line of the sub-merchant’s street address. FDC Compass This value must consist of uppercase characters.	authorization American Express Direct: R for all aggregator transactions. CyberSource through VisaNet: not used. FDC Compass: O for all aggregator transactions. FDC Nashville Global: R for all aggregator transactions.	American Express Direct: String (30) FDC Compass: String (38) FDC Nashville Global: String (25)
tax_amount	Total tax amount to apply to the order. This value cannot be negative. Important To prevent data tampering CyberSource recommends that you include this field within the signed_field_names field for generating a signature.	This field is optional.	Amount String (15)
transaction_type	The type of transaction: ■ authorization ■ authorization,create_payment_token ■ authorization,update_payment_token ■ sale ■ sale,create_payment_token ■ sale,update_payment_token ■ create_payment_token ■ update_payment_token	Required by the Secure Acceptance application.	Enumerated String String (60)
transaction_uuid	Unique merchant-generated identifier. Include with the access_key field for each transaction. This identifier must be unique for each transaction. This field is used to check for duplicate transaction attempts.	Required by the Secure Acceptance application.	ASCIIAlphaNumericPunctuation String (50)
unsigned_field_names	A comma-separated list of request fields that are not signed.	Required by the Secure Acceptance application.	AlphaNumericPunctuation Variable
1 The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies.