Skip to main content
Beneficiaries are saved payout recipients scoped to your integrator workspace. Create them once; reference by ID in quotes and transactions. See Beneficiaries concepts for data model details.

​
Endpoints

MethodPathDescription
POST/v1/api/beneficiariesCreate a new beneficiary
GET/v1/api/beneficiariesList beneficiaries for the workspace
GET/v1/api/beneficiaries/:idGet a beneficiary by ID
PATCH/v1/api/beneficiaries/:idUpdate a beneficiary
DELETE/v1/api/beneficiaries/:idDeactivate a beneficiary