Syntch Gateway API

<back to all web services

GetCustomers

Administration - Customer Management
Requires Authentication
Requires any of the roles:Reseller, Merchant
The following routes are available for this service:
GET/customersGet List Of All Customers Of A Merchant
GetCustomers Parameters:
NameParameterData TypeRequiredDescription
SortFieldquerystringNoThe field name by which the records will be sorted. Default is 'CustomerId'.

Allowable Values

  • CustomerId
  • CustomerName
  • LastName, FirstName, Email, ActivationStatus
  • MerchantKey
  • CustomerKey
IncludeDeletedqueryboolNoWhether to include deleted records in the response, defaults to false.
CustomerIdquerystringNoFilter the customer records based on a specific customer id.
CustomerNamequerystringNoFilter the customer records based on a specific customer name.
FirstNamequerystringNoFilter the customer records based on a specific contact first name.
LastNamequerystringNoFilter the customer records based on a specific contact last name.
EmailquerystringNoFilter the customer records based on a specific contact email address.
CustomerKeyqueryint?NoFilter the customer records based on a specific customer key.
MerchantKeyqueryint?NoFilter the customer records based on a specific merchant key.
SortedRequestDto Parameters:
NameParameterData TypeRequiredDescription
SortDirectionquerystringNoThe direction in which the records will be sorted. Default is 'asc'.

Allowable Values

  • Asc
  • Desc
SortFieldquerystringNoThe field name by which the records will be sorted.
PaginatedRequestDto Parameters:
NameParameterData TypeRequiredDescription
PageSizequeryshortNoThe number of records per page. Default is 20.
PageNumberqueryshortNoThe page number to fetch. Default is 1.
CustomerDetail Parameters:
NameParameterData TypeRequiredDescription
CustomerKeymodelintNoUnique identifier generated by the system for the customer
CustomerIDmodelstringYesUnique identifier, assigned by the merchant, as a friendly way to identify the customer
CustomerNamemodelstringNoCustomer's full name. Can be first+last name for an individual, or the business name if applicable.
ActivationStatusmodelActivationStatus?YesIndicates 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
MerchantKeymodelint?YesThe merchant key for the customer
CreationTimestampformDateTimeNoCustomer creation timestamp.
LastUpdateTimestampformDateTimeNoLast customer update timestamp.
DefaultContactmodelContactNoThe link to this customer's default contact
BillingAddressmodelBillingAddressNoThe link to this customer's billing address
ShippingAddressmodelShippingAddressNoThe link to this customer's shipping address
ActivationStatus Enum:
Pending
Active
Inactive
Deleted
Contact Parameters:
NameParameterData TypeRequiredDescription
LastNamemodelstringNoThe last name, max 50 chars
FirstNamemodelstringNoThe first name, max 50 chars
JobTitlemodelstringNoThe job title, max 50 chars
DepartmentNamemodelstringNoThe department name, max 50 chars
EmailAddressmodelstringNoThe e-mail address, max 100 chars
DaytimeTelephoneNumbermodelstringNoThe daytime telephone number, max 25 chars
NighttimeTelephoneNumbermodelstringNoThe nighttime telephone number, max 25 chars
FaxNumbermodelstringNoThe fax number, max 25 chars
MobileTelephoneNumbermodelstringNoThe mobile telephone number, max 25 chars
BillingAddressmodelAddressNoBilling address for the primary contact.
ShippingAddressmodelAddressNoShipping address for the primary contact
Address Parameters:
NameParameterData TypeRequiredDescription
StreetAddress1modelstringYesThe street address, max 50 chars
StreetAddress2modelstringNoThe street address 2, max 50 chars
StreetAddress3modelstringNoThe street address 3, max 50 chars
CitymodelstringNoThe city, max 50 chars
StateOrProvinceCodemodelstringYesThe 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
PostalCodemodelstringYesThe postal code, max 30 chars
CountryCodemodelstringYesThe 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 .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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/json

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

{"CustomerKey":0,"CustomerID":"String","CustomerName":"String","ActivationStatus":"Pending","MerchantKey":0,"CreationTimestamp":"0001-01-01T00:00:00.0000000","LastUpdateTimestamp":"0001-01-01T00:00:00.0000000","DefaultContact":{"LastName":"String","FirstName":"String","JobTitle":"String","DepartmentName":"String","EmailAddress":"String","DaytimeTelephoneNumber":"String","NighttimeTelephoneNumber":"String","FaxNumber":"String","MobileTelephoneNumber":"String","BillingAddress":{"StreetAddress1":"String","StreetAddress2":"String","StreetAddress3":"String","City":"String","StateOrProvinceCode":"String","PostalCode":"String","CountryCode":"String"},"ShippingAddress":{"StreetAddress1":"String","StreetAddress2":"String","StreetAddress3":"String","City":"String","StateOrProvinceCode":"String","PostalCode":"String","CountryCode":"String"}},"BillingAddress":{"StreetAddress1":"String","StreetAddress2":"String","StreetAddress3":"String","City":"String","StateOrProvinceCode":"String","PostalCode":"String","CountryCode":"String"},"ShippingAddress":{"StreetAddress1":"String","StreetAddress2":"String","StreetAddress3":"String","City":"String","StateOrProvinceCode":"String","PostalCode":"String","CountryCode":"String"}}