---
title: "Retrieve an incoming transfer"
method: GET
path: "/payins/{payinId}"
tags: ["transfers"]
---

# Retrieve an incoming transfer

`GET /payins/{payinId}`

## Request

- The document declares no server URL.
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/hevn-inc/apis/hevn-api/docs/payins/:payinId/get.ts> (a function with typed inputs; its response is checked against the schema)

Retrieve an incoming-transfer quote and its current funding lifecycle. Use the instructions operation when payment details are still required.

## Path parameters

- `payinId` string, required: Prefixed pay-in id

## Headers

- `X-Hevn-Account` string, nullable: The client account to act for, as a `cl_…` id. Omit it to act as yourself.

## Response `200`

Successful Response

- PayinView
  - `id` string, required: Stable public identifier for this incoming transfer.
  - `status` 'pending' | 'awaitingFunds' | 'processing' | 'inReview' | 'completed' | 'failed' | 'refunded' | 'canceled', required
  - `rail` 'sepa' | 'swift' | 'ach' | 'uaefts' | 'fedwire' | 'rtp' | 'fednow' | 'pix' | 'spei' | 'pse' | 'breb' | 'transfers_3_0' | 'ukfps' | 'npp' | 'nip' | 'bdt_local' | 'bdt_ewallet' | 'bob_local' | 'brl_local' | 'cad_eft' | 'clp_local' | 'cny_alipay' | 'cny_wechatpay' | 'cop_local' | 'crc_local' | 'dkk_local' | 'dop_local' | 'dop_ewallet' | 'egp_local' | 'gtq_local' | 'gtq_ewallet' | 'hkd_fps' | 'hnl_local' | 'idr_local' | 'idr_ewallet' | 'ils_local' | 'inr_local' | 'inr_upi' | 'jmd_local' | 'jpy_local' | 'krw_local' | 'myr_local' | 'nok_local' | 'php_local' | 'php_ewallet' | 'pkr_raast' | 'pkr_ewallet' | 'pln_local' | 'sar_local' | 'sle_local' | 'thb_local' | 'try_fast' | 'tzs_local' | 'ugx_local' | 'vnd_local' | 'xof_local' | 'zmw_local'
  - `quote` PayinQuoteView, required
    - `amount` string, required: Amount funded in the source currency.
    - `currency` string, required: Source currency or digital asset.
    - `settlementAmount` string, required: Amount delivered in the settlement asset.
    - `destinationAccount` 'USDC' | 'EURC' | 'RD' | 'USDC_ARB' | 'FDIC_USD' | 'FDIC_EUR' | 'KYC_CARDS'
    - `feeAmount` string, nullable: Fee charged in feeCurrency.
    - `feeCurrency` string, nullable: Currency in which the fee is charged.
    - `rate` string, nullable: Conversion rate from source amount to settlement amount.
  - `paymentReference` string, nullable: Reference that must accompany the account transfer.
  - `originChainId` string, nullable: Network from which an on-chain transfer is funded.
  - `destinationChainId` string, nullable: Network on which the transfer settles.
  - `expiresAt` string, date-time, nullable: UTC timestamp after which the quote is no longer valid.
  - `createdAt` string, date-time, required: UTC timestamp when the incoming transfer was created.

## Other responses

- `422`: Request validation failed

## Changes

- **2026-11-12** `299a3aa6f521`: 2 warning, 2 info
  - added the new `FDIC_EUR` enum value to the `quote/destinationAccount/anyOf[subschema #1: AccountKey]/` response property for the response status `200`
  - added the new `verification_not_applicable` enum value to the `error/code` response property for the response status `422`
  - removed the `phone_required` enum value from the `error/code` response property for the response status `422`
  - removed the `rail_requirements_unmet` enum value from the `error/code` response property for the response status `422`
- **2026-10-23** `a02795de2d2b`: 12 warning, 5 info
  - deleted the `header` request parameter `x-api-key`
  - added the new `KYC_CARDS` enum value to the `quote/destinationAccount/anyOf[subschema #1: AccountKey]/` response property for the response status `200`
  - added the new `RD` enum value to the `quote/destinationAccount/anyOf[subschema #1: AccountKey]/` response property for the response status `200`
  - added the new `USDC_ARB` enum value to the `quote/destinationAccount/anyOf[subschema #1: AccountKey]/` response property for the response status `200`
  - …13 more
- **2026-10-20** `19eb00e9f258`: 1 info
  - removed the `phone_in_use` enum value from the `error/code` response property for the response status `422`
- **2026-10-20** `bd6c9d69540e`: 1 warning
  - added the new `phone_in_use` enum value to the `error/code` response property for the response status `422`
- …earlier changes not shown

[Operation history](https://skmtc.dev/hevn-inc/apis/hevn-api/changes/payins/:payinId/get.md)

---

[API](https://skmtc.dev/hevn-inc/apis/hevn-api.md) - [All operations](https://skmtc.dev/hevn-inc/apis/hevn-api/llms.txt) - [OpenAPI document](https://skmtc.dev/hevn-inc/apis/hevn-api/revisions/299a3aa6f521?raw)