Fields for a Sale Request

A

merchantReferenceCode

*

Merchant-generated order reference or tracking number.

Required

String

B

purchaseTotals_currency*

Currency used for the order.

Required

String

C

purchaseTotals_grandTotalAmount*

Grand total for the order. You must include either this field or

item_#_unitPrice

in your request. If you use

TSYS Acquiring Solutions

as your payment processor, you can set this field to 0 to check whether the card is lost or stolen.

Required

String

D

billTo_firstName*

Customer’s first name. The value should be the same as the one that appears on the card.

Required

String

E

billTo_lastName*

Customer’s last name. The value should be the same as the one that appears on the card.

Required

String

F

billTo_customerID

Your identifier for the customer.

Optional

String

G

billTo_email*

Customer’s email address, including the full domain name. For example: jdoe@example.com

Required

String

H

billTo_street1*

First line of the billing street address.

Required

String

I

billTo_street2

Second line of the billing street address. Used for additional address information. For example: Attention: Accounts Payable

Required

String

J

billTo_city*

City of the billing address.

Required

String

K

billTo_state*

State or province of the billing address. Use the two-character codes.

Required

String

L

billTo_country*

Country of the billing address. Use the two-character ISO codes.

Required

String

M

billTo_postalCode*

Postal code for the billing address. The postal code must consist of 5 to 9 digits. For a 9-digit postal code, use this format:

[5 digits][dash][4 digits]

If the value of billTo_country is CA, the postal code must follow these rules:

If the number of characters is greater than 3, the first 3 characters must be in this format: [alpha][numeric][alpha].
If the number of characters is 7, the last 3 characters must be in this format: [numeric][alpha][numeric].

Required

String

N

card_accountNumber*

Customer’s credit card number.

Required

String (Numbers Only)

O

billTo_phoneNumber

Customer’s phone number.

Required

String

P

card_expirationMonth*

Two-digit month in which the credit card expires. Format: MM. Possible values: 01 through 12. The leading 0 is required.

Required

String

Q

card_expirationYear*

Four-digit year in which the credit card expires. Format: YYYY.

Required

String

R

card_cardType*

Type of card to authorize. This field is required if the card type is JCB (007), and optional for all other card types.

001: Visa
002: MasterCard
003: American Express
004: Discover
005: Diners Club
007: JCB (required)

Required

String

S

card_cvIndicator

Card verification indicator used to indicate if a card verification value was sent. Accepted by

FDMS Nashville

. Possible values:

0: CV number service not requested.
1: CV number service requested and supported.
2: CV number on credit card is illegible.
9: CV number was not imprinted on credit card.

The default value is 1 if you send the card_cvNumber field in the request, and 0 if you do not send the card_cvNumber field.

Optional

String (Numbers Only)

T

card_cvNumber

Card verification number.

Optional

String (Numbers Only)

U

ccAuthService_commerceIndicator

Transaction channel type. Possible values:

internet (default): eCommerce transaction.
install: Installment profile. Payments will be made in installments. If selected, then installment_sequence and installment_totalCount are required. This value is valid only for Visa.
moto: Mail order or telephone order.

See Indicating a Recurring Payment for information about recurring payments.

Optional

String

V

comments

Optional comments you have about the authorization. These comments will not be shown to the customer.

Optional

String

W

merchantDefinedData_field1

Four fields that you can use to store information. NOTE: If you are creating a profile based on an authorization, the merchant-defined data fields do not get transferred to the new profile.

Optional

String

X

merchantDefinedData_field2

Four fields that you can use to store information. NOTE: If you are creating a profile based on an authorization, the merchant-defined data fields do not get transferred to the new profile.

Optional

String

Y

merchantDefinedData_field3

Four fields that you can use to store information. NOTE: If you are creating a profile based on an authorization, the merchant-defined data fields do not get transferred to the new profile.

Optional

String

Z

merchantDefinedData_field4

Four fields that you can use to store information. NOTE: If you are creating a profile based on an authorization, the merchant-defined data fields do not get transferred to the new profile.

Optional

String

AA

shipTo_firstName

First name of the person receiving the shipment.

Optional

String

AB

shipTo_lastName

Last name of the person receiving the shipment.

Optional

String

AC

shipTo_street1

First line of the address to which to ship the product.

Optional

String

AD

shipTo_street2

Second line of the address to which to ship the product.

Optional

String

AE

shipTo_city

City to which to ship the product.

Optional

String

AF

shipTo_state

State or province to which to ship the product. Use the two-character codes.

Optional

String

AG

shipTo_country

Country to which to ship the product. Use the two-character ISO codes.

Optional

String

AH

shipTo_postalCode

Postal code for the shipping address. The postal code must consist of 5 to 9 digits. For a 9-digit postal code, use this format:

[5 digits][dash][4 digits]

If the value of shipTo_country is CA, the postal code must follow these rules:

If the number of characters is greater than 3, the first 3 characters must be in this format: [alpha][numeric][alpha].
If the number of characters is 7, the last 3 characters must be in this format: [numeric][alpha][numeric].

Optional

String