Optional Configuration
  • 13 Jul 2022
  • 3 Minutes to read
  • Dark
    Light

Optional Configuration

  • Dark
    Light

Prepopulate Virtual Terminal Fields

Map fields from the Transaction's Parent Object to the Terminal's Transaction screen using a Custom Metadata Type called, "Virtual Terminal Mapping."

Please make sure the fields mapped have the same field type and property. For example, if you created a custom field to prepopulate currency, make sure it matches the same format as the currency field on Transaction.

Fields that can be prepopulated:

  • Related To
  • Payment Method
  • Description
  • Amount
  • Currency
  • Email
  • Holder's NameNote: This is for Credit Card Payment Methods only at this time.
  • Custom fields

Navigate to Custom Metadata Types.

Lightning/Classic: Navigate to Setup | In the Quick Find / Search, type in and select " Custom Metadata Types."

  1. Click "Manage Records" next to Virtual Terminal Mapping.
  2. Click New.
  3. Add values to the following fields:

Virtual Terminal Mapping Name This is the API name for the record. The API name can only contain underscores and alphanumeric characters. It must be unique, begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores.For example, "opp_amount."

Label This is the label for the particular prepopulating record.For example, use "Opp->Trans Amount" for the label if you are prepopulating the amount field.

Screen Single Transaction.Use the Related To screen for prepopulating the "Related To" field on the Terminal's Transaction screen. See example here.

Source Object Select the Parent Object.For example, the Opportunity Object.

Source Field Select the field you want the value to come from.For example, if you want to prepopulate the Terminal's Transaction amount with the Opportunity's amount, then select the amount field from the list.

Target Object select Transaction [bt_stripe].

Target Field Select the field you want the value to populate in.For example, you would select the Amount field.

  1. Click Save.
    J_02_03_optional config pic 1

Add or Remove Virtual Terminal Fields

Adding, removing, and modifying fields on the Virtual Terminal is done through Field Sets. A Field Set is a grouping of fields that can be displayed on Lightning Components. Where a user can add, remove, or rearrange fields from the Field Set, without altering the Lightning Component.

Formula and auto-number fields cannot be added to the fieldset.

Virtual Terminal Transaction Configuration

  1. Navigate to the Transaction object in Setup.
  2. Click Field Sets.
  3. Click Edit next to Virtual Terminal.
  4. Remove, add, and modify the fields within that box to fit your use case.

Fields "In the Field Set" box are the fields currently on the Virtual Terminal's Transaction screen.

  1. Click Save.

J_02_03_optional config pic 2


J_02_03_optional config pic 3

New Record Screen

New record screen allows you to create new records from the "Related To" field on the Virtual Terminal.

Account and Contact

The Account and Contact "New Record" screens have predefined fields available and a FieldSet record is automatically created.

  1. Navigate to the Account or Contact Object in Setup.
  2. Click Field Sets.
  3. Click Edit next to "Virtual Terminal."
  4. Remove, add, and modify the fields within that box to fit your use case.Fields "In the Field Set" box are the fields currently on the Virtual Terminal's new Account or Contact record screen.
  5. Click Save.

J_02_03_optional config pic 4

Other Objects

Related To objects besides Account and Contact, show a blank "New Record" screen. In order to create new records, you will need to manually create a Field Set.

For example, the new Lead screen looks like this before adding a FieldSet:

J_02_03_optional config pic 5

  1. Navigate to the Lead Object in Setup.

  2. Click Field Sets.

  3. Click New.

  4. Add values to the following fields:

    Field Set Label Virtual Terminal.

    Field Set Name VirtualTerminal._If the Field Set Name value is different than above, the fields will not display on the Virtual Terminal screen.

    Where is this used? Description of this Field Set. For example, "Virtual Terminal for the new Lead record screen."

  5. Drag the fields you want to use for creating a new Lead record "In the Field Set" box.

  6. Click Save.

J_02_03_optional config pic 6

The screen now has fields and can create new Lead records!