Syntch Gateway API

<back to all web services

PostCustomer

Administration - Customer Management
Requires Authentication
Requires any of the roles:Reseller, Merchant
The following routes are available for this service:
POST/customersCreate a new active-status customer for a merchant
PostCustomer Parameters:
NameParameterData TypeRequiredDescription
CustomerNamemodelstringYesThe name of the customer. Cannot exceed 100 characters.
CustomerIdmodelstringNoThe ID of the customer. Cannot exceed 50 characters.
MerchantKeymodelint?NoThe merchant key for the customer. Only required for a reseller.
DefaultContactmodelContactYesThe default contact for the customer.
ShippingAddressmodelAddressNoThe shipping address for the customer. Either a shipping address, a billing address, or both are required.
BillingAddressmodelAddressNoThe billing address for the customer. Either a shipping address, a billing address, or both are required.
ActivationStatusmodelActivationStatus?YesThe customer status.

Allowable Values

  • Pending
  • Active
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
ActivationStatus Enum:
Pending
Active
Inactive
Deleted
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

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.

POST /customers HTTP/1.1 
Host: syntch.simpay.net 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"CustomerName":"String","CustomerId":"String","MerchantKey":0,"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"}},"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"},"ActivationStatus":"Pending"}

HTTP/1.1 200 OK
Content-Type: text/csv
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"}}