---
title: "Get Bulk Payment File Status"
method: GET
path: "/bulk-payments/{bulkPaymentId}"
tags: ["Payments"]
---

# Get Bulk Payment File Status

`GET /bulk-payments/{bulkPaymentId}`

Returns the bulk file status of the bulk payment for given bulkPaymentId

## Path parameters

- `bulkPaymentId` string, required

## Headers

- `consent` string, required

## Response `200`

OK

- object
  - `meta` object
    - `tracingId` string
  - `data` object
    - `id` string — Unique identifier of the Bulk Payment
    - `consentId` string — Identification of the consent.
    - `statusDetails` object
      - `status` string — Bulk file status. Enum: `COMPLETED` `PENDING` `FAILED` `UNKNOWN` These values are subject to change.
      - `multiAuthorisationStatus` MultiAuthorisation — Details the additional levels of authorisation which are required from, and being managed by, the `Institution`.
        - `status` string — __Mandatory__. Specifies the current status of the multi-authorisation flow.
        - `numberOfAuthorisationRequired` integer — __Mandatory__. Total number of authorisations required.
        - `numberOfAuthorisationReceived` integer — __Mandatory__. The total number of authorisations that have been received.
        - `lastUpdatedDateTime` string, date-time — __Mandatory__. Date and time of when the authorisation was last updated.
        - `expirationDateTime` string, date-time — __Mandatory__. Date and time by when the authorisation flow must be completed before it expires and the authorisation request is terminated.
      - `updatedAt` string, date-time
    - `createdAt` string, date-time

## Other responses

- `400` — Required parameter missing or invalid
- `401` — Authentication Error
- `404` — Bulk payment not found for provided id
- `500` — An unexpected error occurred.

---

[API](https://skmtc.net/yapily/apis/yapily-api.md) · [All operations](https://skmtc.net/yapily/apis/yapily-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/yapily/yapily-api/revisions/a8ca54f9eb9f/schema)