On This Page {#jumplink-list} [Markdown](/docs/cybs/en-us/batch/user/all/so/batch-upload/batch-ref-fields/batch-ref-fields-credits.md) Filter FILTER BY TAG Fields for a Credit Request {#batch-ref-fields-credits} ======================================================= This table describes the required and optional fields for specifying a credit request. Field names are listed in the table as they appear in batch file templates. An asterisk after a field name indicates that the field is required for an authorization request. When you create a batch file based on a template, remove any asterisks from field names. | Column | Field Name | Description | Required? | Data Type | Length | |--------|-------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------|-----------------------|--------| | A | merchantReferenceCode\* | Merchant-generated order reference or tracking number. | Required | String | 50 | | B | purchaseTotals_currency\* | Currency used for the order. | Required | String | 5 | | 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 whehter the card is lost or stolen. | Required | String | 15 | | D | ccCaptureService_authRequestID\* | The requestID returned from a previous request for ccAuthService. | Required | NA | NA | | E | ccCaptureService_authRequestToken | The requestToken returned from a previous request for ccAuthService. | Optional | NA | NA | | F | ccCaptureService_authType | If the request contains a verbally authorized transaction, this field must contain the value verbal. | Optional | NA | NA | | G | ccCaptureService_verbalAuthCode | Verbally received authorization code. | Optional | NA | NA | | H | billTo_customerID | Your identifier for the customer. | Optional | NA | NA | | I | 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 | 64 | | J | 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 | 64 | | K | 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 | 64 | | L | 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 | 64 | | 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 | 10 | | N | card_accountNumber\* | Customer's credit card number. | Required | String (Numbers Only) | 20 | | O | 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 | 3 | | P | billTo_phoneNumber | Customer's phone number. | Required | String | 15 | | Q | 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 | 2 | | R | card_expirationYear\* | Four-digit year in which the credit card expires. Format: YYYY. | Required | String | 4 | | 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) | 4 | | T | card_cvNumber | Card verification number. | Optional | String (Numbers Only) | 2 | | U | ccCreditService_captureRequestID | The requestID returned from a previous request for ccCaptureService. Creates a follow-on credit by linking the credit to the previous capture. If you send this field, you do not need to send several other Credit request fields. See Crediting a Payment for more information about follow-on credits. | Optional | NA | NA | | V | ccCreditService_captureRequestToken | The requestToken returned from a previous request for ccCaptureService. | Optional | NA | NA | | W | ccCreditService_commerceIndicator | Transaction type. Use with stand-alone credits. See Request Fields for possible values. | Optional | NA | NA | | X | 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 | 64 | | Y | 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 | 64 | | Z | 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 | 64 | | AA | 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 | 64 | | AB | shipTo_firstName | First name of the person receiving the shipment. | Optional | String | 60 | | AC | shipTo_lastName | Last name of the person receiving the shipment. | Optional | String | 60 | | AD | shipTo_street1 | First line of the address to which to ship the product. | Optional | String | 60 | | AE | shipTo_street2 | Second line of the address to which to ship the product. | Optional | String | 60 | | AF | shipTo_city | City to which to ship the product. | Optional | String | 50 | | AG | shipTo_state | State or province to which to ship the product. Use the two-character codes. | Optional | String | 2 | | AH | shipTo_country | Country to which to ship the product. Use the two-character ISO codes. | Optional | String | 2 | | AI | 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 | 10 | [Fields in a Data Record for a Credit Request] RELATED TO THIS PAGE