Custom fields allow you to customize your checkout experience by collecting specific information about your customers and their purchases.

You can include custom fields when:

Custom field types

There are two types of custom fields: Pass Thru fields and Store and Pass Back fields.

Pass Thru fields

Pass Thru fields are designed to pass a value from your checkout form to your servers, where you can either store or respond to the data. For example, if you have a checkbox for "Join Mailing List" on your checkout form and you pass this data through as a custom field, your servers can respond by adding the customer to your mailing list.

While Pass Thru custom fields are configured in the Control Panel, they can only be used to pass data via the API.

Store and Pass Back fields

The data passed by Store and Pass Back fields is stored in the Control Panel and returned via the API on the transaction response object. It's also available for download via a Transaction or Vault Search. Keep in mind that you can only search for the data passed within a Store and Pass Back field; you won’t be able to search for the field name itself.

Creating a custom field

Custom fields can only be configured directly in the Control Panel by users with the Add/Edit Processing Options role permission. There isn’t a way to set up new custom fields via the API.

To create a custom field:

  1. Log into the Control Panel
  2. Navigate to Settings > Processing
  3. Scroll down to Custom Fields and click Options
  4. Click Add
  5. Enter a custom field API name to pass with your code
    • This value must be less than or equal to 255 characters and can't contain any spaces or capital letters
  6. Enter a display name
    • This is what will appear in your transaction history and Vault records
  7. Under Options, select either Store and Pass Back or Pass Thru
  8. Click Add Custom Field

Editing a custom field

In order to edit custom fields in the Control Panel, your user's role must have the Add/Edit Processing Options role permission enabled. To edit a custom field:

  1. Log into the Control Panel
  2. Navigate to Settings > Processing
  3. Scroll down to Custom Fields and click Options
  4. Under Display Name, click the desired custom field
  5. On the editing form, you can change the field's display name or toggle between Store and Pass Back and Pass Thru field types
  6. Click Save

Deleting a custom field

note

You can only delete custom fields that have never been used to collect customer or transaction data.

In order to delete custom fields in the Control Panel, your user's role must have the Add/Edit Processing Options role permission enabled. To delete a custom field from the Control Panel:

  1. Log into the Control Panel
  2. Navigate to Settings > Processing
  3. Scroll down to Custom Fields and click Options
  4. Under Display Name, locate the desired custom field
  5. Click on the X icon in the desired row
  6. Click Yes to confirm

Still have questions?

If you can’t find an answer, contact our Support team


← Back to Previous Page