Referencia de APIAccounting / Beneficiary Create Beneficiary
POST /v1/beneficiary • validated by `postBeneficiary`
← Back to full API referencePOST/v1/beneficiaryAuthentication required
- Validated by Zod schema: postBeneficiary.
Request details
Path params
No path parameters for this endpoint.
Query params
No explicit query schema was captured for this endpoint.
Body fields
name (required)
Type: string
type (required)
Enum-like validator generated by zodFromObj
taxId
Type: string
reference
Type: string
labels
Type: array
Example:
labels[] (required)
Type: string
contact
Type: array
Example:
contact[] (required)
Type: object
contact[].type (required)
Type: string
contact[].data (required)
Type: string
contact[].dataType
Type: enum
Example: string
lat
Type: number
lon
Type: number
metadata
Type: object
metadata.adquisitionChannel
Type: string
creditLimit
Type: number
Default payloads
Body
{
"name": "string",
"type": "string"
}
Sample response
{
"beneficiaryId": "<beneficiaryId>"
}
Test this endpoint now
Use your own credentials and execute a live request directly from this page.
2. Select endpoint
POST/v1/beneficiaryAuthentication required
Group: Accounting / Beneficiary
POST /v1/beneficiary • validated by `postBeneficiary`
- Validated by Zod schema: postBeneficiary.
3. Prepare request payload
4. Server response
Run a request to inspect the real-time response for your environment.