JIjiopay
Customers

Create a new customer

Creates a customer with basic information such as name, contact information, and address.

post/api/v1/customer

Request

  • Base URL
    https://api.crossborder.jiopay.co.in
  • URL
    https://api.crossborder.jiopay.co.in/api/v1/customer
  • Auth
    HTTP bearer

Request body

namestring required

The name of the customer.

customer_type'individual' | 'business' required

The type of customer

emailstring required

The email address of the customer.

phonestring

The phone number of the customer, with country code. Phone number validation is done using the phonelib library.

dobstring

The date of birth of the customer

nationalitystring

The nationality of the customer

tax_identification_numberstring

Applicable only to the LRS (Liberalised Remittance Scheme / resident-India remittance) flow. The customer's PAN (tax identification number), populated only for customers onboarded under LRS and absent otherwise. Searchable via the tax_identification_number query parameter on the list-customers endpoint.

addressstring required

The street address of the customer.

citystring required

The city where the customer is located.

statestring required

The state where the customer is located.

countrystring required

The country where the customer is located. Country should be sent as an ISO 3166-1 alpha-3 code.

pincodestring

The postal code/pincode of the customer's address. See the list of countries where pincode is mandatory.

Example request

{
  "name": "John Doe",
  "email": "customer@gmail.com",
  "phone": "+91-9023456789",
  "dob": "2003-11-29",
  "nationality": "IND",
  "tax_identification_number": "BFQPG7654R",
  "address": "123 Main St",
  "city": "Anytown",
  "state": "Anystate",
  "country": "IND",
  "pincode": "560048"
}

Response

Customer created successfully

idstring

The unique identifier for the customer.

namestring

The name of the customer.

customer_type'individual' | 'business'

The type of customer

emailstring email

The email address of the customer.

phonestring

The phone number of the customer, with country code. Phone number validation is done using the phonelib library.

dobstring

The date of birth of the customer

nationalitystring

The nationality of the customer

tax_identification_numberstring

Applicable only to the LRS (Liberalised Remittance Scheme / resident-India remittance) flow. The customer's PAN (tax identification number), populated only for customers onboarded under LRS and absent otherwise. Searchable via the tax_identification_number query parameter on the list-customers endpoint.

addressstring

The street address of the customer.

citystring

The city where the customer is located.

statestring

The state where the customer is located.

countrystring iso-3166-1-alpha-3

The country where the customer is located. Country should be sent as an ISO 3166-1 alpha-3 code.

pincodestring

The postal code/pincode of the customer's address. See the list of countries where pincode is mandatory.

statusstring

The status of the customer.

created_atstring timestamp

Timestamp representing when the customer was created

updated_atstring timestamp

Timestamp representing when the customer was last updated

Example response

{
  "id": "cust_5JU9yv0lGSUP",
  "name": "John Doe",
  "email": "customer@gmail.com",
  "phone": "+91-9023456789",
  "dob": "2003-11-29",
  "nationality": "IND",
  "tax_identification_number": "BFQPG7654R",
  "address": "123 Main St",
  "city": "Anytown",
  "state": "Anystate",
  "country": "IND",
  "pincode": "560048",
  "status": "active",
  "created_at": "2021-06-01T12:00:00Z",
  "updated_at": "2021-06-01T12:00:00Z"
}

Changes

No recorded changes to this operation across all 1 revision of this API.