Bulk Status Request API Specification
This endpoint allows you to check the current status of a bulk request using the taskId provided during the request submission. By querying this endpoint, you can determine when the result file is ready to be fetched or if any errors occurred during processing. The response will include the current status of the bulk request.
Document History
| Version | Date | Description |
|---|---|---|
| 1.0 | 15 Jan 2025 | Original Digital Version. Aligned with PDF V1.0 |
The status field can have one of the following values:
| Status | Description |
|---|---|
| NOT_STARTED | The file is in the queue, waiting to be processed. |
| IN_PROGRESS | The file is actively being processed, and individual records are being checked. |
| PROCESSED | The file has been successfully processed and is ready to be fetched. |
| FAILED | The file processing failed due to one of the following reasons: invalid format, corruption, or exceeding the maximum size/record limit. |
| TIMED_OUT | The file was not processed within the service-level agreement (SLA) timeframe. This could be due to timeouts from the responding PSPs. |
Headers
- Name
X-Request-Id- Type
- String
- Tag(s)
- Mandatory
- Description
A RFC4122 UUID used as a correlation id.
- Name
Authorization- Type
- Bearer
- Tag(s)
- Mandatory
- Description
Oauth 2.0 bearer token.
- Name
Accept-Language- Type
- String
- Tag(s)
- Optional
- Description
Can be provided by the Requesting PSP to be used as language in the 'nameSuggestion' response field (when data is available in given language).
- Format: ISO 639.
Example of Request headers
| Header name | Example |
|---|---|
| X-Request-Id | 123e4567-e89b-12d3-a456-426614174000 |
| Authorization | Bearer Token |
| Accept-Language | EN |
Request body
This endpoint does not require a request body. The taskId is passed as a path parameter.
- Name
taskId- Type
- String
- Tag(s)
- Mandatory
- Description
The Unique ID used for retrieving the status and result in a separate request. This is returned in the response when submitting the bulk request.
Response body
- Name
status- Type
- Enum
- Tag(s)
- Mandatory
- Description
The status of the bulk request. In the case of a FAILED or TIMED_OUT response, the bulk request has to be resent.
Values:- NOT_STARTED
- IN_PROGRESS
- PROCESSED
- FAILED
- TIMED_OUT
- Name
detail- Type
- String
- Tag(s)
- Conditional
- Description
The reason is provided if the status is FAILED or TIMED_OUT.
Request
GET /vopgateway/v1/bulk/12930484-129284501-ecernb/status
Response
{
"status": "IN_PROGRESS"
}