---
title: "List payins for a specific customer within Flow workflows"
method: GET
path: "/entities/{entityDID}/flow/customers/{customerDID}/payins"
tags: ["Flow"]
---

# List payins for a specific customer within Flow workflows

`GET /entities/{entityDID}/flow/customers/{customerDID}/payins`

## Request

- Base URL: `https://api.eu1.notabene.id`
- URL: `https://api.eu1.notabene.id/entities/{entityDID}/flow/customers/{customerDID}/payins`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/notabene/apis/notabene-api/docs/entities/:entityDID/flow/customers/:customerDID/payins/get.ts> (a function with typed inputs; its response is checked against the schema)

Retrieves a paginated list of payin transactions for a specific customer within
Flow workflows. This endpoint filters payins by the customer (merchant) and
supports filtering by client references and Flow workflow states.

## Path parameters

- `entityDID` string, did, required: Decentralized Identifier (DID)
- `customerDID` string, required

## Query parameters

- `refs` union
  - string
  - string[]
- `limit` string
- `offset` string
- `status` union
  - string
  - string[]

## Response `200`

List of customer payins retrieved successfully

- object
  - `data` object[]
    - `@id` string: Unique identifier for the transfer
    - `@type` 'Payin': Type of transaction
    - `ref` string: Client reference (without flow- prefix)
    - `asset` string: Asset identifier for the transaction
    - `amount` string: Transaction amount
    - `status` 'OUTGOING' | 'INCOMING' | 'AWAITING-YOURS' | 'AWAITING-COUNTERPARTY' | 'REJECTED' | 'AUTHORIZED' | 'FLAGGED' | 'SETTLED' | 'FLAGGED-SETTLEMENT' | 'REVERTED' | 'REVERT-AUTHORIZED' | 'REVERT-REJECTED' | 'REVERT-FLAGGED' | 'REVERT-REQUESTED' | 'FROZEN' | 'CLEARED': The status of a transfer
    - `originator` string: Originator entity information
    - `beneficiary` string: Beneficiary entity information
    - `memo` string: Transaction memo or note
    - `supportedAssets` string[]: List of supported assets for this transaction
    - `flowState` string: Current Flow workflow state
    - `invoice` object: Flow-specific invoice data
    - `paymentLink` string: Payment link for customer interaction
    - `customerDid` string: Customer DID identifier
    - `merchantDid` string: Merchant DID identifier
    - `requiresCustomerApproval` boolean: Whether customer approval is required
    - `createdAt` string, date-time: Transaction creation timestamp
  - `pagination` object
    - `limit` integer: Maximum number of results returned
    - `offset` integer: Number of results skipped
    - `total` integer: Total number of available results

## Other responses

- `400`: Bad Request - The server could not process the request due to a client error.
- `401`: Unauthorized - Authentication information is missing or invalid.
- `403`: Forbidden - The server understood the request but refuses to authorize it.
- `404`: Customer not found
- `500`: Internal Server Error - An unexpected condition was encountered on the server.

---

[API](https://skmtc.dev/notabene/apis/notabene-api.md) - [All operations](https://skmtc.dev/notabene/apis/notabene-api/llms.txt) - [OpenAPI document](https://skmtc.dev/notabene/apis/notabene-api/revisions/70056745a433?raw)