Syntch Gateway API

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:
Name	Parameter	Data Type	Required	Description
Keys	path	List<int>	No	A 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 .xml suffix or ?format=xml

HTTP + XML

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: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ArrayOfCustomFieldResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Gateway.RestApi.CustomFields.Responses">
  <CustomFieldResponse>
    <ActivationStatus>Pending</ActivationStatus>
    <DecimalPlaces>0</DecimalPlaces>
    <Description>String</Description>
    <DisplayOnHpp>false</DisplayOnHpp>
    <DisplayOnReports>false</DisplayOnReports>
    <DisplayOnVTReceipt>false</DisplayOnVTReceipt>
    <ErrorMessage>String</ErrorMessage>
    <IsNumeric>false</IsNumeric>
    <IsRequired>false</IsRequired>
    <Key>0</Key>
    <MaxLength>0</MaxLength>
    <MaxValue>0</MaxValue>
    <MerchantKey>0</MerchantKey>
    <MinValue>0</MinValue>
    <Name>String</Name>
    <Position>0</Position>
    <ReadOnlyOnHpp>false</ReadOnlyOnHpp>
    <RegularExpression>String</RegularExpression>
    <VisibleOnHpp>false</VisibleOnHpp>
  </CustomFieldResponse>
</ArrayOfCustomFieldResponse>