Delete a Beneficiary
Soft-deletes a beneficiary. The record is removed from active listings and can no longer be used to initiate new payouts. Historical payouts referencing this beneficiary remain unchanged and accessible.
Archiving is typically preferred over deletion — see
POST /v1/beneficiaries/{id}/archive. Archiving preserves the beneficiary
in a disabled state that can be restored later.
Authorizations
Per-request DPoP proof JWT (RFC 9449). MUST accompany the Authorization: DPoP <access_token> header on every protected operation. The proof is signed by the merchant's private DPoP key and carries htm, htu, iat, jti, and ath claims.
Headers
Unique key identifying this operation. Sending the same key twice returns the original response instead of creating a duplicate. Keys are retained for 24 hours.
255Path Parameters
Beneficiary ID (prefixed ben_).
^ben_[a-zA-Z0-9]+$"ben_01HX8Z9K0M2N3P4Q5R6S7T8UA1"
Response
Beneficiary deleted.