Field Name

Description

Used By & Required (R)/Optional (O)

Data Type & Length

bill_address1

First line of the billing address.

Create (R)¹

Update (O)

Moneris: String (50)

Visa Platform Connect: String (40)

Worldpay VAP: String (35)

All other processors: String (60)

bill_address2

Second line of the billing address.

Create (O)

Update (O)

Moneris: String (50)

Visa Platform Connect: String (40)

Worldpay VAP: String (35)

All other processors: String (60)

bill_city

City of the billing address.

Create (R)¹

Update (O)

String (50)

bill_company_tax_id

Tax identifier for the customer’s company.

Important  Contact your TeleCheck representative to find out whether this field is required or optional.

Create (See description)

Update (See description)

String (9)

bill_country

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

Create (R)¹

Update (O)

String (2)

bill_payment

Flag that indicates that this is a payment for a bill or for an existing contractual loan. This value is case sensitive. Possible values:

nfalse (default): Not a bill payment or loan payment.

ntrue: Bill payment or loan payment.

Create (O)

String (1)

bill_state

State or province in the billing address. Use the two-character State, Province, and Territory Codes for the United States and Canada.

Create (R)¹

Update (O)

String (2)

bill_zip

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

Create (R)¹

Update (O)

Visa Platform Connect: String (9)

All other processors: String (10)

card_type

Type of card.

See Card Types for a list of valid values. To see which cards are supported for each processor, see Supported Processors and Payment Methods.

Create (R)

Update (O)

String (3)

currency

Currency used by the customer.

Create (R)

Update (O)

String (5)

customer_cc_cv_number

Card verification number.

Create (O)

Update (O)

String with numbers only (4)

customer_cc_expmo

Expiration month.

Format: MM

Create (R)¹

Update (O)

String (2)

customer_cc_expyr

Expiration year.

Format: YYYY

FDC Nashville Global and FDMS South

You can send 2 digits or 4 digits. When you send 2 digits, they must be the last 2 digits of the year.

Create (R)¹

Update (O)

FDC Nashville Global and FDMS South: String (See description)

All other processors: String (4)

customer_cc_issue_number

Number of times a Maestro (UK Domestic) card has been issued to the account holder.

When you include this value in your request, include exactly what is printed on the card. A value of 2 is different than a value of 02. Do not include the field if the card is not a Maestro (UK Domestic) card.

Create (O)

Update (O)

String (5)

customer_cc_number

Card account number.

Create (R)

Update (O)

String (20)

customer_cc_startmo

Month of the start of the Maestro (UK Domestic) card validity period.

Format: MM.

Possible values: 01 to 12.

Create (O)

Update (O)

String (2)

customer_cc_startyr

Year of the start of the Maestro (UK Domestic) card validity period.

Format: YYYY.

Possible values: 01 to 12.

Create (O)

Update (O)

Nonnegative integer (4)

customer_email

Customer email address.

Create (R)¹

Update (O)

String (255)

customer_firstname

Customer first name.

Create (R)¹

Update (O)

String (60)

customer_lastname

Customer last name.

Create (R)¹

Update (O)

String (60)

customer_phone

Customer phone number.

Create (O)

Update (O)

String (15)

driver_license_no

Customer driver’s license number.

Important  Contact your TeleCheck representative to learn whether this field is required or optional.

Create (see description)

Update (see description)

String (30)

driver_license_state

State or province in which the customer’s driver’s license was issued. Use the two-character State, Province, and Territory Codes for the United States and Canada.

Important  Contact your TeleCheck representative to learn whether this field is required or optional.

Create (see description)

Update (see description)

String (2)

ecp_account_no

Checking account number.

Create (R for eCheck payments)

Update (O)

Integer (17)

ecp_account_type

Checking account type. Possible values:

nC: checking

nS: savings (USD only)

nX: corporate checking (USD only)

nG: general ledger

Create (R for eCheck payments)

Update (O)

String (1)

ecp_check_no

Check number.

Chase Paymentech Solutions

Optional.

Cybersource ACH Service

Not used.

RBS WorldPay Atlanta

Optional on debits. Required on credits.

TeleCheck

Strongly recommended on debit requests. Optional on credits.

Create (R for eCheck payments)

Update (O)

String with numbers only (8)

ecp_rdfi

Bank routing number. This value is also known as the transit number.

Create (R for eCheck payments)

Update (O)

Integer (9)

ecp_sec_code

Important  This field is required if your processor is TeleCheck.

Code that specifies the authorization method for the transaction. Possible values:

nCCD: 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.

nPPD: 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.

nTEL: 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 a payment authorization from the customer over the telephone. There is no recurring billing option for TEL.

nWEB: 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. For a WEB entry, you must obtain payment authorization from the customer over the Internet.

Create (R for eCheck payments)

Update (O)

String (3)

grand_total_amount

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.

Authorization (R)

Create (R)

Decimal (60)

ics_applications

Comma-separated list of Cybersource services to process. Possible values:

nics_auth

nics_pay_subscription_create

nics_pay_subscription_retrieve

nics_pay_subscription_update

nics_pay_subscription_delete

Required for each service.

String (255)

merchant_defined_data1

merchant_defined_data2

merchant_defined_data3

merchant_defined_data4

Four fields that you can use to store information in the customer token.

Warning  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. 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, and 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.

Create (O)

Update (O)

String (255)

merchant_descriptor_alternate

For the description, used-by information, data type, and length, see Merchant Descriptors in Credit Card Services Using the SCMP API (PDF | HTML).

Optional for all services.

String (13)

merchant_id

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

Required for all services.

String (30)

merchant_ref_number

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 SCMP API.

Required for all services.

Asia, Middle East, and Africa Gateway: String (40)

Atos: String (32)

All other processors: String (50)

merchant_secure_data1

merchant_secure_data2

merchant_secure_data3

merchant_secure_data4

Storage field for any data type in the customer token. The only validation performed on this field is a size check. The data is encrypted before it is stored in the database.

Create (O)

Update (O)

String (2071)

override_payment_method

Type of account associated with the card. This field is supported only for transactions with Brazilian-issued combo cards on Cielo 3.0. The customer provides this information during the payment process. Combo cards in Brazil contain credit and debit functionality in a single card. The Visa network uses 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. This field enables the customer to specify whether the card should be used as a credit card or a debit card for the transaction.

Possible value: DB: Debit card.

Authorization (Required for debit cards on Cielo 3.0)

String (2)

recurring_disable_auto_auth

Indicates whether to turn off the preauthorization check when creating this token. Use this field if your Cybersource account is configured for automatic preauthorizations but for this specific token you want to override that setting.

Possible values:

nN: No, go ahead and perform the preauthorization.

nY: Yes, turn off the preauthorization check.

Create (O)

Update (O)

String (5)

recurring_frequency

Frequency of payments for the customer profile.

Value: on-demand

Create (R)

String (20)

ship_to_address1

First line of the shipping address.

Create (O)

Update (O)

String (60)

ship_to_address2

Second line of the shipping address.

Create (O)

Update (O)

String (60)

ship_to_city

City of the shipping address.

Create (O)

Update (O)

String (50)

ship_to_company

Name of the company name receiving the product.

Create (O)

Update (O)

String (60)

ship_to_country

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

Create (O)

Update (O)

String (2)

ship_to_firstname

First name of the recipient.

Create (O)

Update (O)

String (60)

ship_to_lastname

First name of the recipient.

Create (O)

Update (O)

String (60)

ship_to_state

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

Create (O)

Update (O)

String (2)

ship_to_zip

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

Create (O)

Update (O)

String (10)

subscription_id

Identifier for the token.

Delete (R)

Retrieve (R)

Update (R)

String (32)

subscription_payment_method

Method of payment.

Possible values:

ncredit card

ncheck 

Create (O)

String (20)

1   This field is optional if your Cybersource account is configured for relaxed requirements for address data and expiration date. See Relaxed Requirements for Address Data and Expiration Date. Important It is your responsibility to determine whether a field is required for the transaction that you are requesting.