Unified Template

Batch specs

Dash batch processing is built on a “unified template” that comprises all of the actions available from the batch system. While the structure remains consistent, each action has its own spec with a specific set of fields that are required.

DashFTPTemplate_v3.3: Download

The key specs are included below:

  1. Order Cards
    1. Instant Issue Order
    2. Personalized Order
  2. Register Cards
  3. Load Cards

To proceed smoothly, kindly follow these important guidelines:

  1. Please ensure you’re using the latest Unified Template (DashFTPTemplate_v3.3)
  2. Do not alter the column order—it must exactly match the structure in the template CSV file.
  3. Refer to the specifications below for detailed instructions on how to fill in the required fields for each action type:
    • Instant Issue Order
    • Personalized Order
    • Register Cards
    • Load Cards
  4. Below also includes return file specs.

 

Batch Specs

Instant | Personalized

Order Instant Issue Cards

Field Name Required Type Size (Max Characters) Description
CPID Yes Numeric 9 Customer Program ID
This unique ID is provided by Dash upon registration. CPID is used to determine the program for a customer.
phone Yes Numeric 23 phone number of the receiving person
Accepts international phone numbers in the format +<CountryCode>(<AreaCode>)-(<Prefix>)-(<LineNumber>), such as +1(555)-(555)-(5555), in a continour numberic format without any symbols, e.g., 15555555555.
name_on_card Optional String 26 Name on Card
The specified name will be embossed on the card if provided.
Default Value: My Payment Card.
fourth_line Optional String 26 Fourth Line of Embossing
The specified line will be printed under the name if provided.
qty Yes Numeric 10 Quantity
Ships the specified quantity to the mentioned address.
order_type Yes String 25 Order Type
Order type should be InstantIssue.
shipping_type Yes String 25 Shipping Type
Shipping type should be BulkShip.
BulkShip – Cards will be shipped in bulk to a single (i.e. company) address.
shipping_method Yes String 50 Shipping Method
Shipping method value can be anything from UPS Ground, FedEx Ground, FedEx 2nd Day, FedEx Next Day.
shipping_addressee Yes String 26 Shipping Addressee
Shipping address of the receiver.
shipping_attention Yes String 18 Shipping Attention
Shipment receiver’s name to be displayed.
shipping_address1 Yes A/N 50 Shipping Address Line 1
Residential address/street of the receiver.
shipping_address2 Optional String 50 Shipping Address Line 2
Additional information about the residential address.
shipping_city Yes String 18 Shipping City
City name of the receiver.
shipping_state Yes String 2 Shipping State
State name of the receiver.
shipping_zip Yes Numeric 5 Shipping Zipcode
Zipcode of the receiver.
order_custom_data_field1 Optional String 255 Custom data field associated with the Order Flow.
Note: Custom defined fields cannot have special characters such as : (colon) and | (vertical bar)
order_custom_data_field2 Optional String 255 Custom data field associated with the Order Flow.
Note: Custom defined fields cannot have special characters such as : (colon) and | (vertical bar)
order_custom_data_field3 Optional String 255 Custom data field associated with the Order Flow.
Note: Custom defined fields cannot have special characters such as : (colon) and | (vertical bar)
order_custom_data_field4 Optional String 255 Custom data field associated with the Order Flow.
Note: Custom defined fields cannot have special characters such as : (colon) and | (vertical bar)
order_custom_data_field5 Optional String 255 Custom data field associated with the Order Flow.
Note: Custom defined fields cannot have special characters such as : (colon) and | (vertical bar)
discretionary_data_1 Optional String 50 Discretionary data fields used to dynamically pass data to Arrow eye
discretionary_data_2 Optional String 50 Discretionary data fields used to dynamically pass data to Arrow eye
discretionary_data_3 Optional String 50 Discretionary data fields used to dynamically pass data to Arrow eye

 

Instant | Personalized

Order Personalized Cards

Field name Required Type Size (Max Characters) Description
CPID Yes Numeric 9 Customer Program ID
This unique ID is provided by Dash upon registration. CPID is used to determine the program for a customer.
name_first Yes Numeric 50 First Name
First name of the cardholder.
name_last Yes String 50 Last Name
Last Name of the cardholder.
cardholder_external_identifier Optional String 60 Cardholder External Identifier
This unique ID maps every card to an external identifier. It is used to store identifiers like employeeID to place card orders.
ssn_number Yes String 9 Social Security Number
SSN of the cardholder, if required for a a specific customer program. Or, nine digit identifier.
Note: The last four digits would be Access Code.
dob Yes Date 10 Date of Birth
Date of birth in mm/dd/yyyy format
email Conditional String 50 Email id of the person. REQUIRED if using DIGITAL product. Allowed characters: letters (A–Z, a–z), numbers (0–9), and symbols: ! # $ % & ‘ * + – / = ? _ \ { } ~
Restrictions:
. (dot) and other special characters (^ and |) are not allowed at the start, end, or consecutively.
Allowed special characters must be followed by a letter or number.
phone Yes String 23 phone number of the receiving person
Accepts international phone numbers in the format +<CountryCode>(<AreaCode>)-(<Prefix>)-(<LineNumber>), such as +1(555)-(555)-(5555), in a continour numberic format without any symbols, e.g., 15555555555.
name_on_card Optional String 26 will be embossed on the card if passed and the first name and last name will be bypassed
fourth_line Optional String 26 Fourth Line of Embossing
The specified line will be printed under the name if provided.
card_holder_home_address1 Yes A/N 50 Cardholder address Line 1
Residential address/street of the receiver.
card_holder_home_address2 Optional A/N 50 Cardholder address Line 2
Additional information about the residential address.
card_holder_home_city Yes String 18 Cardholder City
Cardholder city name.
card_holder_home_state Yes String 2 Cardholder State
Cardholder state code abbreviation.
e.g. AL for Alabama, CA for California.
card_holder_home_zip Yes Numeric 5 Cardholder zip code
Cardholder receiving address zip code.
load_value Optional Decimal 10 Load Value
Up to 2 positive decimal places to load the card, e.g., 1.20.
We allow load with:
Personalized order
Card registration
Load card.
card_type Yes String 10 Card Type
Specifies if the card is Physical or Digital
Value should be –
Physical – physical cards
Digital – digital cards
order_type Yes String 25 Order Type
Value should be:
Personalized  – Payment/Payroll/Purchasing
Reward – Reward
transaction_desc Optional A/N 40 comment will be displayed in trx history/activity detail
shipping_type Yes String 25 Shipping Type
Shipping type could be BulkShip Or IndividualShip.
BulkShip – Cards will be shipped in bulk to a single (i.e. company) address.
IndividualShip – Cards will be shipped to cardholder’s individual addresses.
Note: Required for personalized orders. For Personalized Digital orders pass IndividualShip
shipping_method Yes String 50 Shipping Method
For bulk shipping  – UPS Next Day Air, UPS Ground, UPS Second Day, FedEx Ground, FedEx 2nd Day, FedEx Next Day
For Individual ship – USPS First Class, UPS Next Day Air, UPS Ground, UPS Second Day, USPS w/ Tracking, FedEx Ground, FedEx 2nd Day, FedEx Next Day
Note: Required for personalized orders. For Personalized Digital orders pass: USPS First Class
shipping_addressee Yes String 26 Shipping Addressee
Shipping address of the receiver.
shipping_attention Yes String 18 Shipping Attention
Shipment receiver’s name to be displayed.
shipping_address1 Yes String 50 Shipping Address Line 1
Residential address/street of the receiver.
Note: Required for both digital and physical card orders
shipping_address2 Optional String 50 Shipping Address Line 2
Additional information about the residential address.
shipping_city Yes A/N 18 Shipping City
City name of the receiver.
Note: Required for both digital and physical card orders
shipping_state Yes A/N 2 Shipping State
State name of the receiver.
Note: Required for both digital and physical card orders
shipping_zip Yes String 5 Shipping Zipcode
Zipcode of the receiver.
Note: Required for both digital and physical card orders
order_custom_data_field1 Optional String 255 Custom data field associated with the Order Flow.
Note: Custom defined fields cannot have special characters such as : (colon) and | (vertical bar)
order_custom_data_field2 Optional String 255 Custom data field associated with the Order Flow.
Note: Custom defined fields cannot have special characters such as : (colon) and | (vertical bar)
order_custom_data_field3 Optional String 255 Custom data field associated with the Order Flow.
Note: Custom defined fields cannot have special characters such as : (colon) and | (vertical bar)
order_custom_data_field4 Optional String 255 Custom data field associated with the Order Flow.
Note: Custom defined fields cannot have special characters such as : (colon) and | (vertical bar)
order_custom_data_field5 Optional String 255 Custom data field associated with the Order Flow.
Note: Custom defined fields cannot have special characters such as : (colon) and | (vertical bar)
discretionary_data_1 Optional String 50 Discretionary data fields used to dynamically pass data to Arrow eye
discretionary_data_2 Optional String 50 Discretionary data fields used to dynamically pass data to Arrow eye
discretionary_data_3 Optional String 50 Discretionary data fields used to dynamically pass data to Arrow eye

Register Cards

Field name Required Type Size (Max Characters) Description
CPID Yes Numeric 9 Customer Program ID
This unique ID is provided by Dash upon registration. CPID is used to determine the program for a customer.
name_first Yes Numeric 50 First Name
First name of the cardholder.
name_last Yes String 50 Last Name
Last Name of the cardholder.
cardholder_external_identifier Optional String 60 Cardholder External Identifier
This unique ID maps every card to an external identifier. It is used to store identifiers like employeeID to place card orders.
ssn_number Yes String 9 Social Security Number
SSN of the cardholder, if required for a a specific customer program. Or, nine digit identifier.
Note: The last four digits would be Access Code.
dob Yes Date 10 Date of Birth
Date of birth in mm/dd/yyyy format
email Optional String 50 Email id of the person. REQUIRED if using DIGITAL product. Allowed characters: letters (A–Z, a–z), numbers (0–9), and symbols: ! # $ % & ‘ * + – / = ? _ \ { } ~
Restrictions:
. (dot) and other special characters (^ and |) are not allowed at the start, end, or consecutively.
Allowed special characters must be followed by a letter or number.
phone Yes String 23 phone number of the receiving person
Accepts international phone numbers in the format +<CountryCode>(<AreaCode>)-(<Prefix>)-(<LineNumber>), such as +1(555)-(555)-(5555), in a continour numberic format without any symbols, e.g., 15555555555.
proxy_number Yes String 18 Proxy Number
Every Card number is mapped with a unique Proxy number for card registration identification
card_holder_home_address1 Yes A/N 50 Cardholder address Line 1
Residential address/street of the receiver.
card_holder_home_address2 Optional A/N 50 Cardholder address Line 2
Additional information about the residential address.
Note: Required for load only
card_holder_home_city Yes String 18 Cardholder City
Cardholder city name.
card_holder_home_state Yes String 2 Cardholder State
Cardholder state code abbreviation.
e.g. AL for Alabama, CA for California.
card_holder_home_zip Yes Numeric 5 Cardholder zip code
Cardholder receiving address zip code.
load_value Optional Decimal 10 Load Value
Up to 2 positive decimal places to load the card, e.g., 1.20.
We allow load with:
Personalized orderCard registrationLoad card.
order_type Yes String 255 Order Type
Order type should be CardRegistration.
transaction_desc Optional A/N 40 Transaction Description
Add a comment for a transaction for any note keeping. The added comment will be displayed in trx history/activity detail.
shipping_type Optional String 25 Shipping Type
Shipping type could be BulkShip Or IndividualShip.
BulkShip – Cards will be shipped in bulk to a single (i.e. company) address.
IndividualShip – Cards will be shipped to cardholder’s individual addresses.
shipping_method Optional String 50 Shipping Method
Shipping methods are different based on the shipping type.
For bulk shipping  – UPS Next Day Air, UPS Ground, UPS Second Day, FedEx Ground, FedEx 2nd Day, FedEx Next Day
For Individual ship – USPS First Class, UPS Next Day Air, UPS Ground, UPS Second Day, USPS w/ Tracking, FedEx Ground, FedEx 2nd Day, FedEx Next Day
reg_custom_data_field1 Optional String 255 Custom data field associated with the Register Flow.
Note: Custom defined fields cannot have special characters such as : (colon) and | (vertical bar)
reg_custom_data_field2 Optional String 255 Custom data field associated with the Register Flow.
Note: Custom defined fields cannot have special characters such as : (colon) and | (vertical bar)
reg_custom_data_field3 Optional String 255 Custom data field associated with the Register Flow.
Note: Custom defined fields cannot have special characters such as : (colon) and | (vertical bar)
reg_custom_data_field4 Optional String 255 Custom data field associated with the Register Flow.
Note: Custom defined fields cannot have special characters such as : (colon) and | (vertical bar)
reg_custom_data_field5 Optional String 255 Custom data field associated with the Register Flow.
Note: Custom defined fields cannot have special characters such as : (colon) and | (vertical bar)

Load Cards

Field name Required Type Size (Max Characters) Description
CPID Yes Numeric 9 Customer Program ID
This unique ID is provided by Dash upon registration. CPID is used to determine the program for a customer.
name_first Optional Numeric 50 First Name
First name of the cardholder.
name_last Optional String 50 Last Name
Last Name of the cardholder.
cardholder_external_identifier Conditional String 60 Cardholder External Identifier
This unique ID maps every card to an external identifier. It is used to store identifiers like employeeID to place card orders.
proxy_number Conditional String 18 Proxy Number
Note: Required if employee_id(cardholder_external_identifier) is not provided
load_value Yes Decimal 10 Load Value
Up to 2 positive decimal places to load the card, e.g., 1.20.
card_type Yes String 255 Card Type
Digital or Physical
order_type Yes String 255 Order Type
Value should be LoadCard
transaction_desc Optional String 255 Transaction Description
Add a comment for a transaction for any note keeping. The added comment will be displayed in trx history/activity detail.
load_custom_data_field1 Optional String 255 Custom data field associated with the Load Flow.
Note: Custom defined fields cannot have special characters such as : (colon) and | (vertical bar)
load_custom_data_field2 Optional String 255 Custom data field associated with the Load Flow.
Note: Custom defined fields cannot have special characters such as : (colon) and | (vertical bar)
load_custom_data_field3 Optional String 255 Custom data field associated with the Load Flow.
Note: Custom defined fields cannot have special characters such as : (colon) and | (vertical bar)
load_custom_data_field4 Optional String 255 Custom data field associated with the Load Flow.
Note: Custom defined fields cannot have special characters such as : (colon) and | (vertical bar)
load_custom_data_field5 Optional String 255 Custom data field associated with the Load Flow.
Note: Custom defined fields cannot have special characters such as : (colon) and | (vertical bar)

Return File

Field Name Type Size (Max Characters) Description
CPID Numeric 09 Customer Program ID. This unique ID is provided by Dash upon registration. CPID is used to determine the program for a customer.
name_first String 50 First Name. First name of the customer.
name_last String 50 Last Name. Last Name of the customer.
cardholder_external_identifier String 60 Cardholder External Identifier. This unique ID maps every card to an external identifier. It is used to store identifiers like employeeID to place card orders.
transaction_external_identifier String 36 Transaction External Identifier. This unique ID is generated for every transaction. It only applies to Load actions.
ssn_number Numeric 09 Social Security Number. SSN of the cardholder, if required for a specific customer program. Or, nine-digit identifier.
dob Date 10 Date of Birth.
email A/N 50 Email ID of the customer. Required if the card is Digital.
phone Numeric 23 Phone Number. Phone number of the customer.
name_on_card String 26 Name on Card. The specified name will be embossed on the card if provided.
fourth_line String 21 Fourth Line of Embossing. The specified line will be printed under the name if provided.
proxy_number Numeric 19 Every Card number is mapped with a unique Proxy number for card registration identification.
card_holder_home_address1 A/N 50 Cardholder address Line 1. Residential address/street of the receiver.
card_holder_home_address2 A/N 50 Cardholder address Line 2. Additional information about the residential address.
card_holder_home_city String 18 Cardholder City. Cardholder city name.
card_holder_home_state String 02 Cardholder State. Cardholder state code abbreviation. e.g. AL for Alabama, CA for California.
card_holder_home_zip Numeric 05 Cardholder zip code. Cardholder receiving address zip code.
qty Numeric 10 Quantity. Displayed only for Instant Issue orders.
load_value Decimal 10 Load Value. Up to 2 positive decimal places to load the card, e.g., 1.20. We allow load with: Personalized order, Card registration, Load card.
card_type String 10 Card Type. Specifies if the card is Digital or Physical.
order_type String 25 Order Type. Specifies if the order type is Personalized, InstantIssue, CardRegistration, LoadCard, or Reward.
transaction_desc A/N 40 Transaction Description. The comment will be displayed in trx history/activity detail.
shipping_type String 25 Shipping Type. Shipping type could be BulkShip Or IndividualShip. BulkShip – Cards will be shipped in bulk to a single (i.e. company) address. IndividualShip – Cards will be shipped to cardholder’s individual addresses.
shipping_method String 50 Shipping Method. Shipping methods are different based on the shipping type. For bulk shipping – UPS Next Day Air, UPS Ground, UPS Second Day, FedEx Ground, FedEx 2nd Day, FedEx Next Day. For Individual ship – USPS First Class, UPS Next Day Air, UPS Ground, UPS Second Day, USPS w/ Tracking, FedEx Ground, FedEx 2nd Day, FedEx Next Day.
shipping_addressee String 26 Shipping Addressee. Shipping address of the receiver.
shipping_attention String 18 Shipping Attention. Shipment receiver’s name to be displayed.
shipping_address1 A/N 50 Shipping Address Line 1. Residential address/street of the receiver.
shipping_address2 A/N 50 Shipping Address Line 2. Additional information about the residential address.
shipping_city String 18 Shipping City. City name of the receiver.
shipping_state String 02 Shipping State. State name of the receiver.
shipping_zip Numeric 05 Shipping Zipcode. Zipcode of the receiver.
order_custom_data_field1 Optional String 255 Custom data field associated with the Order Flow.
order_custom_data_field2 Optional String 255 Custom data field associated with the Order Flow.
order_custom_data_field3 Optional String 255 Custom data field associated with the Order Flow.
order_custom_data_field4 Optional String 255 Custom data field associated with the Order Flow.
order_custom_data_field5 Optional String 255 Custom data field associated with the Order Flow.
reg_custom_data_field1 Optional String 255 Custom data field associated with the Registration Flow.
reg_custom_data_field2 Optional String 255 Custom data field associated with the Registration Flow.
reg_custom_data_field3 Optional String 255 Custom data field associated with the Registration Flow.
reg_custom_data_field4 Optional String 255 Custom data field associated with the Registration Flow.
reg_custom_data_field5 Optional String 255 Custom data field associated with the Registration Flow.
load_custom_data_field1 Optional String 255 Custom data field associated with the Value Load transaction.
load_custom_data_field2 Optional String 255 Custom data field associated with the Value Load transaction.
load_custom_data_field3 Optional String 255 Custom data field associated with the Value Load transaction.
load_custom_data_field4 Optional String 255 Custom data field associated with the Value Load transaction.
load_custom_data_field5 Optional String 255 Custom data field associated with the Value Load transaction.
dda Numeric 10 Direct Deposit Account. Bank Account Number associated with the proxy.
trn Numeric 10 Transaction Routing Number. Bank Routing Number associated with the proxy.
proxy Numeric 13 Proxy Number. New Proxy Number number from card order.
Cardholder_UUID String 36 Card holder Unique ID. Internal Identifier to the cardholder created.
Transaction_UUID String 36 Transaction Unique ID. Internal Identifier for load transactions.
tiny_url String 255 Tiny URL. Link that can be presented to the cardholder to bypass proxy input during registration. To enable tiny URL, make the changes in the sFTP settings of the Dash Portal
status Optional String 20 Status of the sFTP file upload. Could be: Failed, Completed, Invalid, or Duplicate.
statuscode Optional Numeric 10 Displays the error code.
message Optional String 255 Displays the error message.