List of Beneficiaries

This API retrieves the list of all beneficiaries added by the user on the platform.

The response includes key beneficiary details such as:

  • Beneficiary (account) name
  • Bank name and payment rail
  • Account number
  • Recipient country
  • Recipient type (Individual or Business)

The results can be filtered by beneficiary type and search keywords, allowing users to easily manage and locate beneficiaries. These beneficiaries can be selected for payout or transfer transactions.

Query Params
integer
enum
Allowed:
string
enum
Allowed:
integer
enum
Allowed:
string
string
Defaults to IND

ISO alpha code - 3

string
Defaults to INR
Headers
string
required

Identifies the merchant making the request.

string
required

Public API key associated with the merchant.

string
required

RSA signature generated from the HMAC hash of the request payload.

string
required

Current UNIX timestamp (in seconds). Used to prevent replay attacks.

string
required

Unique UUID per request

Response

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json