Customer management
Learn more about customer management APIs and their usage.
Guidelines
Below are some of the points you must be aware of while calling Swipez APIs:
All API responses are in JSON format.
POST requests should include
ContentType: application/json
All API response have status, message, and data.
Swipez uses API keys to allow access to the API. Once you have signed up at our merchant site, you will be able to see your AccessKey and SecretKey.
Rate limiting
The API is rate limited per user. You will receive a 429 HTTP status code if you exceed the rate limit. The rate limit is 30 requests per minute per user and is subject to change.
Quick Reference
URL
HTTP Verb
Functionality
Create customer
POST
/api/v1/merchant/customer/save
This endpoint allows you to add your customers. Download customer format JSON with below steps. 1. Go to customer structure https://www.swipez.in/merchant/customer/structure 2. Click on "Download JSON" button. 3. Choose "Save Customer V1" option.
Request Body
access_key_id
string
Your access key.
secret_access_key
string
Your secret key.
customer_code
string
Your customer unique identifier
customer_name
string
Customer name
string
Customer email id.
mobile
string
Customer mobile number.
address
string
Customer address.
city
string
Customer city.
state
string
Customer state.
zipcode
string
Customer pincode
custom_fields
array
Customer custom column value
Sample code
Update customer
POST
/api/v1/merchant/customer/update
This endpoint allows you to update your customer data. Download customer format JSON with below steps. 1. Go to customer structure https://www.swipez.in/merchant/customer/structure 2. Click on "Download JSON" button. 3. Choose "Update Customer V1" option.
Request Body
access_key_id
string
Your access key
secret_access_key
string
Your secret key.
customer_id
integer
System generated customer id.
customer_code
string
Customer unique identifier.
customer_name
string
Customer name.
string
Customer email id.
mobile
string
Customer mobile number.
address
string
Customer address.
city
string
Customer city.
state
string
Customer state.
zipcode
string
Customer zipcode.
custom_fields
string
Customer custom column value.
Sample code
Customer list
POST
/api/v1/merchant/customer/getlist
This endpoint allows you to get list of invoices.
Request Body
access_key_id
string
Your access key.
secret_access_key
string
Your secret key.
searchby
string
Filter by type (customer_code, name, email, mobile, city, state, zipcode, group)
keyword
string
Filter keyword.
Sample code
Customer detail
POST
/api/v1/merchant/customer/detail
This endpoint allows you to get detail of customer.
Request Body
access_key_id
string
Your access key.
secret_access_key
string
Your secret key.
customer_code
string
Customer code
Sample code
Last updated
Was this helpful?