| Requires the role: | Merchant |
| GET | /customfields | Gets a collection of 'pending', 'active' and 'inactive' and possibly 'deleted' custom fields for the merchant requester. |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| IncludeDeleted | query | bool | No | Whether to include deleted records in the response, defaults to false. |
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /customfields HTTP/1.1 Host: syntch.simpay.net Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
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}]