Credit Card

The credit card field is used to process payments via Braintree. This field does not store any sensitive credit card information in the database. All sensitive data is sent directly to Braintree where they store it according to PCI standards and return to WorkXpress a token to use for later processing.

Before you start

To use this field type you will need to signup for a Braintree account for production keys and signup for a Braintree sandbox account for development and testing keys. You will then have to create short text fields to store the keys in your application.

How to Create

  1. Click the to add a field in your form.
  2. Choose “New Field”
  3. Select the table you wish to add the field to. Most of the time, this will be the current table you are on, called the current context.
  4. Select a field name and click “Choose Type”.
  5. Choose “Credit Card” from the list of field types.
  6. Use the Query Builders provided to lookup the Braintree Credentials for your Braintree account.
  7. You can continue adding fields or click the “Select” button to finish adding.


Field Label

Grid Appearance


Braintree Credentials

Term Acceptance

Because credit card charges can be challenged by end users it is important that they agree to the terms and conditions of your application and its charges. Because the terms and conditions that the end user is agreeing to is a legally binding contract it is recommended that you draft your terms with the help of a lawyer. Without explicitly agreeing to the terms and conditions the end user could legitimately claim to have been unaware of and not in agreement with your terms causing your charges to be reversed. The term acceptance dialog will appear when an end user attempts to save a credit card field that contains new or modified credit card information. It is not possible for the end user to finish saving the form without agreeing to the terms.

Fig. 1: Exmaple Credit Card Terms Dialog

Customer Billing Information

In addition to storing the credit card data, Braintree can store and associate other data with the customer record it creates.

Testing the field in Build and Testing Applications

When in a Build or Testing WorkXpress Application, the Credit Card Field won't actually charge your credit card. It accesses what Credit Card Processors call their “Sandbox”, where made up credit card numbers are valid for any amount of money, for testing purposes.

When in Build or Testing, you can use the following credentials to test:

  • Credit Card Number: 4111 1111 1111 1111
  • Expiration: 01 / Next Year (Any future month and year will work)
  • CVV Code: 123 (any CVV code will work.

A Production WorkXpress will connect to the Credit Card Processors' production system, and will charge whatever card is entered; which must be valid.

Transaction Information

In addition to storing customer credit card data, it is possible to configure the credit card field to process a payment at the time that it is saved without having to build Credit Card Gateway (Braintree Payments) actions. If this option is used the field will only process one payment and subsequent saves will not cause it to charge the customer. This setting is best used for one time payment interactions with the end user.

Important Note: The amount value must be stored in the database prior the the Credit Card field being displayed on the screen.

Block Association

Default Value


Field parts

The Credit Card Field has up to 9 parts:

  • Card Holder Name
  • Card Token
  • Card Type
  • Braintree Customer ID
  • Card Expiration Month
  • Card Expiration Year
  • Card First Six Digits
  • Card Last Four Digits
  • Transaction ID (when the Transaction Amount Setting is used)

Output formats (where applicable)

The credit card field has eleven different output formats:

  • Full Field - This output format returns the redacted card number.
  • WX Stored Value - This output format returns the internally stored XML for the credit card Field. Use this format when saving the entire credit card from one Field to another credit card Field, or when setting a default value for a credit card Field. Whenever this format is used, the “Return results as” setting must be set to “HTML.”
  • Card Holder Name - this output format returns the card holder name
  • Card Token - this output format returns the card token
  • Card Type - this output format returns the card type such as Visa or Mastercard
  • Braintree Customer ID - this output format returns the Braintree Customer ID
  • Card Expiration Month - this output format returns the 2 digit expiration month
  • Card Expiration Year - this output format returns the 2 digit expiration year
  • Card First Six Digits - this output format returns the first 6 digits of the card number
  • Card Last Four Digits - this output format returns the last 4 digits of the card number
  • Transaction ID - this output format returns the Braintree Transaction ID when the field was configured to process a transaction


The credit card field can be filtered using the credit card filters.

field type - credit card.txt · Last modified: 2016/09/14 18:19 (external edit)
Copyright WorkXpress, 2024