Braintree Custom Fields

As of July 12, 2021, this "Learn Veracross" site has been deprecated.  It will remain live through December 2022, but will no longer be updated. All knowledge content has moved to the new Veracross Community.  Please update your bookmarks.

Here is the new version of this article in the Veracross Community.

Braintree Custom Fields

Custom fields allow you to capture specific, additional information about customer purchases. Pass-thru custom fields are configured in the control panel and they can only be used to pass data via the API. Veracross supports a limited number of custom fields from the checkout receipt header.  

Veracross-Supported Custom Braintree Fields

FieldAPI Name
Checkout Payercheckout_payer
Payment Sourcepayment_source
Payment Titlepayment_title
Payment Descriptionpayment_description


Braintree - School Configuration 

Custom fields in Braintree can only be configured directly in the control panel by users with the add/edit processing options role permission. 

To create a custom field in Braintree:

  1. Log into the Braintree Control Panel.
  2. Click on the gear icon in the top right corner.
  3. Click Processing from the drop-down menu.
  4. Scroll to the Transactions section.
  5. Next to Custom Fields, click the Options link.
  6. Click the Add link located on the right side of the page.
  7. Enter a custom field API name to pass with your code.
    • Custom field API names are limited to the Veracross supported custom Braintree fields
    • Custom field API names must match available API names supported by Veracross
  8. Enter a display name.
    • This is what will appear in your transaction history and Vault records.
  9. Under the Options section, select either Store and Pass Back or Pass Thru.
  10. Click the Add Custom Field button.

Please see additional Braintree Custom Fields information here.

Veracross Configuration

Once the custom fields are created in Braintree, create a support request to Veracross to enable to optional fields.