Contact Us
API Reference

Add account beneficiary

post
https://sandbox-api.helix.q2.com/accountBeneficiary/add

Add a beneficiary to an account. See accountBeneficiary object definition for parameter details.

Error Codes

Click to expand
CodeMessage (en-US)Notes
1-60000Any "Common Error Code" may occur.See Common Error Codes
107701Invalid account id {0}.
107702Customer id {0} must have FULL access to account id {1} to add a beneficiary.
107703Invalid customer beneficiary id {0}.
107704Customer beneficiary id {0} is deactivated and cannot be used.
Body Params
int32
required
≥ 1
int32
required
≥ 1
int32
required
≥ 1
string
integer | null

Position or order of this beneficiary on the account.

integer | null
0 to 100

Whole-number percentage of the account balance to distribute to this beneficiary. Must be between 0 and 100.

string | null
enum

The method used to distribute the account balance to this beneficiary. Accepted values: Percentage, DescriptionOnly

Allowed:
Responses

Updated 12 days ago

Language
Credentials
Basic
base64
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 12 days ago