| Requires the role: | Merchant |
| POST | /customfields | Creates a new custom field that can be either 'pending' or 'active'. |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Name | model | string | Yes | The name of the custom field. Cannot exceed 50 characters. Should be unique. |
| IsNumeric | model | bool? | Yes | Indicates the IsNumeric value for the field. |
| ActivationStatus | model | ActivationStatus? | Yes | Indicates the initial activation status value for the field.Allowable Values
|
| DecimalPlaces | model | int? | No | Indicates the number of decimal places for the field (used with numeric fields). |
| RegularExpression | model | string | No | Indicates the regular expression value for the field. |
| IsRequired | model | bool? | No | Indicates if the field is required. |
| Description | model | string | No | Indicates the description value for the field. Cannot exceed 50 characters. |
| ErrorMessage | model | string | No | Indicates the error message value for the field. Cannot exceed 50 characters. |
| MinValue | model | double? | No | Indicates the minimum numeric value for the field (used with numeric fields). |
| MaxValue | model | double? | No | Indicates the minimum numeric value for the field (used with numeric fields). |
| MaxLength | model | int? | No | Indicates the maximum text length value for the field (used with non-numeric fields). |
| Position | model | int? | No | Indicates the position value for the field. |
| DisplayOnVTReceipt | model | bool? | No | Indicates if the field should be displayed on virtual terminal receipt. |
| DisplayOnReports | model | bool? | No | Indicates if the field should be displayed on reports. |
| DisplayOnHpp | model | bool? | No | Indicates if the field should be displayed on the hosted payments page. |
| ReadOnlyOnHpp | model | bool? | No | Indicates if the field should not be editable on the hosted payments page. |
| VisibleOnHpp | model | bool? | No | Indicates if the field should be visible on the hosted payments page. |
| Pending | |
| Active | |
| Inactive | |
| Deleted |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Key | model | int | No | The unique identifier of the custom field. |
| Name | model | string | No | The name of the custom field. Cannot exceed 50 characters. Should be unique. |
| MerchantKey | model | int | No | The key of the merchant that has this custom field. |
| IsNumeric | model | bool | No | Indicates if the field is numeric. |
| DecimalPlaces | model | int? | No | Indicates the number of decimal places. |
| RegularExpression | model | string | No | A validation expression. |
| IsRequired | model | bool? | No | Indicates if the field should be required input. |
| ActivationStatus | model | ActivationStatus | No | Indicates the activation status of the field.Allowable Values
|
| Description | model | string | No | The description of the field. |
| ErrorMessage | model | string | No | Indicates the validation error message of the field. |
| MinValue | model | double? | No | Indicates the minimum numeric value of the field. |
| MaxValue | model | double? | No | Indicates the maximum numeric value of the field. |
| MaxLength | model | int? | No | Indicates the maximum character length of the field. |
| Position | model | int | No | Indicates the position the field, relative to other custom fields being displayed. |
| DisplayOnVTReceipt | model | bool? | No | Indicates if the field is displayed on VT receipts. |
| DisplayOnReports | model | bool? | No | Indicates if the field is displayed on reports. |
| DisplayOnHpp | model | bool? | No | Indicates if the field is displayed on the HPP. |
| ReadOnlyOnHpp | model | bool? | No | Indicates if the field is read-only on the HPP. |
| VisibleOnHpp | model | bool? | No | Indicates if the field is visible on the HPP. |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /customfields HTTP/1.1
Host: syntch.simpay.net
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
Name: String,
IsNumeric: False,
ActivationStatus: Pending,
DecimalPlaces: 0,
RegularExpression: String,
IsRequired: False,
Description: String,
ErrorMessage: String,
MinValue: 0,
MaxValue: 0,
MaxLength: 0,
Position: 0,
DisplayOnVTReceipt: False,
DisplayOnReports: False,
DisplayOnHpp: False,
ReadOnlyOnHpp: False,
VisibleOnHpp: False
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
Key: 0,
Name: String,
MerchantKey: 0,
IsNumeric: False,
DecimalPlaces: 0,
RegularExpression: String,
IsRequired: False,
ActivationStatus: Pending,
Description: String,
ErrorMessage: String,
MinValue: 0,
MaxValue: 0,
MaxLength: 0,
Position: 0,
DisplayOnVTReceipt: False,
DisplayOnReports: False,
DisplayOnHpp: False,
ReadOnlyOnHpp: False,
VisibleOnHpp: False
}