Information Batch Import File Format
The Card Numbers Batch Import File is a properly formatted CSV or XML batch file of card numbers and/or Recurring IDs to generate tokens that is uploaded through the Information Batch Import (cctokenimport) transaction.
CSV Format
The format of a CSV batch file is as follows:
- Header
- First line of the file.
- Contains all the field names.
- Each field name is enclosed within double quotes and followed by a comma.
- Transaction Data
- Starts after the header line.
- Each transaction data is placed on a single line.
- Each transaction data is enclosed within double quotes and followed by a comma.
- The transaction data is placed in the same order of the field names.
You can download a csv template for batch imports.
Example
"ssl_card_number","ssl_exp_date","ssl_transaction_type","ssl_verify","ssl_avs_address","ssl_avs_zip";"ssl_add_token","ssl_first_name","ssl_last_name",
"0000000000000000","1212","ccgettoken","Y","123 Main","31307""N","","",
"0000000000000000","1213","ccgettoken","N","","","Y","John","Doe",
XML Format
The format of an XML batch file is as follows:
- The file contains a single
<txnimport>element and multiple<txn>(transaction) nested elements. - Every transaction is a set of XML tags.
- The number of
<txn>corresponds to the number of transactions in the file. - All elements must be closed in the order that these were opened.
Example
<txnimport>
<txn>
<ssl_card_number>0000000000000000</ssl_card_number>
<ssl_exp_date>1212</ssl_exp_date>
<ssl_transaction_type>ccgettoken</ssl_transaction_type>
<ssl_verify>Y</ssl_verify>
<ssl_avs_address>123 Main</ssl_avs_address>
<ssl_avs_zip>31307</ssl_avs_zip>
</txn>
<txn>
<ssl_card_number>0000000000000000</ssl_card_number>
<ssl_exp_date>1213</ssl_exp_date>
<ssl_transaction_type>ccgettoken</ssl_transaction_type>
<ssl_verify>N</ssl_verify>
<ssl_add_token>Y</ssl_add_token>
<ssl_first_name>John</ssl_first_name>
<ssl_last_name>Doe</ssl_last_name>
</txn>
</txnimport>
Fields
error_outline
note
CVV2/CVC/CID values and Track data should never be stored, and therefore cannot be passed to Converge on the file.
| Field name | Description | Required | Length | Data type |
|---|---|---|---|---|
ssl_card_number | Card Number Card Number as it appears on the credit card. | Conditional | 18 | numeric |
ssl_exp_date | Card’s Expiry Date Date when the card becomes invalid. Important: Required if ssl_card_number is not null.Format: MMYY | Conditional | 4 | numeric |
ssl_recurring_id | Recurring ID Unique identifier of the recurring payment record. | Conditional | 50 | alphanumeric |
ssl_transaction_type | Transaction Type Value: ccgettoken (Generate Token) | Required | 20 | alphanumeric |
ssl_verify | Account Verification Indicator Indicates whether the Converge needs to verify the account before generating a token. Valid values:
| Optional | 1 | alphanumeric |
ssl_avs_address | Address Line 1 Commonly the house number and street name on the cardholder’s / customer’s account or billing address. Address Verification Service (AVS) data compared with the address on the card issuer’s file. Recommended if ssl_verify = Y. | Optional | 30 | alphanumeric |
ssl_avs_zip | Postal or ZIP Code ZIP code on the cardholder’s account or billing address. Address Verification Service (AVS) data compared with the postal or ZIP code on the card issuer’s file. Recommended if ssl_verify = Y. | Optional | 9 | alphanumeric |
ssl_add_token | Add to Card Manager Indicator Indicates whether to add token and cardholder details to Card Manager. Valid values:
| Optional | 1 | alphanumeric |
ssl_first_name | First Name First name on the cardholder’s / customer’s account or billing address. Important: If ssl_add_token is set to Y, the first name is mandatory. | Conditional | 50 | alphanumeric |
ssl_last_name | Last Name Last name on the cardholder’s / customer’s account or billing address. Important: If ssl_add_token is set to Y, the last name is mandatory. | Conditional | 50 | alphanumeric |