For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Get support
HomeDocsAPI ReferenceRelease Notes
HomeDocsAPI ReferenceRelease Notes
  • Get Started
    • Overview
    • Setup
    • Tokenize
    • Process a Payment
    • Report Transactions
    • Validate & Deploy
  • Guides
      • ACH Payments
      • Billing Plans
      • Card On File - Compliance Guide
      • Custom Fields
      • Gateway Response Codes
      • ID Mapping
      • Merchant Surcharge Program
      • Vaults
Get support
LogoLogo
On this page
  • Setup
  • Transaction Custom Fields
  • Account Custom Fields
GuidesPayments

Custom Fields

Was this page helpful?
Previous

Gateway Response Codes

Next
Built with

Setup

Additional data may be included in an authorization request for future retrieval by using custom fields. The value of the custom field parameter is a series of name-value pairs that are meaningful to the merchant.

If you use Run Merchant for transaction reporting, you must enable these fields from the Settings page to ensure the fields populate correctly in the transactions table. You must enable a custom field with an empty value to preserve the expected order of the fields.

Transaction Custom Fields

Transaction custom fields are optional fields that can be used to capture order data. This information is stored with the transaction. Transaction custom fields are not saved with a vaulted payment account.

Examples: Invoice ID, PO Number, Tracking Information

1"custom_01": "Custom Field 1",
2"custom_02": "Custom Field 2",
3"custom_03": "Custom Field 3",
4"custom_04": "Custom Field 4",
5"custom_05": "Custom Field 5"

Account Custom Fields

Account custom fields are optional fields that can be used to capture account data. This information and will be stored with the transaction AND in the payment account if it is saved to the vault.

Examples: Customer ID, Account Number, Customer Note

1"custom_06": "Custom Field 6",
2"custom_07": "Custom Field 7",
3"custom_08": "Custom Field 8",
4"custom_09": "Custom Field 9",
5"custom_10": "Custom Field 10"