Syntch Gateway API

<back to all web services

GetCustomFields

Administration - Custom Field Management
Requires Authentication
Requires the role:Merchant
The following routes are available for this service:
GET/customfields/{Keys}Gets a one or more 'pending', 'active', 'inactive' or 'deleted' custom fields for the merchant requester that match the comma-separated list of keys.
GetCustomFields Parameters:
NameParameterData TypeRequiredDescription
KeyspathList<int>NoA comma-separated list of custom field keys to be returned. If no keys are specified, all applicable custom fields will be returned.

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /customfields/{Keys} HTTP/1.1 
Host: syntch.simpay.net 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
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}]