Developer Portal
4 Appendix B: Input File Format
General Notes:
- Empty lines are ignored.
- Comment lines beginning with “#” are ignored.
- A <Newline> can either be /n or /r/n/
- A minimum field length of 0 means the field is not required
4.1 Delimiter
| Field | Name | Description | Type | Min Length | Max Length |
|---|---|---|---|---|---|
| 1 | command | Must be ‘delimiter’ request name is case insensitive | Alpha | N/A | N/A |
| 2 | delimiter | A field delimiter used for all remaining lines in the file. The delimiter can contain any ASCII character. For readability the following characters can be escaped: tab → “\t” space → “\s” back slash → “\\” examples ( tab + comma ) = “\t,” ( pipe ) = “|” | any | 1 | 4 |
4.2 Credit Card Requests with Token
| Field | Name | Description | Type | Min Length | Max Length |
|---|---|---|---|---|---|
| 1 | Command | Case insensitive command. Supported commands: 'CCAuthorizeToken' **, 'CCSaleToken', 'CCCreditToken' | Alpha | N/A | N/A |
| 2 | Source ID | Transaction Source ID. Source IDs are configured for your company on Payway. The source ID determines which merchant is used. A single file can have multiple source IDs. | Number | N/A | N/A |
| 3 | Token | Payway token to be used for this transaction. | Number | 1 | 10 |
| 4 | ECI Type | Input ECI type. 1 → MOP_MOTO_SINGLE 2→ MOP_MOTO_RECURRING 3→ MOP_MOTO_INSTALLMENT 4→ MOP_MOTO_DEFERRED 5→ MOP_SET 6 → MOP_NA_SET 7 → MOP_CHANNEL_ENCRYPT 8 → MOP_NON_SECURE 9 → MOP_PINLESS_DEBIT 10 → MOP_RETAIL | Number | 1 | 2 |
| 5 | Amount | An integer representing the amount in pennies for the transaction. Required for Authorize, Sale, and Credit. Ignored for Capture and Void. Amount is in PENNIES example: $100.00 → 10000 | Number | 1 | 9 |
| 6 | Tax | An integer representing the tax in pennies for the transaction. example: $10.00 → 1000 | Number | 1 | 9 |
| 7 | Notes 1 | User data up to 64 bytes | any | 0 | 64 |
| 8 | Notes 2 | User data up to 64 bytes | any | 0 | 64 |
| 9 | Notes 3 | User data up to 64 bytes | any | 0 | 64 |
# Sample file template with token delimiter ; <Command>;<Source Id>;<Token>;<ECI Type>;<Amount>;<Tax Amount>;<CustomFieldOne>;<CustomFieldTwo>;<CustomFieldThree> # Sample Sale file delimiter ; CCSaleToken;20;010000344;1;120000;0;test1;test2;test3 # Sample Authorize file delimiter ; CCAuthorizeToken;20;010000344;1;120000;0;test1;test2;test3 # Sample Credit file delimiter ; CCCreditToken;20;010000344;1;120000;0;test1;test2;test3
4.3 Existing Credit Card Requests with Token**
| Field | Name | Description | Type | Min Length | Max Length |
|---|---|---|---|---|---|
| 1 | Command | Case insensitive command. Supported commands: ‘CCCapture’, ‘CCVoid’ | Alpha | N/A | N/A |
| 2 | Transaction ID | unique identifier for a payment request. This is returned in the reply file for each transaction. | any | 0 | 64 |
** Not Supported in this release.
Example Existing Credit Card Request with Token
# Sample file template with token delimiter ; <Command>;<Transaction Id> # Sample Void file delimiter ; CCVoid;<Transaction Id> # Sample Credit file delimiter ; CCCapture;<Transaction Id>
4.4 Non-tokenized Credit Card Requests
| Field | Name | Description | Type | Min Length | Max Length |
|---|---|---|---|---|---|
| 1 | Command | Case insensitive command. Supported commands: “CCAuthorizeAccount”** “CCSaleAccount” “CCCreditAccount” | Alpha | N/A | N/A |
| 2 | Source ID | Transaction source ID. Source IDs are configured for your company on Payway. The source ID determines which merchant is used. A single file can have various source IDs. | Number | N/A | N/A |
| 3 | Account | Credit card account number. | Number | 15 | 19 |
| 4 | Expiration | Expiration dat. MMYY or MMYYYY | Number | 4 | 6 |
| 5 | ECI Type | Input ECI type. 1 → MOP_MOTO_SINGLE 2→ MOP_MOTO_RECURRING 3→ MOP_MOTO_INSTALLMENT 4→ MOP_MOTO_DEFERRED 5→ MOP_SET 6 → MOP_NA_SET 7 → MOP_CHANNEL_ENCRYPT 8 → MOP_NON_SECURE 9 → MOP_PINLESS_DEBIT 10 → MOP_RETAIL | Number | 1 | 2 |
| 6 | Amount | An integer representing the amount in pennies for the transaction. Required for Authorize, Sale, and Credit. Ignored for Capture and Void. | Number | 1 | 9 |
| 7 | Tax | An integer representing the tax in pennies for the transaction. example: $10.00 → 1000 | Number | 1 | 9 |
| 8 | FirstName | First name of cardholder | any | 0 | 64 |
| 9 | LastName | Last name of cardholder or company name | any | 0 | 64 |
| 10 | Address | Address of cardholder | any | 0 | 128 |
| 11 | City | City of cardholder | any | 0 | 128 |
| 12 | State | State of cardholder, 2 digit abbreviation or 3 character Canadian province. | Number | 0 | 3 |
| 13 | Zip | Zip of cardholder, 5 or 9 digits | any | 0 | 9 |
| 14 | Phone | Phone number of cardholder | Number | 0 | 10 |
| 15 | Email of cardholder | any | 0 | 128 | |
| 16 | Notes1 | User data up to 64 bytes | any | 0 | 64 |
| 17 | Notes2 | User data up to 64 bytes | any | 0 | 64 |
| 18 | Notes3 | User data up to 64 bytes | any | 0 | 64 |
Example Credit Card Request
# Sample file template with token delimiter ; <Command>;<Source Id>;<Account>;<Expiration>;<ECI Type>;<Amount>; <Tax);<FirstName>;<LastName>;<Address>;<City>;<State>;<Zip>; <Phone>;<Email>;<CustomFieldOne>;<CustomFieldTwo>;<CustomFieldThree> # Sample Sale file delimiter ; CCSaleAccount;20;4012888888881881;1121;1;120000;0;John;Doe;222 Rosewood;Danvers;MA;01923;8004579932;[email protected];test1;test2; test3 # Sample Authorize file delimiter ; CCAuthorizeAccount;20;4012888888881881;1121;1;120000;0;John;Doe; 222 Rosewood; Danvers;MA;01923;8004579932;[email protected];test1;test2;test3 # Sample Credit file delimiter ; CCCreditAccount;20;4012888888881881;1121;1;120000;0;John;Doe; 222 Rosewood; Danvers;MA;01923;8004579932;[email protected];test1;test2;test3
4.5 Non-tokenized Existing Credit Card Requests**
| Field | Name | Description | Type | Min Length | Max Length |
|---|---|---|---|---|---|
| 1 | Command | Case insensitive command. Supported commands: ‘CCCapture’, ‘CCVoid’ | Alpha | N/A | N/A |
| 2 | Transaction ID | Unique identifier for a payment request. This is returned in the reply for each transaction. | Any | 0 | 64 |
Example Existing Credit Card Request
# Sample file template with token delimiter ; <Command>;<Transaction Id> # Sample Void file delimiter ; CCVoid;<Transaction Id> # Sample Credit file delimiter ; CCCapture;<Transaction Id>
4.6 ACH Requests with Token**
Intentionally Blank
** Not Supported in this release.
4.7 Non-tokenized ACH Requests**
Intentionally Blank
** Not Supported in this release.
4.8 Create Token Requests**
| Field | Name | Description | Type | Min Length | Max Length |
|---|---|---|---|---|---|
| 1 | Command | ** Not Supported in this release. | Alpha | N/A | N/A |
| 2 | Account | Credit card account number. | Number | 15 | 19 |
| 3 | Expiration | Expiration date. MMYY or MMYYYY | Number | 4 | 6 |
| 4 | FirstName | First name of cardholder | any | 0 | 64 |
| 5 | LastName | Last name of cardholder or company name | any | 0 | 64 |
| 6 | Address | Address of cardholder | any | 0 | 128 |
| 7 | City | City of cardholder | any | 0 | 128 |
| 8 | State | State of cardholder, 2 digit abbreviation or 3 character Canadian province | Alpha | 0 | 3 |
| 9 | Zipcode | Zipcode of cardholder | any | 0 | 9 |
| 10 | Phone | Phone number of cardholder | Number | 0 | 10 |
| 11 | Email of cardholder | any | 0 | 128 | |
| 12 | Notes1 | User data up to 64 bytes | any | 0 | 64 |
| 13 | Notes2 | User data up to 64 bytes | any | 0 | 64 |
| 14 | Notes3 | User data up to 64 bytes | any | 0 | 64 |
** Not Supported in this release.
# Sample file template with token delimiter ; <Command>;<Account>;<Expiration>; <FirstName>;<LastName>;<Address>;<City>;<State>;<Zip>;<Phone>; <Email>;<CustomNotesOne>;<CustomNotesTwo>;<CustomNotesThree> # Sample Sale file delimiter ; CCCreatetoken;4012888888881881;1121;John;Doe; 222 Rosewood;Danvers; MA;01923; 8004579932;[email protected];test1;test2;test3