Skip to main content
POST
Bulk Status

Overview

The Bulk Status API allows you to check the processing status of a bulk batch, including detailed information about each individual consent record. This API supports filtering by status and retry eligibility, pagination for large batches, and optional balance details via include_balances.

Notes

  • Use the reference_id you provided when scheduling the batch to query status.
  • For large batches, use pagination to retrieve results in manageable chunks.
  • include_balances=true enriches records with account_details.
  • Failed records include retry eligibility information to help you decide next steps.

Authentication

This API requires authentication using the following headers:
string
required
Your unique client identifier provided by FinPro during onboarding.
string
required
Your confidential client secret key provided by FinPro.
string
required
The unique identifier for your application.
string
required
Your organization’s unique identifier assigned by FinPro.
string
required
Must be set to application/json.

Request Body

string
required
The unique reference ID you provided when scheduling the batch.
object
Optional filters to narrow down the results.
integer
default:"1"
Page number for pagination.
integer
default:"100"
Number of records per page. Maximum: 1000.
boolean
default:"false"
Whether to include account balance details in each record.

Request Example

Response Parameters

string
The API version that processed the request.
string
The timestamp when the response was generated (ISO 8601 format).
string
A unique transaction ID for this API call.
string
The status of the API call. Returns "success" for successful queries.
object
Contains batch status information.

Record Object

Each record in the records array contains:

Success Response Example

Status Values

Batch Status Values

Row Status Values

Retry Eligibility Values

Error Responses

Batch Not Found

When the reference_id does not exist:
HTTP Status Code: 404 Not Found