Skip to main content
PATCH
/
payout
/
recipients
/
{id}
/
status
Update beneficiary status
curl --request PATCH \
  --url http://localhost:4000/v1/payout/recipients/{id}/status \
  --header 'Content-Type: application/json' \
  --data '
{
  "status": "archived"
}
'

Path Parameters

​
id
string
required

Body

application/json
​
status
enum<string>
required

New beneficiary status

Available options:
active,
archived
Example:

"archived"

Response

Beneficiary status updated