List Active Beneficiaries

Partner API

GET/v1/partner/beneficiaries

↓Download Swagger

Returns a list of all active/approved beneficiaries for the authenticated corporate tenant.

Auth

Header: x-api-key

Use the bank-provisioned partner API key for authentication.

Usage Notes

Header: x-api-key
Only returns beneficiaries in active status and approved state
Supports search, limit, and page parameters

Request Fields

searchstringoptional

Search query to filter by name or account number.

pagestringoptional

Optional page number for pagination (starts at 1).

limitstringoptional

Optional page size limit for pagination.

GET /v1/partner/beneficiaries?search=Orbit&limit=10&page=1
x-api-key: fp_test_51H8xKlMnOpQrStUv

Sample Success Response

{
  "items": [
    {
      "beneficiaryId": "ORBIT101",
      "bankTenantId": "bank_example",
      "corporateTenantId": "corp_example_01",
      "name": "Orbit Vendor Services",
      "accountNumber": "409876543210",
      "ifsc": "HDFC0001234",
      "bankName": "HDFC Bank",
      "phoneNumber": "9876543210",
      "beneficiaryType": "vendor",
      "status": "active",
      "approvalState": "approved"
    }
  ]
}

Sample Error Response

{
  "message": "Invalid API key"
}