Referencia de APIAccounting / Beneficiary
Create Beneficiary balance topup
← Back to full API reference
POST
/v1/beneficiary/balance/topupAuth required- Requires organization permissions for this resource.
- Validated by Zod schema: topupBeneficiaryBalance.
Request details
Body fields
| Field | Required | Description |
|---|---|---|
| beneficiaryId | Yes | Type: number |
| divisionId | Yes | Type: number |
| amount | Yes | Type: number |
| currency | Yes | Enum-like validator generated by zodFromObj |
| paymentMethod | Yes | Type: enumExample: CASH |
| accountId | Yes | Type: number |
| reference | No | Type: string |
| description | No | Type: string |
| date | No | Type: string |
Default payloads
Path params
json
{}Query
json
{}Body
json
{
"beneficiaryId": 1,
"divisionId": 1,
"amount": 1,
"currency": "string",
"paymentMethod": "CASH",
"accountId": 1
}Sample response
json
{
"recordId": "<recordId>",
"balance": "<balance>"
}