Service Location:
For SOAP connections:
https://<assigned domain>/ws/customfields.asmx?op=AddCustomField
For standard HTTPS connections:
https://<assigned domain>/ws/customfields.asmx/AddCustomField?
Description:
This web service allows an integrator
to add custom fields programmatically to a gateway account. The data in these
fields is not passed to the processor.
Developer
Notes:
Adding
a custom field creates a new column in the Transaction Reports grid and any data
passed into this field by an integrator or in the virtual terminal will be
stored in that column and accessible through the GetCardTrx web service. To pass
data into a field an integrator must build an XML string which conforms to the
following format:
*The following example assumes that the integrator has stored 2 custom fields, one named ‘SampleFieldName1’ and the other named ‘SampleFieldName2’
<CustomFields>
<SampleFieldName1>Sample String Data</SampleFieldName1>
<SampleFieldName2>8675309</SampleFieldName2>
</CustomFields>
All data passed through the custom fields parameters will be returned in the GetCardTrx web service call following the same format.
Input Parameters:
O = Optional, R= Required, R* = Required based on dependencies
|
Parameter |
Opt/Req |
Description |
|
UserName |
R |
User name assigned in the payment server. The user must have the apporpriate security permissions in order for the system to return transaction records. |
|
Password |
R |
Password for the user name assigned in the payment server. |
|
RPNum |
R |
Unique value assigned to each gateway account used as a third credential to ensure security and Note: RPNum may also be called Merchant ID, Merchant Number, or Vendor Key. |
|
FieldName |
R |
The name of the field. This value must be unique and will be used to programmatically access the field when passing additional data using the ProcessCreditCard web service |
|
IsNumeric |
O |
This is a boolean parameter. It is only necessary to pass in a value if the integrator wishes to allow only numeric data to be passed as input values. |
|
DecimalPlaces |
O |
Integer value indicating the number of decimal places the integrator wishes this field to contain. For accurate storage of the value “2.79” the integrator would want to pass in a value of ‘2’. For accurate storage of the value “2.99999” the integrator would want to pass in a value of ‘5’. Leave this field ‘Null’ if not keeping track of numeric values |
|
MaxLength |
O |
Maximum string length allowed in the field being added. Default value is ‘25’ |
|
RegEx |
O |
Enter any regular expressions needed to validate that the values being submitted to this field conform to a specific data type and/or format |
|
IsRequired |
R |
Boolean indicating whether or not the integrator wishes this field to be required for all transactions. Valid values are ‘True’ and ‘Falese’ |
|
Description |
R |
This is the human readable description that will display in the virtual terminal and on the cardholder receipt |
|
MinValue |
O |
Minimum numeric value |
|
MaxValue |
O |
Maximum numeric value |
|
DisplayOnReceipt |
O |
This is a boolean parameter. Indicates whether or not the field will display on the cardholder receipt |