Transaction Details - Itemization and Definition
| Variable | Required | Max Size | Notes |
| currency | Optional | 3 | 3 Char. ISO Currency Code. Defaults to USD. |
| tax | Optional | 7 | Sales Tax charge. |
| shipping | Optional | 7 | Shipping Charge. |
| card-amount | Mandatory | 10 | Format: 1234.56 - Total amount to be charged. |
| gratuity | Optional | 10 | Gratuities are added during postauth requests so sending gratuity is only applicable if authtype=authpostauth(see note 8) |
| app-level | Optional | 1 | AVS approval Level. Please see AVS Specifications for level details. Acceptable values are, 1,2,3,4,5,6. Transactions not meeting specified level will be automatically voided. Address Information suitable for verification is primarily only available on credit cards issued within the United States. |
| ipaddress | Optional/Fraud | 15 | IP address of posting system. Mandatory for fraud protection.(i.e. should be your customer’s IP address, not your server’s IP address) |
| orderID | Optional | 20 | Must be a unique number. [Alpha characters not permitted.] If not submitted one will be generated using a date/time string. This number will be required to perform any future activity for an order, including but not limited to, voids and returns. It is HIGHLY recommended that this be generated on your end as it can significantly reduce instances of duplicate charging and ease future querying. Note capitalization of the I & D.(see note 1) |
| order-id | Optional | 20 | Alphanumeric value generated by you - can be an invoice or customers username/ID or what ever you wish to use to track the payment with the order. |
| acct_code | Optional | 20 | Generated by you - holds alphanumeric formatted data, which can be used to customize reports and group transactions.NOTE: If you are using our Affiliate Management service, you should use ‘acct_code2’ field instead; since the “acct_code” field would be used by the Affiliate Management service to store the affiliate who is credited with the sale. |
| acct_code2 | Optional | 20 | Generated by you - holds alphanumeric formatted data, which can be used to customize reports and group transactions. |
| acct_code3 | Optional | 20 | Generated by you - holds alphanumeric formatted data, which can be used to customize reports and group transactions. |
| item# | Optional/Fraud | 23 | Model # of item. Recommended for extended fraud screening.(see note 2) |
| cost# | Optional/Fraud | 10 | Cost of item. Recommended for extended fraud screening.(see note 2) |
| quantity# | Optional/Fraud | 5 | Quantity of item. Recommended for extended fraud screening.(see note 2) |
| description# | Optional/Fraud | 79 | Long description of item. Recommended for extended fraud screening.(see note 2) |
| sessionid | Optional | Used to pass a session ID with the transaction; so you can pre-store data on your system before the authorization, and then retrieve that data from your system after the authorization has been processed. | |
| customname# | Optional | Used to send name of your own custom field (see note 3) | |
| customvalue# | Optional | Used to send value of your own custom field (see note 3) |
NOTES:
1. These variables are required if your merchant bank processor is either Pago or Wirecard. For other processors, they are optional but highly recommended.
2. To include a list of the items purchased in the confirmation emails sent to both the customer and the merchant, four name/value pairs are required for EACH item purchased. This information will also be stored in our database and can be accessed for report generation from the payment administrative interface.
3. To pass your own own custom fields, you will need to include both a customname# and customvalue# field. The ‘#’ characters in the those fields is a number starting at 1 and increments with each custom name/value pair passed.
For example, if you wanted to send custom variable ‘xyz’ with a value of ‘12345’ and another custom variable ‘abc’ with a value of ‘98765’, you would specify the following fields.
customname1 = xyz
customvalue1 = 12345
customname2 = abc
customvalue2 = 98765
In the transaction response, you will receive the individual customname# and customvalue# fields provided, as well the combined values of those fields (for example: xyz=12345 and abc=98765)