List Bank Beneficiaries
Get a list of bank beneficiaries filtered by various params.
get/bank-beneficiaries
Request
- Base URLhttps://sandbox.openpayd.com/api
- URLhttps://sandbox.openpayd.com/api/bank-beneficiaries
- AuthAPI key in header Authorization
Query parameters
parentBeneficiaryIdsstring[]
Array of id (UUID) from the create beneficiary request for the parent beneficiary under who the bank beneficiary was created.
currencyIncludingstring[]
Three-letter ISO 4217 currency codes of the bank beneficiaries to include in the search. e.g. EUR,GBP
currencyExcludingstring[]
Three-letter ISO 4217 currency codes of the bank beneficiaries to exclude from the search. e.g. EUR,GBP
searchstring
Search the name of the bank beneficiary.
pageinteger
sizeinteger
sortstring
Sort by a parameter on the object. e.g. status
Response
200
Changes
No recorded changes to this operation across all 1 revision of this API.