Trusted payees
List payees
Returns the logged-in identity's trusted payees that match the supplied batch and group filters.
Trusted payees are saved recipients that can be referenced by beneficiaryId in sends and outgoing wire transfers. They can't be shared between identities.
get/beneficiaries
Request
- Base URL: https://sandbox.weavr.io/multi
- URL: https://sandbox.weavr.io/multi/beneficiaries
- Auth: HTTP bearer and API key in header api-key
Query parameters
offsetinteger
The offset value for paging, indicating the initial item number to be returned from the data set satisfying the given criteria. Leave out to fetch the first page of results.
limitinteger
Example:25
The limit of the results for paging, starting at the offset. Limit is always capped at 100.
batchIdstring[]
Search by the payee batch id.
groupstring[]
Search by the payee group.
Response
Success
Example response
{
"beneficiaries": [
{
"group": "Suppliers",
"beneficiaryInformation": {
"businessName": "Acme Ltd"
},
"beneficiaryDetails": {
"instrument": {
"id": "123456789",
"type": "managed_accounts"
}
},
"id": "123456789",
"relatedOperationBatches": [
{
"batchId": "123456789",
"operation": "CREATE"
}
]
}
]
}Changes
No recorded changes to this operation across all 1 revision of this API.