v1

latestOpenAPI 3.0.22026-07-26123510445.2 KB

Beneficiaries

Delete Beneficiary

Delete a specific beneficiary by specifying the beneficiary_id.

post/v1/beneficiaries/{id}/delete

Path parameters

idstring uuid required

Example:b3d9d2d5-4c12-4946-a09d-953e82sed2b0

Universally unique identifier (UUID v4) of a resource.

Headers

x-on-behalf-ofstring

Specifies the sub-account on whose behalf the request is made. This should be set to the account_id, which can be retrieved via the List Connected Accounts API. If omitted or empty, the request is executed using the master account. More information at Connected Accounts.

Response

OK - Successfully delete a beneficiary.

object required