Configuring Custom Parameters

Configuring Transact Payments(Cashnet) or OPC Custom Parameter 

If you are using Transact Payments (Cashnet) or OPC as your Payment Provider, you can configure Custom Parameters for your Payment Gateway. A custom field is created, either as a formula field or text field, to store the custom values in the following format:

param1=value1&param2=value2&param3=value3

Example:
If you were using a formula field and wished to send over the Deposit Amount and Percent Complete as custom parameters, your formula field would be written as follows:

'Amount=' +Text(TargetX_SRMb__Deposit_Amount__c) & '&PercentComplete=' +Text(TargetX_App__Percent_Complete__c)

The output on a record would display as follows:

Creating Custom Field for Payment Parameters 

1. Navigate to Setup and select Object Manager.
2. Click the Field Label for the Application object.
3. In the Custom Fields & Relationships section, select New
4. Select a Data Type of either Formula or Text and click Next
5. If using a Data Type of Formula (highly recommended)
   • Enter Field Label: Payment Custom Parameters
   • Enter Field Name: Payment_Custom_Parameters__c
   • Enter: Formula Return Type: Text​
6. Click Next
7. Using the formula editor, determine your output value, which must be a text output in the format of: param1=value1&param2=value2&param3=value3
8. Click Next and set field level security and assign to page layouts if desired. 
9. If using a Data Type of Text
   • Enter Field Label: Payment Custom Parameters
   • Enter: Length: 255
   • Enter: Field Name: Payment_Custom_Parameters__c
10. Click Next and set field level security and assign to page layouts if desired.
11. Save your changes. These parameters will now be sent to the Payment Gateway.

Configuring Converge Custom Parameter 

If you are using Converge as your Payment Provider, you can configure Custom Parameters for your Payment Gateway. A custom field is created, either as a formula field or text field, to store the custom values in the following format:

PARAM_NAME1=VALUE1&PARAM_NAME2=VALUE2&PARAM3=VALUE3

Example:
If you were using a formula field and wished to send over the User ID and Full Name as custom parameters, your formula field would be written as follows:

"userId=" & TargetX_SRMb__Contact__c & "&" &
"fullName=" & TargetX_SRMb__Contact__r.FirstName & " " & TargetX_SRMb__Contact__r.LastName &
"&" & "orderType=enrollment_fee" & "&" & "retriesAllowed=0"

The output on a record would display as follows:

Creating Custom Field for CONVERGE Payment Parameters

1. Navigate to Setup and select Object Manager.
2. Click the Field Label for the Application object.
3. In the Custom Fields & Relationships section, select New
4. Select a Data Type of either Formula or Text and click Next

   1. If using a Data Type of Formula (highly recommended)

      1. Enter Field Label: Application Fee Custom Parameters OR Enrollment Deposit Custom Parameter
      2. Enter Field Name: Application_Fee_Custom_Parameters__c OR Enrollment_Deposit_Custom_Parameters__c
      3. Enter: Formula Return Type: Text​
      4. Click Next
      5. Using the formula editor, determine your output value, which must be a text output in the format of: PARAM_NAME1=VALUE1&PARAM_NAME2=VALUE2&PARAM3=VALUE3
      6. Click Next and set field level security and assign to page layouts if desired. 

   2. If using a Data Type of Text

      1. Enter Field Label: Payment Custom Parameters
      2. Enter: Length: 255
      3. Enter: Field Name: Application_Fee_Custom_Parameters__c OR Enrollment_Deposit_Custom_Parameters__c
      4. Click Next and set field level security and assign to page layouts if desired.

5. Save your changes. These parameters will now be sent to the Converge Payment Gateway.

Characters to Avoid in Your Payment Custom Parameters Formula Field 

As you create your Payment Custom Parameters formula field, there are specific characters that should NOT be included in your text output. These characters are limited to the ‘&’ and ‘=’ characters. While these characters are used as concatenate (&) and equals (=) in your formula syntax, they should not be used as return values in your formula. Below are a couple of examples of correct vs. incorrect syntax.

• CORRECT: apptype=Undergraduate&program=Account and Finance&name=0000000012
• INCORRECT: apptype=Undergraduate&program=Account & Finance&name=0000000012

Setting up Ancillary ID for TOUCHNET 

1. Navigate to your Payment Connectors tab.
2. Select to Edit your Touchnet Connector.
3. (Optional step) In the Application Custom Data field, enter the API Name for the Application field you wish to use. If this field is left blank, the Ancillary ID that the system will send to Touchnet will be the type of payments the student makes, i.e., Application for Admissions or Enrollment Deposit.
4. Save your changes.

Note: There is a limit of 100 characters for Touchnet Ancillary data.

Field Level Security for Custom Response Parameters

Administrators will need to configure permissions to the Site User profile(s) which use Payments.

1. Navigate to Setup and search for Sites.
2. Click on the Site Label of the Site which uses Payments. 
3. Select the Public Access Settings button.
4. Select Edit.
5. In the “Custom Object Permissions” section, set READ access for the Payment Response Mapping object.

6. Save your changes.
7. In the “Field Level Security” section, select [View] next to the Payment Response Mapping object.
8. Set the following READ permissions:

Create a Custom Field on the Payment Detail object

A custom field will store the data returned from the Payment Vendor.

1. Navigate to Setup and select Object Manager.
2. Click the Payment Detail object.
3. In the “Custom Fields & Relationships” section, select New.
4. Enter the following:
   1. Data Type = Select of of the Text options(Text, Text Area or Text Area (Long)).
   2. Field Label = Custom Response (or another label of your choosing).
5. Select Next.
6. Select Visible for the Profile(s) used for Community Users.
7. Select Next.
8. Select to add the field to the Payment Detail Layout.
9. Save.
10. Assign READ  and EDIT permissions to this new field for your SIte User Profile.

Create a ‘Payment Response Mapping’ record

The Payment Response Mapping record maps the payment connector response parameters to the correct Payment Detail record fields.

1. Navigate to the Payment Response Mapping tab.
2. Select New.
3. Enter the following:

Select a Payment Connector.

​

4. Enter a Parameter that will be provided by your Payment Vendor. 
5. Enter a Payment Detail field. This is the API Name of the custom field you created.

Note: You can NOT map to ‘reserved fields’ as they are already in use by TargetX. Reserved fields are:

• targetx_payment__confirmation_type__c
• targetx_payment__confirmed_amount__c
• targetx_payment__confirmation_code__c
• targetx_payment__confirmation_source__c
• targetx_payment__payment_method__c
• targetx_payment__gateway_payment_ref__c

6. Save.