Create a new PartnerEntity
POST/partner/entity
Creates a new PartnerEntity with the provided information, together with its default origin.
The default origin's label is your partner's default origin label followed by -<label>
(for example partner_name-facebook); it is returned as defaultOrigin.
⚠️ idNumber, code and description: banca.me can enforce these three fields as
required. While enforced, a request missing any of them is rejected with 400 like the other
required fields. Always include them.
Request
Responses
- 201
- 400
- 401
- 403
- 404
- 428
- 503
PartnerEntity created successfully
Bad Request - externalEntityId, name or label is missing; isActive is not true;
label has characters other than lowercase letters, digits and hyphens; or the token is
not your current API token.
Unauthorized - Missing or malformed token
Forbidden - Partner is inactive, or idNumber is not accepted by banca.me.
Not Found - Your partner has no default PartnerEntity to build the new one from.
Precondition Required - The resulting origin label already exists, or you already have a
PartnerEntity with this externalEntityId.
Service Unavailable - The entity could not be read or saved.