Update Beneficiary Active Status
curl --request PATCH \
--url https://sandbox.api.fin.com/v1/beneficiaries \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"beneficiary_id": "f653e109-6c62-4aa4-869c-418c874e0a6c",
"active": true
}
'const url = 'https://sandbox.api.fin.com/v1/beneficiaries';
const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({beneficiary_id: 'f653e109-6c62-4aa4-869c-418c874e0a6c', active: true})
};
fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error(err));HttpResponse<String> response = Unirest.patch("https://sandbox.api.fin.com/v1/beneficiaries")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"beneficiary_id\": \"f653e109-6c62-4aa4-869c-418c874e0a6c\",\n \"active\": true\n}")
.asString();import requests
url = "https://sandbox.api.fin.com/v1/beneficiaries"
payload = {
"beneficiary_id": "f653e109-6c62-4aa4-869c-418c874e0a6c",
"active": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://sandbox.api.fin.com/v1/beneficiaries"
payload := strings.NewReader("{\n \"beneficiary_id\": \"f653e109-6c62-4aa4-869c-418c874e0a6c\",\n \"active\": true\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}{
"data": {
"message": "Beneficiary updated successfully"
}
}{
"message": "Authentication failed"
}{
"message": "<string>",
"errors": [
{}
]
}Beneficiaries
Update Beneficiary Active Status
Update the active status of a beneficiary to enable or disable it
PATCH
/
v1
/
beneficiaries
Update Beneficiary Active Status
curl --request PATCH \
--url https://sandbox.api.fin.com/v1/beneficiaries \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"beneficiary_id": "f653e109-6c62-4aa4-869c-418c874e0a6c",
"active": true
}
'const url = 'https://sandbox.api.fin.com/v1/beneficiaries';
const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({beneficiary_id: 'f653e109-6c62-4aa4-869c-418c874e0a6c', active: true})
};
fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error(err));HttpResponse<String> response = Unirest.patch("https://sandbox.api.fin.com/v1/beneficiaries")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"beneficiary_id\": \"f653e109-6c62-4aa4-869c-418c874e0a6c\",\n \"active\": true\n}")
.asString();import requests
url = "https://sandbox.api.fin.com/v1/beneficiaries"
payload = {
"beneficiary_id": "f653e109-6c62-4aa4-869c-418c874e0a6c",
"active": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://sandbox.api.fin.com/v1/beneficiaries"
payload := strings.NewReader("{\n \"beneficiary_id\": \"f653e109-6c62-4aa4-869c-418c874e0a6c\",\n \"active\": true\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}{
"data": {
"message": "Beneficiary updated successfully"
}
}{
"message": "Authentication failed"
}{
"message": "<string>",
"errors": [
{}
]
}Authorizations
Bearer token authentication. Obtain token from Issue a Token endpoint
Body
application/json
Response
Beneficiary updated successfully
Show child attributes
Show child attributes
⌘I
