SquareECommerce
FREE
By serg.osipchuk
Updated a year ago

SquareECommerce API Documentation

Accept, process and filter online payments through Square.

Learn more about this API
POSTcaptureSingleTransaction
POSTchargeCard
POSTcreateCustomer
POSTcreateCustomerCard
POSTcreateRefund
POSTdeleteCustomerCard
POSTdeleteSingleCustomer
POSTgetAccessToken
POSTgetCustomers
POSTgetLocations
POSTgetRefunds
POSTgetSingleCustomer
POSTgetTransactions
POSTrefreshAccessToken
POSTretrieveSingleTransaction
POSTrevokeSingleAccessToken
POSTrevokeTokens
POSTupdateCustomer
POSTvoidSingleTransaction
POSTcreateCustomer

This endpoint creates a new customer for a business, which can have associated cards on file.

Header Parameters
X-RapidAPI-HostSTRING
REQUIRED
X-RapidAPI-KeySTRING
REQUIRED
Required Parameters
accessTokenSTRING
REQUIREDValid AccessToken.
Optional Parameters
addressLine3STRING
OPTIONALThe third line of the address, if any.
addressSublocalitySTRING
OPTIONALA civil region within the address's locality, if any.
givenNameSTRING
OPTIONALThe customer's given (i.e., first) name.
companyNameSTRING
OPTIONALThe name of the customer's company.
addressLine1STRING
OPTIONALThe first line of the address.
emailSTRING
OPTIONALThe customer's email address.
addressPostalCodeSTRING
OPTIONALThe address's postal code.
referenceIdSTRING
OPTIONALAn optional second ID you can set to associate the customer with an entity in another system.
addressSublocality3STRING
OPTIONALA civil region within the address's sublocality2, if any.
addressAdministrativeDistrictLevel2STRING
OPTIONALA civil entity within the address's administrative_district_level_1. In the US, this is the county.
addressLine2STRING
OPTIONALThe second line of the address, if any.
nicknameSTRING
OPTIONALA nickname for the customer.
phoneNumberSTRING
OPTIONALThe customer's phone number.
addressAdministrativeDistrictLevel1STRING
OPTIONALA civil entity within the address's country. In the US, this is the state.
noteSTRING
OPTIONALAn optional note to associate with the customer.
addressLocalitySTRING
OPTIONALThe city or town of the address.
addressAdministrativeDistrictLevel3STRING
OPTIONALA civil entity within the address's administrative_district_level_2, if any.
familyNameSTRING
OPTIONALThe customer's family (i.e., last) name.
addressSublocality2STRING
OPTIONALA civil region within the address's sublocality, if any.
addressCountrySTRING
OPTIONALThe address's country, in ISO 3166-1-alpha-2 format.
Code Snippet
Install SDK
Response ExampleSchema

Install SDK for (Node.js)Unirest

OAuth2 Authentication
Client ID
Client Secret
OAuth2 Authentication