Skip to main content
Version: 1.0.0

banca.me Partners API

The banca.me Partners API provides endpoints for creating and managing PartnerEntities. This API is designed for Partners who want to manage their partner entities in order to have a level of isolation for leads evaluated through Risk Policies for each PartnerEntity in order to satisfy their private B2B customers. Moreover this model reflects Merchants (bnpl), Projects (Real State) and Real State (Real State Brokers).

Features​

This usage provides a Partner the capabilities of managing their own B2B customer relationships by:

  • Enabling them to interact with the platform (make their own evaluations or purchases) using their own id (referenced to banca.me as externalEntityId). Reference POST endpoint.
  • Getting all of the PartnerEntities a Partner has created. Reference GET endpoint.
  • Updating a PartnerEntity values in order to update the name o if the PartnerEntity is no longer active. Reference PATCH endpoint.

Base URL​

The base URL for all API requests is:

https://api.banca.me

Rate Limiting​

The API implements rate limiting to ensure fair usage:

  • Rate limit headers are included in responses
  • 429 status code is returned when limits are exceeded

Error Handling​

The API uses standard HTTP status codes and provides detailed error messages in the response body. Common error codes include:

  • 400: Bad Request
  • 401: Unauthorized
  • 403: Forbidden
  • 404: Not Found
  • 429: Too Many Requests
  • 500: Internal Server Error

Data Formats​

The API accepts and returns data in the following formats:

  • Request: application/json
  • Response: application/json

Best Practices​

  1. Entity Management
  • Create entities with meaningful names
  • Keep track of external IDs
  • Update entity information when needed
  • Monitor entity status
  1. Error Handling
  • Implement proper error handling
  • Check HTTP status codes
  • Parse error messages from responses
  • Implement retry logic for temporary failures
  1. Security
  • Keep your API token secure
  • Never expose tokens in client-side code
  • Validate all input data
  • Use HTTPS for all requests
  1. Performance
  • Cache entity information when appropriate
  • Monitor rate limits
  • Implement proper error recovery
  • Optimize API calls

Authentication​

Partner access token provided by banca.me

Security Scheme Type:

http

HTTP Authorization Scheme:

bearer