GET/vopgateway/v1/bulk/{taskId}/status
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 |
1.1 | 20 Feb 2025 | Updated Language in request header from ISO639 to ISO639-1 |
2.0 | 20 Mar 2025 | Format changes. Refer to detailed changes here. |
2.1 | 16 Apr 2025 | Added the following new headers: X-End-User, X-Software-Supplier and X-Channel |
List of Statuses
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. |
Request
Request Body
This endpoint does not require a request body. The taskId is passed as a path parameter.
taskId
StringMandatory
Request
GET
/vopgateway/v1/bulk/{taskId}/statusGET /vopgateway/v1/bulk/12930484-129284501-ecernb/status
Response
Response Body
status
EnumMandatorydetail
StringConditional
Response
{
"status": "IN_PROGRESS"
}