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

# Get Bulk Payment Status Details

`GET /bulk-payments/{bulkPaymentId}/details`

## Request

- Base URL: `https://api.yapily.com`
- URL: `https://api.yapily.com/bulk-payments/{bulkPaymentId}/details`
- Auth: HTTP basic

Retrieve details of each payment submitted for a given bulkPaymentId. 

Feature: `EXISTING_BULK_PAYMENT_DETAILS`

## Path parameters

- `bulkPaymentId` string, required

## Headers

- `consent` string, required

## Response `200`

OK

- BulkPaymentDetailsResponse
  - `meta` ResponseMeta
    - `tracingId` string
  - `data` object
    - `id` string: __Mandatory__. Unique identifier for the bulk payment transaction.
    - `consentId` string: __Mandatory__. Unique identifier of the consent related to bulk payment transaction.
    - `payments` BulkPaymentIndividualStatus[]
      - `id` string, required: __Mandatory__. Unique identifier of the individual payment.
      - `status` 'PENDING' | 'FAILED' | 'DECLINED' | 'COMPLETED' | 'COMPLETED_SETTLEMENT_IN_PROCESS' | 'EXPIRED' | 'UNKNOWN' | 'ACTIVE' | 'INACTIVE', required: The status of the Payment. For more information, see [Payment Status](/guides/payments/payment-status/)
      - `statusDetails` object: __Conditional__. Details regarding the status of an individual payment within a bulk request. This object is conditionally returned, typically when the status is not `COMPLETED`.
        - `code` string, required: __Conditional__. The unique 4-digit error code identifying the specific issue. Refer to the official documentation for a comprehensive list of error codes
        - `reason` string: __Optional__. A human-readable description providing additional context or the specific error message encountered.

## 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.dev/yapily/apis/yapily-api.md) - [All operations](https://skmtc.dev/yapily/apis/yapily-api/llms.txt) - [OpenAPI document](https://skmtc.dev/yapily/apis/yapily-api/revisions/a8ca54f9eb9f?raw)