Schedule Bulk FI Requests
Bulk Operations
Schedule Bulk FI Requests
Schedule multiple FI requests in a single batch using a JSON payload.
POST
Schedule Bulk FI Requests
Overview
The Schedule Bulk FI Requests API allows you to submit multiple Financial Information (FI) requests in a single API call.Notes
- Each batch requires a unique
reference_idfor tracking purposes. This ID is provided by you and must be unique across all your batches. - Duplicates in
consents_listare accepted and will be scheduled as separate rows. - You can specify global defaults for date ranges and config that apply to all records, with optional per-row overrides.
- Maximum batch size is 10,000 consents per request.
Authentication
This API requires authentication using the following headers:Your unique client identifier provided by FinPro during onboarding.
Your confidential client secret key provided by FinPro.
The unique identifier for your application.
Your organization’s unique identifier assigned by FinPro.
Must be set to
application/json.Request Body
A unique identifier for this batch, provided by you. Must be alphanumeric with hyphens and underscores allowed, between 5-60 characters. This ID is used for tracking and querying batch status.
An array of consent objects to process. Maximum 10,000 items per request.
Global default start date for financial data (ISO 8601 format). Applied to all consents that don’t specify their own value.
Global default end date for financial data (ISO 8601 format). Applied to all consents that don’t specify their own value.
Global default analytics configuration ID. Applied to all consents that don’t specify their own value.
Request Example
- The first consent uses its own date range and config.
- The second consent uses the global defaults for all parameters.
- The third consent uses the global
fiDataRangeFromandconfigId, but overridesfiDataRangeTo.
Response Parameters
The API version that processed the request.
The timestamp when the response was generated (ISO 8601 format).
A unique transaction ID for this API call.
The status of the API call. Returns
"success" when the batch is accepted.A human-readable message describing the result.
Contains batch details and tracking information.
Success Response Example
Error Responses
Missing Reference ID
When thereference_id field is not provided:
400 Bad Request
Duplicate Reference ID
When thereference_id already exists:
409 Conflict
Validation Failed
When the request body contains invalid data:400 Bad Request
Common Error Codes
| Error Code | Description |
|---|---|
MissingReferenceId | The reference_id field is required but was not provided. |
DuplicateReferenceId | A batch with this reference_id already exists. |
InvalidRequest | The request body contains invalid data (e.g., too many records, invalid date format). |
InvalidDateRange | The fiDataRangeFrom is after fiDataRangeTo. |
