Beneficiaries
Untrust a list of beneficiaries
OAuth scope: payment.write
Untrust an array of beneficiaries. Max number of IDs is 400.
When there is a 422 error, the easiest way to identify which ID in the list is the invalid one, look at the errors[x].source.pointer. The structure of the pointer will be the root key which will always be beneficiaries, followed by the index of the ID in the list. For example, if in the array of IDs ["abc", "xyz"] the first ID cannot be found the pointer will be /beneficiaries/0/id.
patch/v2/beneficiaries/untrust
Headers
X-Qonto-Staging-Tokenstring
Required only for Sandbox API requests; to get one, please submit the following form: https://getqonto.atlassian.net/servicedesk/customer/portal/5/group/47/create/143.
Request body
Example request
{
"ids": [
"921c60fc-df0e-4289-a864-38a438ad2366"
]
}Response
returns the updated beneficiaries
Example response
{
"beneficiaries": [
{
"id": "ce91bc4e-68d6-4ab0-bfab-4a9403f7f316",
"name": "Alice In Wonderland",
"status": "validated",
"created_at": "2021-01-27T22:05:07.000Z",
"updated_at": "2021-01-27T22:05:07.000Z"
}
]
}