How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Agicap Manage beneficiaries API

The Manage beneficiaries API from Agicap — 4 operation(s) for manage beneficiaries.

Agicap Manage beneficiaries API is one of 52 APIs that Agicap publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Manage beneficiaries. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 7 operations across 4 paths, and defines 17 schemas. It is described by OpenAPI 3.2.0, at version v1.

Requests are made against 2 base URLs: https://api.agicap.com, https://api.agicap.internal.

7 operations 4 paths 17 schemas 2 DELETE2 GET2 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v1
Base URL
https://api.agicap.com
Authentication
HTTP Bearer, HTTP Bearer
Resource Areas
1

Authentication & Security 2

Agicap Manage beneficiaries API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearer). It accepts HTTP bearer tokens (OPAQUE) (bearerAuth).

Paths & Operations 7

Across 4 paths, the API surfaces 7 operations — 2 DELETE, 2 GET, 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Manage beneficiaries 7
DELETE
/public/payments/v2/entities/{entityId}/Beneficiaries
Delete all beneficiaries
5_Beneficiaries_Delete_All 1 param → 204401403429500
GET
/public/payments/v2/entities/{entityId}/Beneficiaries
Get beneficiaries
1_Beneficiaries_Get_All 1 param → 200401403429500
POST
/public/payments/v2/entities/{entityId}/Beneficiaries
Create a beneficiary
2_Beneficiaries_Add 1 param body → 201401403429500
POST
/public/payments/v2/entities/{entityId}/Beneficiaries/sync
Synchronize beneficiaries
6_Beneficiaries_Sync_Start 1 param body → 202401403429500
GET
/public/payments/v2/entities/{entityId}/Beneficiaries/sync/{syncId}
Get a beneficiary synchronization report
7_Beneficiaries_Sync_Report 2 params → 200401403404429500
DELETE
/public/payments/v2/entities/{entityId}/Beneficiaries/{beneficiaryId}
Delete a beneficiary
4_Beneficiaries_Delete 2 params → 204401403429500
PUT
/public/payments/v2/entities/{entityId}/Beneficiaries/{beneficiaryId}
Edit a beneficiary
3_Beneficiaries_edit 2 params body → 204401403429500

Schemas 17

The contract defines 17 schemas that model the data the API accepts and returns. The most detailed are PaymentsPreparation.Web.Models.Dtos.Beneficiaries.BeneficiarySyncItemDto (11 properties), PaymentsPreparation.Web.Models.Presentations.Beneficiary.BeneficiaryPresentation (7 properties), PaymentsPreparation.Web.Models.Presentations.Beneficiary.PostalAddressPresentation (6 properties), PaymentsPreparation.Web.Models.Dtos.Beneficiaries.PostalAddressDto (6 properties). Each schema is shown below with its type and property counts.

PaymentsPreparation.Web.Models.Presentations.Beneficiary.BeneficiarySyncErrorCodePresentation
string
Reason an item failed during a beneficiary synchronization. Each value is contractual: renaming one is a breaking change.
PaymentsPreparation.Web.Models.Presentations.Beneficiary.ValidationStatusPresentation
string
PaymentsPreparation.Web.Models.Presentations.Beneficiary.PostalAddressPresentation
object
6 properties 3 required
PaymentsPreparation.Web.Models.Dtos.Beneficiaries.StartBeneficiarySyncDto
object
Payload of a beneficiary synchronization request.
1 property 1 required
PaymentsPreparation.Web.Models.Dtos.Beneficiaries.EditBeneficiaryDto
object
Beneficiary's information to edit
3 properties 1 required
PaymentsPreparation.Web.Models.Presentations.Beneficiary.BeneficiarySyncErrorPresentation
object
A single item that failed during a beneficiary synchronization.
4 properties 3 required
PaymentsPreparation.Web.Models.Presentations.Beneficiary.BankAccountPresentation
object
6 properties
PaymentsPreparation.Web.Models.Presentations.Beneficiary.UncertaintyStatusPresentation
string
PaymentsPreparation.Web.Models.Presentations.Beneficiary.BeneficiarySyncStatusPresentation
string
Status of a beneficiary synchronization.
Microsoft.AspNetCore.Mvc.ProblemDetails
object
5 properties
PaymentsPreparation.Web.Models.Presentations.Beneficiary.BeneficiaryPresentation
object
7 properties 3 required
PaymentsPreparation.Web.Models.Dtos.Beneficiaries.PostalAddressDto
object
Information about the postal address of the beneficiary
6 properties 3 required
PaymentsPreparation.Web.Models.Dtos.Beneficiaries.AddBeneficiaryDto
object
Beneficiary's information to add
3 properties 1 required
PaymentsPreparation.Web.Models.Dtos.Beneficiaries.BankAccountDto
object
Information about the bank account of the beneficiary
6 properties
PaymentsPreparation.Web.Models.Presentations.Beneficiary.BeneficiarySyncReportPresentation
object
Status and per-item errors of a beneficiary synchronization.
5 properties 4 required
PaymentsPreparation.Web.Models.Dtos.Beneficiaries.BeneficiarySyncItemDto
object
A single beneficiary to synchronize.
11 properties 2 required
PaymentsPreparation.Web.Models.Dtos.Beneficiaries.BeneficiarySyncPostalAddressDto
object
Postal address of a synchronized beneficiary.
6 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

agicap-manage-beneficiaries-api-openapi.yml Raw ↑

Other APIs Agicap publishes across the network.

Agicap Account reports API
Agicap Accrued interests API
Agicap Analytical Plan API
Agicap Anything API
Agicap Authentication API
Agicap Bank accounts API
Agicap Bank files API
Agicap Beta API
Agicap Card expenses bank journal API
Agicap Causales API
Agicap Client addresses API
Agicap Client Credit Notes API
Where this information came from

This is an independent, third-party profile of Agicap Manage beneficiaries API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.