Get a customer

GET

customer

{customer_id}

curl --request GET \
  --url https://app.getswipe.in/api/partner/v1/customer/{customer_id} \
  --header 'Authorization: <api-key>'

{
  "success": true,
  "customer_details": {
    "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": [
      {
        "address_line1": "",
        "address_line2": "",
        "pincode": "500075",
        "city": "",
        "state": "State Name",
        "country": "India"
      }
    ],
    "shipping_address": [
      {
        "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"
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

customer_id

string

required

The customer ID to be fetched

Response

200

application/json

Success

success

boolean

Success flag

Example:

true

customer_details

object

customer_details.name

string

required

Customer name

Example:

"TATA RATAN"

customer_details.customer_id

string

Your Customer ID

Example:

"123"

customer_details.phone

string

Phone number

Example:

"1234567890"

customer_details.email

string

Email address

Example:

"reddi@reddi.reddi"

customer_details.discount

integer

Discount

Example:

10

customer_details.gstin

string

GSTIN

Example:

"27AARCS7202C1ZD"

customer_details.company_name

string

Company name

Example:

"GSTN"

customer_details.opening_balance

string

Opening balance

Example:

"1245"

customer_details.credit_limit

integer

Credit limit

Example:

200

customer_details.billing_address

object[]

List of billing addresses

customer_details.billing_address.state

enum<string>

required

State. You can copy the state details from https://developers.getswipe.in/api-reference/references#state-details

Available options:

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

Example:

"State Name"

customer_details.billing_address.address_line1

string

Address line 1

Example:

""

customer_details.billing_address.address_line2

string

Address line 2

Example:

""

customer_details.billing_address.pincode

string

Pincode

Example:

"500075"

customer_details.billing_address.city

string

City

Example:

""

customer_details.billing_address.country

enum<string>

Country. You can copy the country details from https://developers.getswipe.in/api-reference/references#country-array

Available options:

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

Example:

"India"

customer_details.shipping_address

object[]

List of shipping addresses

customer_details.shipping_address.state

enum<string>

required

State. You can copy the state details from https://developers.getswipe.in/api-reference/references#state-details

Available options:

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

Example:

"State Name"

customer_details.shipping_address.address_line1

string

Address line 1

Example:

""

customer_details.shipping_address.address_line2

string

Address line 2

Example:

""

customer_details.shipping_address.pincode

string

Pincode

Example:

"500075"

customer_details.shipping_address.city

string

City

Example:

""

customer_details.shipping_address.country

enum<string>

Country. You can copy the country details from https://developers.getswipe.in/api-reference/references#country-array

Available options:

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

Example:

"India"

customer_details.opening_balance_type

integer

Credit[0] / Debit[1]

Example:

1

customer_details.dial_code

string

Dial code

Example:

"91"

customer_details.profile_image

string

Profile image URL

Example:

""

customer_details.pan

string

PAN

Example:

"ABCD1234F"

customer_details.notes

string

Notes

Example:

"Testing api"

customer_details.cc_emails

string

CC email addresses

Example:

"reddi@reddi.reddi,acb.a@bcd.con"

customer_details.status

string

Status

Example:

"Active"

Add a customer Update a customer

curl --request GET \
  --url https://app.getswipe.in/api/partner/v1/customer/{customer_id} \
  --header 'Authorization: <api-key>'

{
  "success": true,
  "customer_details": {
    "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": [
      {
        "address_line1": "",
        "address_line2": "",
        "pincode": "500075",
        "city": "",
        "state": "State Name",
        "country": "India"
      }
    ],
    "shipping_address": [
      {
        "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"
  }
}

Get Started

Document

Payment

Customer

Product

Subscriptions

Utility

EwayBill

Get a customer

Authorizations

Path Parameters

Response