Advanced

Batch connection loading

This endpoint is optional and not required for standard integrations. Use only if explicitly instructed by Wealth Reader.

Important: To use batch process management on Wealthreader's side, a dedicated environment is required. This endpoint is not available on api.wealthreader.com.

The endpoints grouped under the "batch" tag allow processing multiple bank connections asynchronously, unlike the /entities/ method which is synchronous. Ideal for:

  • Processing large volumes of connections, delegating the process to Wealthreader
  • Avoiding timeouts on slow connections
  • Getting a webhook notification per completed credential

This method starts asynchronous processing of one or multiple bank connections. Immediately returns a batch_id for tracking. A webhook notification is sent to notification_url for each individual credential as soon as it completes, with the following payload fields: batch_id, credential_id, status, timestamp.

post/batch/load/

Request

  • Base URL: https://api.wealthreader.com
  • URL: https://api.wealthreader.com/batch/load/
  • Auth: none declared

Request body

api_keystring required

Identifies the client in the service

notification_urlstring uri required

Webhook URL. A notification is sent to this URL for each individual credential as soon as it completes processing, not only once all connections in the batch are done.

Example request

{
  "api_key": "a1b2c3d4e5f6g7h8i9j0",
  "notification_url": "https://example.com/webhook/batch-complete",
  "connections": [
    {
      "credential_id": "cred_001",
      "code": "santander",
      "token": "FRJ0mHlaqZwLzu",
      "product_types": "accounts,cards,portfolios",
      "date_from": "2024-01-01",
      "date_to": "2025-12-31",
      "required_products_schema": "{\"ACCOUNTS\":{\"0ae4d722b1c82feeafb4b36b2893230444071335\":{\"only_balances\":false,\"date_from\":\"2024-04-03\"}}}",
      "add_pdf_from_uuids": "20966426721d0885ef9d4b95535e1d3198936f16,8772d6c978d37d7af83094abf380b8b703e94105"
    }
  ]
}

Response

Batch accepted for processing

successboolean
batch_idstring

Unique batch identifier

total_connectionsinteger

Total number of connections in the batch

estimated_completion_timestring date-time

Estimated completion time

Example response

{
  "success": true,
  "batch_id": "batch_20250120_a1b2c3d4",
  "total_connections": 5,
  "estimated_completion_time": "2025-01-20T10:45:00Z"
}

Changes

No recorded changes to this operation across all 1 revision of this API.