JIjiopay
Customers

List all customers

Returns a list of your customers. The customers are returned sorted by creation date, with the most recent customers appearing first.

get/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

Query parameters

customer_type'individual' | 'business'

The type of customer

Type of customer to filter

email_addressstring

Filter customers by email address

tax_identification_numberstring

Applicable only to the LRS (Liberalised Remittance Scheme / resident-India remittance) flow. Filter customers by PAN (tax identification number). Matched exactly on the normalised value (case-insensitive; the value is trimmed and upper-cased before matching), so a partial PAN returns no results. An invalid PAN format returns a 400 error.

beforestring
Example:2025-02-18T12:03:44Z

ISO-8601 timestamp in UTC to filter resources created before this time. Use this to avoid the page drift issue. See Pagination parameters for more details.

afterstring
Example:2025-01-18T12:03:44Z

ISO-8601 timestamp in UTC to filter resources created after this time. Use this to avoid the page drift issue. See Pagination parameters for more details.

per_pageinteger
Example:20

Number of resources per page. Should be between 1 and 100.

pageinteger
Example:1

Page number for pagination. Starts from 1. Get the next page number from the next field in the response.

Response

OK

Example response

{
  "data": [
    {
      "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"
    }
  ],
  "page_meta": {
    "current": 2,
    "previous": 1,
    "next": 3,
    "per_page": 20,
    "pages": 10,
    "count": 200
  }
}

Changes

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