Get Started
API Documentation
Document V2
Payment V2
Customer V2
Product V2
SubscriptionsV2
UtilityV2
Update a customer
curl --request PUT \
--url https://app.getswipe.in/api/partner/v2/customer \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
"customer_id": "123",
"name": "TATA RATAN",
"phone": "1234567890",
"email": "reddi@reddi.reddi",
"discount": 10,
"gstin": "27AARCS7202C1ZD",
"company_name": "GSTN",
"opening_balance": "1245",
"credit_limit": 200,
"billing_address": [
{
"addr_id": -1,
"address_line1": "",
"address_line2": "",
"pincode": "500075",
"city": "",
"state": "State Name",
"country": "India"
}
],
"shipping_address": [
{
"addr_id": -1,
"address_line1": "",
"address_line2": "",
"pincode": "500075",
"city": "",
"state": "State Name",
"country": "India"
}
],
"opening_balance_type": 1,
"dial_code": "91",
"profile_image": "",
"pan": "ABCD1234F",
"notes": "Testing api",
"cc_emails": "reddi@reddi.reddi,acb.a@bcd.con",
"status": "Active"
}'
{
"success": true,
"message": "",
"error_code": "",
"errors": {},
"data": {
"message": "No data found!"
}
}
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
Customer name
List of billing addresses
Address ID. It will automatically update the existing address if the address ID already exists.
Country. You can copy the country details from https://developers.getswipe.in/api-reference/references#country-array
Afghanistan
, Albania
, Algeria
, Andorra
, Angola
, Antigua and Barbuda
, Argentina
, Armenia
, Australia
, Austria
, Azerbaijan
, Bahamas
, Bahrain
, Bangladesh
, Barbados
, Belarus
, Belgium
, Belize
, Benin
, Bhutan
, Bolivia
, Bosnia and Herzegovina
, Botswana
, Brazil
, Brunei
, Bulgaria
, Burkina Faso
, Burundi
, Cabo Verde
, Cambodia
, Cameroon
, Canada
, Central African Republic
, Chad
, Chile
, China
, Colombia
, Comoros
, Congo, Democratic Republic of the
, Congo, Republic of the
, Costa Rica
, Croatia
, Cuba
, Cyprus
, Czechia
, Denmark
, Djibouti
, Dominica
, Dominican Republic
, Ecuador
, Egypt
, El Salvador
, Equatorial Guinea
, Eritrea
, Estonia
, Eswatini
, Ethiopia
, Fiji
, Finland
, France
, Gabon
, Gambia
, Georgia
, Germany
, Ghana
, Greece
, Grenada
, Guatemala
, Guinea
, Guinea-Bissau
, Guyana
, Haiti
, Honduras
, Hungary
, Iceland
, India
, Indonesia
, Iran
, Iraq
, Ireland
, Israel
, Italy
, Jamaica
, Japan
, Jordan
, Kazakhstan
, Kenya
, Kiribati
, Korea, North
, Korea, South
, Kosovo
, Kuwait
, Kyrgyzstan
, Laos
, Latvia
, Lebanon
, Lesotho
, Liberia
, Libya
, Liechtenstein
, Lithuania
, Luxembourg
, Madagascar
, Malawi
, Malaysia
, Maldives
, Mali
, Malta
, Marshall Islands
, Mauritania
, Mauritius
, Mexico
, Micronesia
, Moldova
, Monaco
, Mongolia
, Montenegro
, Morocco
, Mozambique
, Myanmar
, Namibia
, Nauru
, Nepal
, Netherlands
, New Zealand
, Nicaragua
, Niger
, Nigeria
, North Macedonia
, Norway
, Oman
, Pakistan
, Palau
, Palestine
, Panama
, Papua New Guinea
, Paraguay
, Peru
, Philippines
, Poland
, Portugal
, Qatar
, Romania
, Russia
, Rwanda
, Saint Kitts and Nevis
, Saint Lucia
, Saint Vincent and the Grenadines
, Samoa
, San Marino
, Sao Tome and Principe
, Saudi Arabia
, Senegal
, Serbia
, Seychelles
, Sierra Leone
, Singapore
, Slovakia
, Slovenia
, Solomon Islands
, Somalia
, South Africa
, South Sudan
, Spain
, Sri Lanka
, Sudan
, Suriname
, Sweden
, Switzerland
, Syria
, Taiwan
, Tajikistan
, Tanzania
, Thailand
, Timor-Leste
, Togo
, Tonga
, Trinidad and Tobago
, Tunisia
, Turkey
, Turkmenistan
, Tuvalu
, Uganda
, Ukraine
, United Arab Emirates
, United Kingdom
, United States
, Uruguay
, Uzbekistan
, Vanuatu
, Vatican City
, Venezuela
, Vietnam
, Yemen
, Zambia
, Zimbabwe
State. You can copy the state details from https://developers.getswipe.in/api-reference/references#state-details
JAMMU AND KASHMIR
, HIMACHAL PRADESH
, PUNJAB
, CHANDIGARH
, UTTARAKHAND
, HARYANA
, DELHI
, RAJASTHAN
, UTTAR PRADESH
, BIHAR
, SIKKIM
, ARUNACHAL PRADESH
, NAGALAND
, MANIPUR
, MIZORAM
, TRIPURA
, MEGHALAYA
, ASSAM
, WEST BENGAL
, JHARKHAND
, ODISHA
, CHHATTISGARH
, MADHYA PRADESH
, GUJARAT
, DADRA & NAGAR HAVELI & DAMAN & DIU
, MAHARASHTRA
, ANDHRAPRADESH(BEFOREADDED)
, KARNATAKA
, GOA
, LAKSHWADEEP
, KERALA
, TAMIL NADU
, PUDUCHERRY
, ANDAMAN & NICOBAR
, TELANGANA
, ANDHRA PRADESH
, LADAKH(NEWLYADDED)
, OTHER TERRITORY
Address line 1
Address line 2
City
Pincode
CC email addresses
Company name
Credit limit
Your Customer ID
Dial code
Discount
Email address
GSTIN
Notes
Opening balance
Credit[0] / Debit[1]
PAN
Phone number
Profile image URL
List of shipping addresses
Address ID. It will automatically update the existing address if the address ID already exists.
Country. You can copy the country details from https://developers.getswipe.in/api-reference/references#country-array
Afghanistan
, Albania
, Algeria
, Andorra
, Angola
, Antigua and Barbuda
, Argentina
, Armenia
, Australia
, Austria
, Azerbaijan
, Bahamas
, Bahrain
, Bangladesh
, Barbados
, Belarus
, Belgium
, Belize
, Benin
, Bhutan
, Bolivia
, Bosnia and Herzegovina
, Botswana
, Brazil
, Brunei
, Bulgaria
, Burkina Faso
, Burundi
, Cabo Verde
, Cambodia
, Cameroon
, Canada
, Central African Republic
, Chad
, Chile
, China
, Colombia
, Comoros
, Congo, Democratic Republic of the
, Congo, Republic of the
, Costa Rica
, Croatia
, Cuba
, Cyprus
, Czechia
, Denmark
, Djibouti
, Dominica
, Dominican Republic
, Ecuador
, Egypt
, El Salvador
, Equatorial Guinea
, Eritrea
, Estonia
, Eswatini
, Ethiopia
, Fiji
, Finland
, France
, Gabon
, Gambia
, Georgia
, Germany
, Ghana
, Greece
, Grenada
, Guatemala
, Guinea
, Guinea-Bissau
, Guyana
, Haiti
, Honduras
, Hungary
, Iceland
, India
, Indonesia
, Iran
, Iraq
, Ireland
, Israel
, Italy
, Jamaica
, Japan
, Jordan
, Kazakhstan
, Kenya
, Kiribati
, Korea, North
, Korea, South
, Kosovo
, Kuwait
, Kyrgyzstan
, Laos
, Latvia
, Lebanon
, Lesotho
, Liberia
, Libya
, Liechtenstein
, Lithuania
, Luxembourg
, Madagascar
, Malawi
, Malaysia
, Maldives
, Mali
, Malta
, Marshall Islands
, Mauritania
, Mauritius
, Mexico
, Micronesia
, Moldova
, Monaco
, Mongolia
, Montenegro
, Morocco
, Mozambique
, Myanmar
, Namibia
, Nauru
, Nepal
, Netherlands
, New Zealand
, Nicaragua
, Niger
, Nigeria
, North Macedonia
, Norway
, Oman
, Pakistan
, Palau
, Palestine
, Panama
, Papua New Guinea
, Paraguay
, Peru
, Philippines
, Poland
, Portugal
, Qatar
, Romania
, Russia
, Rwanda
, Saint Kitts and Nevis
, Saint Lucia
, Saint Vincent and the Grenadines
, Samoa
, San Marino
, Sao Tome and Principe
, Saudi Arabia
, Senegal
, Serbia
, Seychelles
, Sierra Leone
, Singapore
, Slovakia
, Slovenia
, Solomon Islands
, Somalia
, South Africa
, South Sudan
, Spain
, Sri Lanka
, Sudan
, Suriname
, Sweden
, Switzerland
, Syria
, Taiwan
, Tajikistan
, Tanzania
, Thailand
, Timor-Leste
, Togo
, Tonga
, Trinidad and Tobago
, Tunisia
, Turkey
, Turkmenistan
, Tuvalu
, Uganda
, Ukraine
, United Arab Emirates
, United Kingdom
, United States
, Uruguay
, Uzbekistan
, Vanuatu
, Vatican City
, Venezuela
, Vietnam
, Yemen
, Zambia
, Zimbabwe
State. You can copy the state details from https://developers.getswipe.in/api-reference/references#state-details
JAMMU AND KASHMIR
, HIMACHAL PRADESH
, PUNJAB
, CHANDIGARH
, UTTARAKHAND
, HARYANA
, DELHI
, RAJASTHAN
, UTTAR PRADESH
, BIHAR
, SIKKIM
, ARUNACHAL PRADESH
, NAGALAND
, MANIPUR
, MIZORAM
, TRIPURA
, MEGHALAYA
, ASSAM
, WEST BENGAL
, JHARKHAND
, ODISHA
, CHHATTISGARH
, MADHYA PRADESH
, GUJARAT
, DADRA & NAGAR HAVELI & DAMAN & DIU
, MAHARASHTRA
, ANDHRAPRADESH(BEFOREADDED)
, KARNATAKA
, GOA
, LAKSHWADEEP
, KERALA
, TAMIL NADU
, PUDUCHERRY
, ANDAMAN & NICOBAR
, TELANGANA
, ANDHRA PRADESH
, LADAKH(NEWLYADDED)
, OTHER TERRITORY
Address line 1
Address line 2
City
Pincode
Status
curl --request PUT \
--url https://app.getswipe.in/api/partner/v2/customer \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
"customer_id": "123",
"name": "TATA RATAN",
"phone": "1234567890",
"email": "reddi@reddi.reddi",
"discount": 10,
"gstin": "27AARCS7202C1ZD",
"company_name": "GSTN",
"opening_balance": "1245",
"credit_limit": 200,
"billing_address": [
{
"addr_id": -1,
"address_line1": "",
"address_line2": "",
"pincode": "500075",
"city": "",
"state": "State Name",
"country": "India"
}
],
"shipping_address": [
{
"addr_id": -1,
"address_line1": "",
"address_line2": "",
"pincode": "500075",
"city": "",
"state": "State Name",
"country": "India"
}
],
"opening_balance_type": 1,
"dial_code": "91",
"profile_image": "",
"pan": "ABCD1234F",
"notes": "Testing api",
"cc_emails": "reddi@reddi.reddi,acb.a@bcd.con",
"status": "Active"
}'
{
"success": true,
"message": "",
"error_code": "",
"errors": {},
"data": {
"message": "No data found!"
}
}