Fields for a Subscription Creation Request

A

merchantReferenceCode*

Merchant-generated order reference or tracking number.

Required

String

B

purchaseTotals_currency*

Currency used for the order.

Required

String

C

recurringSubscriptionInfo_amount*

Amount of the subscription payments, for example, 19.95. For on-demand subscriptions, this value can be 0. Create: Required for installment and recurring subscription; optional for on-demand subscriptions.

Required

String

D

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.

Optional

String

E

billTo_firstName*

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

Required

String

F

billTo_lastName*

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

Required

String

G

billTo_customerID

Your identifier for the customer.

Optional

String

H

billTo_email*

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

Required

String

I

billTo_street1*

First line of the billing street address.

Required

String

J

billTo_street2

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

Optional

String

K

billTo_city*

City of the billing address.

Required

String

L

billTo_state*

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

Required

String

M

billTo_country*

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

Required

String

N

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

O

card_accountNumber*

Customer’s credit card number.

Required

String (Numbers Only)

P

billTo_phoneNumber

Customer’s phone number.

Optional

String

Q

billTo_company

Customer's Company Name

Optional

String

R

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

S

card_expirationYear*

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

Required

String

T

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

U

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)

V

card_cvNumber

Card verification number.

Optional

String (Numbers Only)

W

subscription_title

Name or title of the subscription.

Optional

String

X

recurringSubscriptionInfo_frequency*

Frequency of payments. Possible values:

on-demand: For an on-demand subscription (which has no payment schedule)
weekly: 7 days
bi-weekly: 14 days
semi-monthly: 15 days
monthly: 1 month
quarterly: 3 months
quad-weekly: 4 weeks
semi-annually: 26 weeks
annually: 1 year

Required

String

Y

recurringSubscriptionInfo_numberOfPayments

Number of payments for an installment subscription. The maximum allowed value is 156, which corresponds to 3 years of weekly payments.

Optional (Required for "installment" subscriptions)

Integer

Z

recurringSubscriptionInfo_startDate

Date when your customer is billed for the first time for installment and recurring subscriptions. Use format YYYYMMDD. See Setting the Start Date for the Subscription for information about how to determine the start date.

Optional

Integer

AA

recurringSubscriptionInfo_approvalRequired

Whether the subscription uses approval-required payments. For more information, see Automatic or Approval-Required Payments. Possible values:

true: Payments must be approved before processing
false (default): Payments do not need to be approved before processing

Optional

String

AB

recurringSubscriptionInfo_automaticRenew

Whether to automatically renew the payment schedule for the subscription. Possible values:

true: (default) Subscription schedule renewed automatically
false: Subscription schedule not renewed automatically

Optional

String

AC

comments

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

Optional

String

AD

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

AE

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

AF

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

AG

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

AH

merchantSecureData_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

AI

merchantSecureData_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

AJ

merchantSecureData_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

AK

merchantSecureData_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

AL

paySubscriptionCreateService_disableAutoAuth

Whether to turn off the $1.00 pre-authorization check when creating this particular subscription. You use this if you are configured to use the $1.00 pre-authorization, but for the specific subscription you are creating, you want to override that setting. Possible values:

N: No, go ahead and perform the $1.00 pre-authorization for this subscription
Y: Yes, do NOT perform the $1.00 pre-authorization for this subscription

Optional

String

AM

paySubscriptionCreateService_paymentRequestID

Required when converting an existing authorization to a subscription. The value is that of the requestID reply field from the authorization.

Optional

String

AN

paySubscriptionCreateService_paymentRequestToken

The requestToken value returned from a previous request for ccAuthService. This field is required when you are creating a subscription based on information from a credit card authorization. Otherwise, it is not used. The field is an encoded string that contains no confidential information, such as an account or card verification number. The string may contain up to 256 characters.

You can start using the request token immediately, or you can do so at any time during the transition period:
After you start using the request token, you must do so for all future follow-on requests.
If you cannot use the request token immediately,
Cybersource
will store the request token data for you and retrieve it as necessary when you send follow-on requests. However, you will need to start using the request token before the end of the transition period.
You can read the migration guide that describes the request token.

Optional

String

AO

shipTo_firstName

First name of the person receiving the shipment.

Optional

String

AP

shipTo_lastName

Last name of the person receiving the shipment.

Optional

String

AQ

shipTo_company

Name of Company receiving the shipment.

Optional

String

AR

shipTo_street1

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

Optional

String

AS

shipTo_street2

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

Optional

String

AT

shipTo_city

City to which to ship the product.

Optional

String

AU

shipTo_state

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

Optional

String

AW

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

AX

businessRules_ignoreAVSResult

Use only if you are using automatic pre-authorization. This field overrides that configuration setting and enables you to create the subscription even if the credit card does not pass the AVS check. NOTE: Do not use this field if you are using Smart Authorization for AVS results. Possible values:

true: Ignore the results of the AVS check and create the subscription
false (default): If the pre-authorization receives an AVS decline, do not create the subscription

If the value of this field is true, the list in the businessRules_declineAVSFlags field is ignored.

Optional

String