Syntch Gateway API

GetCustomers

Administration - Customer Management

**Requires Authentication**
Requires any of the roles:	Reseller, Merchant

The following routes are available for this service:
GET	/customers	Get List Of All Customers Of A Merchant

**GetCustomers** Parameters:
Name	Parameter	Data Type	Required	Description
SortField	query	string	No	The field name by which the records will be sorted. Default is 'CustomerId'. Allowable Values CustomerId CustomerName LastName, FirstName, Email, ActivationStatus MerchantKey CustomerKey
IncludeDeleted	query	bool	No	Whether to include deleted records in the response, defaults to false.
CustomerId	query	string	No	Filter the customer records based on a specific customer id.
CustomerName	query	string	No	Filter the customer records based on a specific customer name.
FirstName	query	string	No	Filter the customer records based on a specific contact first name.
LastName	query	string	No	Filter the customer records based on a specific contact last name.
Email	query	string	No	Filter the customer records based on a specific contact email address.
CustomerKey	query	int?	No	Filter the customer records based on a specific customer key.
MerchantKey	query	int?	No	Filter the customer records based on a specific merchant key.

**SortedRequestDto** Parameters:
Name	Parameter	Data Type	Required	Description
SortDirection	query	string	No	The direction in which the records will be sorted. Default is 'asc'. Allowable Values Asc Desc
SortField	query	string	No	The field name by which the records will be sorted.

**PaginatedRequestDto** Parameters:
Name	Parameter	Data Type	Required	Description
PageSize	query	short	No	The number of records per page. Default is 20.
PageNumber	query	short	No	The page number to fetch. Default is 1.

**CustomerDetail** Parameters:
Name	Parameter	Data Type	Required	Description
CustomerKey	model	int	No	Unique identifier generated by the system for the customer
CustomerID	model	string	Yes	Unique identifier, assigned by the merchant, as a friendly way to identify the customer
CustomerName	model	string	No	Customer's full name. Can be first+last name for an individual, or the business name if applicable.
ActivationStatus	model	ActivationStatus?	Yes	Indicates whether the customer is currently active or inactive. Valid values are: 1: ACTIVE – Customers contracts are reviewed each day for pending payments 2: INACTIVE – Customer is not reviewed for pending payments
MerchantKey	model	int?	Yes	The merchant key for the customer
CreationTimestamp	form	DateTime	No	Customer creation timestamp.
LastUpdateTimestamp	form	DateTime	No	Last customer update timestamp.
DefaultContact	model	Contact	No	The link to this customer's default contact
BillingAddress	model	BillingAddress	No	The link to this customer's billing address
ShippingAddress	model	ShippingAddress	No	The link to this customer's shipping address

**ActivationStatus** Enum:
Pending
Active
Inactive
Deleted

**Contact** Parameters:
Name	Parameter	Data Type	Required	Description
LastName	model	string	No	The last name, max 50 chars
FirstName	model	string	No	The first name, max 50 chars
JobTitle	model	string	No	The job title, max 50 chars
DepartmentName	model	string	No	The department name, max 50 chars
EmailAddress	model	string	No	The e-mail address, max 100 chars
DaytimeTelephoneNumber	model	string	No	The daytime telephone number, max 25 chars
NighttimeTelephoneNumber	model	string	No	The nighttime telephone number, max 25 chars
FaxNumber	model	string	No	The fax number, max 25 chars
MobileTelephoneNumber	model	string	No	The mobile telephone number, max 25 chars
BillingAddress	model	Address	No	Billing address for the primary contact.
ShippingAddress	model	Address	No	Shipping address for the primary contact

**Address** Parameters:
Name	Parameter	Data Type	Required	Description
StreetAddress1	model	string	Yes	The street address, max 50 chars
StreetAddress2	model	string	No	The street address 2, max 50 chars
StreetAddress3	model	string	No	The street address 3, max 50 chars
City	model	string	No	The city, max 50 chars
StateOrProvinceCode	model	string	Yes	The CHAR-2 USA state and CAN province codes Allowable Values AK AL AR AZ CA CO CT DC DE FL GA HI IA ID IL IN KS KY LA MA MD ME MI MN MO MS MT NC ND NE NH NJ NM NV NY OH OK OR PA RI SC SD TN TX UT VA VT WA WI WV WY AB BC MB NB NL NS NT NU ON PE QC SK YT
PostalCode	model	string	Yes	The postal code, max 30 chars
CountryCode	model	string	Yes	The ISO Alpha-3 USA or CAN country codes Allowable Values USA CAN

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 /customers HTTP/1.1 
Host: syntch.simpay.net 
Accept: application/xml

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

<CustomerDetail xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Gateway.RestApi.Customers.BindingModels">
  <ActivationStatus>Pending</ActivationStatus>
  <BillingAddress xmlns:d2p1="http://schemas.datacontract.org/2004/07/Gateway.RestApi.Common.DTO">
    <d2p1:City>String</d2p1:City>
    <d2p1:CountryCode>String</d2p1:CountryCode>
    <d2p1:PostalCode>String</d2p1:PostalCode>
    <d2p1:StateOrProvinceCode>String</d2p1:StateOrProvinceCode>
    <d2p1:StreetAddress1>String</d2p1:StreetAddress1>
    <d2p1:StreetAddress2>String</d2p1:StreetAddress2>
    <d2p1:StreetAddress3>String</d2p1:StreetAddress3>
  </BillingAddress>
  <CreationTimestamp>0001-01-01T00:00:00</CreationTimestamp>
  <CustomerID>String</CustomerID>
  <CustomerKey>0</CustomerKey>
  <CustomerName>String</CustomerName>
  <DefaultContact xmlns:d2p1="http://schemas.datacontract.org/2004/07/Gateway.RestApi.Common.DTO">
    <d2p1:BillingAddress>
      <d2p1:City>String</d2p1:City>
      <d2p1:CountryCode>String</d2p1:CountryCode>
      <d2p1:PostalCode>String</d2p1:PostalCode>
      <d2p1:StateOrProvinceCode>String</d2p1:StateOrProvinceCode>
      <d2p1:StreetAddress1>String</d2p1:StreetAddress1>
      <d2p1:StreetAddress2>String</d2p1:StreetAddress2>
      <d2p1:StreetAddress3>String</d2p1:StreetAddress3>
    </d2p1:BillingAddress>
    <d2p1:DaytimeTelephoneNumber>String</d2p1:DaytimeTelephoneNumber>
    <d2p1:DepartmentName>String</d2p1:DepartmentName>
    <d2p1:EmailAddress>String</d2p1:EmailAddress>
    <d2p1:FaxNumber>String</d2p1:FaxNumber>
    <d2p1:FirstName>String</d2p1:FirstName>
    <d2p1:JobTitle>String</d2p1:JobTitle>
    <d2p1:LastName>String</d2p1:LastName>
    <d2p1:MobileTelephoneNumber>String</d2p1:MobileTelephoneNumber>
    <d2p1:NighttimeTelephoneNumber>String</d2p1:NighttimeTelephoneNumber>
    <d2p1:ShippingAddress>
      <d2p1:City>String</d2p1:City>
      <d2p1:CountryCode>String</d2p1:CountryCode>
      <d2p1:PostalCode>String</d2p1:PostalCode>
      <d2p1:StateOrProvinceCode>String</d2p1:StateOrProvinceCode>
      <d2p1:StreetAddress1>String</d2p1:StreetAddress1>
      <d2p1:StreetAddress2>String</d2p1:StreetAddress2>
      <d2p1:StreetAddress3>String</d2p1:StreetAddress3>
    </d2p1:ShippingAddress>
  </DefaultContact>
  <LastUpdateTimestamp>0001-01-01T00:00:00</LastUpdateTimestamp>
  <MerchantKey>0</MerchantKey>
  <ShippingAddress xmlns:d2p1="http://schemas.datacontract.org/2004/07/Gateway.RestApi.Common.DTO">
    <d2p1:City>String</d2p1:City>
    <d2p1:CountryCode>String</d2p1:CountryCode>
    <d2p1:PostalCode>String</d2p1:PostalCode>
    <d2p1:StateOrProvinceCode>String</d2p1:StateOrProvinceCode>
    <d2p1:StreetAddress1>String</d2p1:StreetAddress1>
    <d2p1:StreetAddress2>String</d2p1:StreetAddress2>
    <d2p1:StreetAddress3>String</d2p1:StreetAddress3>
  </ShippingAddress>
</CustomerDetail>

Syntch Gateway API

GetCustomers

Allowable Values

Allowable Values

Allowable Values

Allowable Values

HTTP + XML