---
title: "GET /payment-flows/{payment_flow_ref}"
method: GET
path: "/payment-flows/{payment_flow_ref}"
tags: ["Payment Flows"]
---

# GET /payment-flows/{payment_flow_ref}

`GET /payment-flows/{payment_flow_ref}`

Gets a payment flow by ID or external ID.

## Path parameters

- `payment_flow_ref` string, required — Payment flow ID or external ID.

## Response `200`

Success

- PaymentFlowSuccessResponse
  - `data` PaymentFlow, required — Payment flow object.
    - `id` string, required — FRAGMENT generated unique ID.
    - `type` string, required — Type of payment flow.
    - `status` string, required — Status of the payment flow.
    - `external_id` string, required — User-provided unique external ID.
    - `invoice` object, required — Invoice being settled.
      - `id` string, required — Invoice identifier.
      - `external_id` string — Invoice external ID.
    - `payment_plan` PaymentPlan, required — Payment plan for UI rendering.
      - `version` number, required — Plan version.
      - `invoice_id` string, required — Invoice identifier.
      - `generated_at` string, required — When the plan was generated.
      - `batches` PaymentPlanBatch[], required — Payment batches.
        - `batch_id` string, required — Batch identifier.
        - `label` string, required — Human-readable batch label.
        - `depends_on` string[], required — Batches this one depends on.
        - `status` string, required — Batch status.
        - `payments` object[], required — Payments in this batch.
          - `payment_id` string, required — FRAGMENT generated unique ID.
          - `user` PaymentPlanUserReferenceResponse, required — User associated with the payment.
            - `id` string, required — FRAGMENT generated unique ID.
            - `external_id` string, required — User-provided unique ID.
          - `direction` string, required — Direction of the payment.
          - `amount` string, required — Amount in smallest currency unit.
          - `currency` string, required — Currency code.
          - `status` string, required — Status of the payment.
    - `created` string, required — Timestamp when the payment flow was created.
    - `modified` string, required — Timestamp when the payment flow was last modified.

## Other responses

- `401` — Unauthorized
- `404` — Not found
- `500` — Internal server error

## Changes

- **2026-04-23** `2313a4acc241` — 1 info
  - endpoint added

[Change history](https://skmtc.dev/fragment-dev/apis/fragment-payments-api/changes/payment-flows/:payment_flow_ref/get.md)

---

[API](https://skmtc.dev/fragment-dev/apis/fragment-payments-api.md) · [All operations](https://skmtc.dev/fragment-dev/apis/fragment-payments-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/fragment-dev/fragment-payments-api/revisions/41ca2c686012/schema)