Referencia de APIAccounting / Beneficiary
Get Beneficiary by beneficiaryid balance
← Back to full API reference
GET
/v1/beneficiary/:beneficiaryId/balanceAuth required- Requires organization permissions for this resource.
- Validated by Zod schema: getBeneficiaryBalance.
Request details
Path params
| Field | Required | Description |
|---|---|---|
| beneficiaryId | Yes | Required path parameter. |
Query params
| Field | Required | Description |
|---|---|---|
| currency | No | Enum-like validator generated by zodFromObj |
Default payloads
Path params
json
{
"beneficiaryId": 1
}Query
json
{
"currency": "string"
}Sample response
json
{
"balances": "<balances>"
}