Defines order IDs, invoice numbers, and custom merchant-defined fields.
Ancillary Data
Use the fields below to define transaction totals, itemized purchase information, reporting data, fraud screening details, and custom transaction metadata.
| Variable | Requirement | Type | Max Size | Possible Values / Example | Description | Notes |
|---|---|---|---|---|---|---|
ipaddress |
Optional / Fraud | string | 15 | 123.123.123.123 |
IP address of the customer or posting system. | Required when fraud protection services are enabled. Should contain the customer’s IP address, not the merchant server IP. |
orderID |
Optional | string | 20 | 1234567890 |
Unique numeric order identifier associated with the transaction. | Alpha characters are not permitted. If omitted, a timestamp-based value is generated automatically. Highly recommended for duplicate prevention and transaction tracking. |
order-id |
Optional | string | 20 | INV-10001 |
Merchant-defined alphanumeric transaction reference value. | Commonly used for invoices, usernames, customer IDs, or internal tracking identifiers. |
acct_code |
Optional | string | 20 | SALESGROUP1 |
Merchant-defined reporting and grouping value. | Include this field with your orders/transactions to store it’s value to our database with other transaction data. You can later use this field to filter/select only those orders which match the value passed when using many of the administrative functions. |
acct_code2 |
Optional | string | 20 | REGION-EAST |
Additional merchant-defined reporting and grouping value. | Additional account code field, see acct_code for details. Used for custom reporting segmentation. |
acct_code3 |
Optional | string | 20 | ONLINESTORE |
Additional merchant-defined reporting and grouping value. | Additional account code field, see acct_code for details. Used for custom reporting segmentation. |
sessionid |
Optional | string | N/A | ABC123SESSION |
Merchant session identifier associated with the transaction. | Useful for retrieving pre-stored session data after authorization processing. |
customname# |
Optional | string | N/A | membership_level |
Merchant-defined custom field name. | Must be paired with a corresponding customvalue# field. |
customvalue# |
Optional | string | N/A | gold |
Merchant-defined custom field value. | Must be paired with a corresponding customname# field. |
Notes
1. Processor-Specific Requirements
The orderID field is required when using Pago or Wirecard merchant processor configurations. For all other processors, the field is optional but strongly recommended.
2. Custom Field Handling
Custom transaction fields are supported through paired customname# and customvalue# parameters.
The # symbol represents a sequential numeric identifier beginning at 1.
Example:
customname1=xyz
customvalue1=12345
customname2=abc
customvalue2=98765
The transaction response will return both the individual custom field pairs and their combined formatted values.
Example returned response values:
xyz=12345
abc=98765