Contacts

A contact is an entity to whom payouts can be made through supported modes such as UPI, IMPS, NEFT, RTGS, etc.

Create a Contact#

The below API endpoint creates a contact.

/contacts

A sample request and response to create a contact is provided on the right.

Request Parameters#

name Mandatory
Data type string. Name of the contact, for example, Gaurav Kumar.
email Optional
Data type string. Email address for the contact, for example, gaurav.kumar@example.com.
contact Optional
Data type number. Phone number for the contact, for example, 9123456789.
type Mandatory
Data type string. The classification of contact that is being created, for example, employee. The following classifications are available in the system by default:

- vendor

- customer

- employee

- self

Note:
Additional classifications can be created via the dashboard and then used in the API. However, it is not possible to create new classifications via the API.
reference_id Optional
Data type string. A user-generated reference given to the contact, for example, Acme Contact ID 12345. This field can have a maximum length of 40 characters.
note Optional
Data type object. This is a key-value pair dictionary, for example,"note_key": "Beam me up Scotty".

Update a Contact#

The below API endpoint updates a contact.

/contacts/:id

A sample request and response to update a contact is provided on the right.

Request Parameters#

name Mandatory
Data type string. Name of the contact, for example, Gaurav Kumar.
email Optional
Data type string. Email address for the contact, for example, gaurav.kumar@example.com.
contact Optional
Data type number. Phone number for the contact, for example, 9123456789.
type Mandatory
Data type string. The classification of contact that is being created, employee. The following classifications are available in the system by default:

- vendor

- customer

- employee

- self

Note:
Additional classifications can be created via the dashboard and then used in the API. However, it is not possible to create new classifications via the API.
reference_id Optional
Data type string. A user-generated reference given to the contact, for example, Acme Contact ID 12345. This field can have a maximum length of 40 characters.
note Optional
Data type object. This is a key-value pair dictionary, for example,"note_key": "Beam me up Scotty".

Activate or Deactivate a Contact#

The below API endpoint activates or deactivates a contact.

/contacts/:id

A sample request and response to deactivate a contact is provided on the right.

Path Parameters#

id Mandatory
Data type string. The unique ID linked to the contact, for example, cont_00000000000001.

Request Parameters#

active Mandatory
Data type string. Represents the state you want to move the contact. A contact can have the following two states:

- true = active

- false = inactive

Pass false to deactivate an active contact and pass true to activate a deactivated contact.

Fetch a Contact by ID#

The below API end point returns the details of the required Contact.

/contacts/:id

An example request and response to fetch the details of the required contact is provided on the right.

Path Parameters#

id Mandatory
Data type string. This is the unique ID linked to a contact, for example, cont_00000000000001.

Fetch all Contacts#

The below API end point returns the details of all contacts in the system.

/contacts

An example request and response to fetch details of all contacts in the system is provided on the right.

Query Parameters#

name Optional
Data type string. Name of the contact, for example, Gaurav Kumar.
email Optional
Data type string. Email address for the contact, for example, gaurav.kumar@example.com.
contact Optional
Data type number. Phone number for the contact, for example, 9123456789.
reference_id Optional
Data type string. A user-generated reference given to the contact, for example, Acme Contact ID 12345. This field can have a maximum length of 40 characters.
fund_account_id Optional
Data type string. This is the unique ID linked to a fund account, for example, fa_00000000000001.
active Optional
Data type string. Represents the current state of the fund account. A fund account can have the following two states:

- true = active

- false = inactive
type Optional
Data type string. The classification of contact that is being created, for example, employee. The following classifications are available in the system by default:

- vendor

- customer

- employee

- self

Note:
Additional classifications can be created via the dashboard and then used in the API. However, it is not possible to create new classifications via the API.