Skip to main content
Version: 1.0.0

Webhooks API

The banca.me webhooks API provides endpoints for creating and managing webhooks to receive notifications about events. This API allows partners to configure webhook endpoints to be notified about important events such as loan status changes, payment updates, and risk evaluation results.

Features​

  • Create and manage webhook configurations
  • Receive real-time event notifications
  • Secure payload delivery with signature verification
  • Automatic retries for failed deliveries

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:

  • 100 requests per minute per API key
  • 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
  • 422: Invalid data
  • 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. Event Handling:
  • Implement idempotent webhook processing to handle potential duplicate deliveries
  • Acknowledge webhook receipt promptly (respond with 200 OK within 5 seconds)
  • Process webhook data asynchronously after acknowledging receipt
  • Verify webhook signatures for security
  1. Endpoint Configuration:
  • Use HTTPS endpoints with valid certificates
  • Implement proper error handling
  • Set up monitoring for webhook failures
  • Ensure your endpoint is reliable and accessible
  1. Security:
  • Verify webhook signatures using your shared secret
  • Store webhook credentials securely
  • Validate payload formats and event types
  • Implement rate limiting on your webhook endpoint

Authentication​

Partner access token provided by banca.me

Security Scheme Type:

http

HTTP Authorization Scheme:

bearer