Get list of beneficiaries
GET {{url}}/api/v1/beneficiaries
Request Params
| Key | Datatype | Required | Description |
|---|
bank_account_number | null | | Filter on bank account number of beneficiary |
company_name | null | | Filter on company name of beneficiary |
entity_type | null | | Filter on entity type of COMPANY or PERSONAL |
from_date | null | | The start date of created_at in ISO8601 format (inclusive) |
name | null | | Filter on name of beneficiary |
nick_name | null | | Filter on nickname of beneficiary |
page_num | null | | Page number, starts from 0 |
page_size | null | | Number of results per page. Default value is 100. |
to_date | null | | The end date of created_at in ISO8601 format (inclusive) |
| Key | Datatype | Required | Description |
|---|
x-on-behalf-of | string | | |