Beneficiaries
Delete Beneficiary V3
Delete a beneficiary so it can no longer be used for new payouts.
DELETE
/
v3
/
beneficiaries
/
{beneficiary_id}
Delete Beneficiary V3
curl --request DELETE \
--url https://sandbox.api.fin.com/v3/beneficiaries/{beneficiary_id} \
--header 'Authorization: Bearer <token>'const url = 'https://sandbox.api.fin.com/v3/beneficiaries/{beneficiary_id}';
const options = {method: 'DELETE', headers: {Authorization: 'Bearer <token>'}};
fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error(err));HttpResponse<String> response = Unirest.delete("https://sandbox.api.fin.com/v3/beneficiaries/{beneficiary_id}")
.header("Authorization", "Bearer <token>")
.asString();import requests
url = "https://sandbox.api.fin.com/v3/beneficiaries/{beneficiary_id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.delete(url, headers=headers)
print(response.text)package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://sandbox.api.fin.com/v3/beneficiaries/{beneficiary_id}"
req, _ := http.NewRequest("DELETE", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}{
"message": "Deleted successfully"
}A delete cannot be undone. To use the same bank account again, create a new beneficiary with the same details.
What happens after a delete
| Area | Behavior |
|---|---|
| Beneficiary list | The beneficiary is no longer returned. |
| Beneficiary details | Fetching the beneficiary returns 404. |
| New payouts | Batch transactions and transfer payout create or settle return a validation error: beneficiary is deleted. |
| Transactions in progress | They still complete. |
| Deposits to its liquidation address | Funds are held at the address. No payout is made. |
Errors
| Status | When |
|---|---|
404 | The beneficiary does not exist, or it belongs to another client. |
422 | The beneficiary is already deleted, or beneficiary_id is not a valid UUID. |
Authorizations
Bearer token authentication. Obtain token from Issue a Token endpoint
⌘I
Delete Beneficiary V3
curl --request DELETE \
--url https://sandbox.api.fin.com/v3/beneficiaries/{beneficiary_id} \
--header 'Authorization: Bearer <token>'const url = 'https://sandbox.api.fin.com/v3/beneficiaries/{beneficiary_id}';
const options = {method: 'DELETE', headers: {Authorization: 'Bearer <token>'}};
fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error(err));HttpResponse<String> response = Unirest.delete("https://sandbox.api.fin.com/v3/beneficiaries/{beneficiary_id}")
.header("Authorization", "Bearer <token>")
.asString();import requests
url = "https://sandbox.api.fin.com/v3/beneficiaries/{beneficiary_id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.delete(url, headers=headers)
print(response.text)package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://sandbox.api.fin.com/v3/beneficiaries/{beneficiary_id}"
req, _ := http.NewRequest("DELETE", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}{
"message": "Deleted successfully"
}