---
title: "Open the incoming transfer and retrieve funding instructions"
method: POST
path: "/payins/{payinId}/instructions"
tags: ["transfers"]
---

# Open the incoming transfer and retrieve funding instructions

`POST /payins/{payinId}/instructions`

## Request

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

Idempotent: an already-open transfer returns the same payment-account details or on-chain deposit address. A quote that stopped holding answers `410 payin_expired`.

## Path parameters

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

## Headers

- `Idempotency-Key` string, nullable: Your own key for this write, `^[A-Za-z0-9._:-]{1,128}$`. A retry with the same key replays the first answer; the same key with a different request is refused.
- `X-Hevn-Account` string, nullable: The client account to act for, as a `cl_…` id. Omit it to act as yourself.

## Request body

- PayinInstructionsRequest
  - `payer` PlatformPayinPayerAccount
    - `method` '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', required
    - `requisites` ContactPaymentAccount, required: Legacy flat payment-account input without internal routing metadata.
      - `method` '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', required
      - `currency` string, required: ISO 4217 currency code accepted by the contact account.
      - `fields` RequisiteFieldsInput
        - `iban` string, nullable: International account identifier without display separators.
        - `bic` string, nullable: BIC or SWIFT identifier of the destination institution.
        - `accountNumber` string, nullable: Domestic account number.
        - `routingNumber` string, nullable: Domestic routing or clearing number.
        - `pixKey` string, nullable: Brazil PIX destination key.
        - `pixKeyType` 'phone' | 'email' | 'tax_id' | 'random'
        - `paymentKey` string, nullable: Local payment key required by the selected method.
        - `financialInstitutionId` string, nullable: Institution identifier from the method directory.
        - `branchNumber` string, nullable: Destination institution branch identifier.
        - `accountKind` 'checking' | 'savings' | 'deposit' | 'salary' | 'other'
        - `phoneNumber` string, nullable: Phone number required by the selected local method.
      - `holder` RequisiteHolderInput, required
        - `type` 'individual' | 'business', required
        - `firstName` string, nullable: Legal given name of an individual holder.
        - `lastName` string, nullable: Legal family name of an individual holder.
        - `businessName` string, nullable: Registered legal name of a business holder.
        - `address` UserAddressInput: Provider-neutral postal address used across domain and API schemas.
          - `streetAddress` string, nullable: Street name and building number.
          - `addressLine2` string, nullable: Optional apartment, suite or unit.
          - `city` string, nullable: City or locality.
          - `state` string, nullable: State, province or administrative area.
          - `country` 'AF' | 'AX' | 'AL' | 'DZ' | 'AS' | 'AD' | 'AO' | 'AI' | 'AQ' | 'AG' | 'AR' | 'AM' | 'AW' | 'AU' | 'AT' | 'AZ' | 'BS' | 'BH' | 'BD' | 'BB' | 'BY' | 'BE' | 'BZ' | 'BJ' | 'BM' | 'BT' | 'BO' | 'BQ' | 'BA' | 'BW' | 'BV' | 'BR' | 'IO' | 'BN' | 'BG' | 'BF' | 'BI' | 'CV' | 'KH' | 'CM' | 'CA' | 'KY' | 'CF' | 'TD' | 'CL' | 'CN' | 'CX' | 'CC' | 'CO' | 'KM' | 'CG' | 'CD' | 'CK' | 'CR' | 'CI' | 'HR' | 'CU' | 'CW' | 'CY' | 'CZ' | 'DK' | 'DJ' | 'DM' | 'DO' | 'EC' | 'EG' | 'SV' | 'GQ' | 'ER' | 'EE' | 'SZ' | 'ET' | 'FK' | 'FO' | 'FJ' | 'FI' | 'FR' | 'GF' | 'PF' | 'TF' | 'GA' | 'GM' | 'GE' | 'DE' | 'GH' | 'GI' | 'GR' | 'GL' | 'GD' | 'GP' | 'GU' | 'GT' | 'GG' | 'GN' | 'GW' | 'GY' | 'HT' | 'HM' | 'VA' | 'HN' | 'HK' | 'HU' | 'IS' | 'IN' | 'ID' | 'IR' | 'IQ' | 'IE' | 'IM' | 'IL' | 'IT' | 'JM' | 'JP' | 'JE' | 'JO' | 'KZ' | 'KE' | 'KI' | 'KP' | 'KR' | 'XK' | 'KW' | 'KG' | 'LA' | 'LV' | 'LB' | 'LS' | 'LR' | 'LY' | 'LI' | 'LT' | 'LU' | 'MO' | 'MG' | 'MW' | 'MY' | 'MV' | 'ML' | 'MT' | 'MH' | 'MQ' | 'MR' | 'MU' | 'YT' | 'MX' | 'FM' | 'MD' | 'MC' | 'MN' | 'ME' | 'MS' | 'MA' | 'MZ' | 'MM' | 'NA' | 'NR' | 'NP' | 'NL' | 'NC' | 'NZ' | 'NI' | 'NE' | 'NG' | 'NU' | 'NF' | 'MK' | 'MP' | 'NO' | 'OM' | 'PK' | 'PW' | 'PS' | 'PA' | 'PG' | 'PY' | 'PE' | 'PH' | 'PN' | 'PL' | 'PT' | 'PR' | 'QA' | 'RE' | 'RO' | 'RU' | 'RW' | 'BL' | 'SH' | 'KN' | 'LC' | 'MF' | 'PM' | 'VC' | 'WS' | 'SM' | 'ST' | 'SA' | 'SN' | 'RS' | 'SC' | 'SL' | 'SG' | 'SX' | 'SK' | 'SI' | 'SB' | 'SO' | 'ZA' | 'GS' | 'SS' | 'ES' | 'LK' | 'SD' | 'SR' | 'SJ' | 'SE' | 'CH' | 'SY' | 'TW' | 'TJ' | 'TZ' | 'TH' | 'TL' | 'TG' | 'TK' | 'TO' | 'TT' | 'TN' | 'TR' | 'TM' | 'TC' | 'TV' | 'UG' | 'UA' | 'AE' | 'GB' | 'US' | 'UM' | 'UY' | 'UZ' | 'VU' | 'VE' | 'VN' | 'VG' | 'VI' | 'WF' | 'EH' | 'YE' | 'ZM' | 'ZW': ISO 3166-1 alpha-2 country codes.
          - `zip` string, nullable: Postal or ZIP code.
        - `idType` 'passport' | 'national_id' | 'foreigner_id' | 'temporary_permit' | 'minor_id' | 'driving_license' | 'resident_card' | 'tax_id' | 'other'
        - `idNumber` string, nullable: Government identifier number for the holder.
        - `taxId` string, nullable: Tax identifier of the holder.
        - `nationality` string, nullable: ISO country code of the holder's nationality.
      - `bankName` string, nullable: Name of the destination financial institution; required for ACH and Fedwire contacts.
      - `bankAddress` BankAddressInput
        - `addressLine1` string, required: Street name and building number.
        - `city` string, nullable: City or locality.
        - `state` string, nullable: State, province or administrative area.
        - `postalCode` string, nullable: Postal or ZIP code.
        - `country` string, nullable: ISO 3166-1 alpha-2 country code.
      - `intermediaryBank` IntermediaryBankInput
        - `bic` string, required: BIC or SWIFT identifier of the intermediary institution.
        - `name` string, nullable: Name of the intermediary institution.
        - `address` BankAddressInput
          - `addressLine1` string, required: Street name and building number.
          - `city` string, nullable: City or locality.
          - `state` string, nullable: State, province or administrative area.
          - `postalCode` string, nullable: Postal or ZIP code.
          - `country` string, nullable: ISO 3166-1 alpha-2 country code.
        - `accountNumber` string, nullable: Account number used at the intermediary institution.
      - `paymentReference` string, nullable: Reference or memo required by the contact.

## Response `200`

Successful Response

- PayinInstructionsView
  - `payinId` string, required: Incoming-transfer identifier these instructions fund.
  - `kind` union, required: Kind of funding instruction returned.
    - 'bank_transfer' | 'qr_code' | 'hosted_page' | 'manual'
    - 'onchain'
  - `amount` string, required: Exact amount to send.
  - `currency` string, required: Currency or digital asset to send.
  - `paymentReference` string, nullable: Reference that must accompany the account transfer.
  - `singleUse` boolean, required: Whether these instructions may fund only this incoming transfer once.
  - `expiresAt` string, date-time, nullable: UTC timestamp after which these instructions expire.
  - `requisites` RailRequisitesView
    - `fields` RequisiteFieldsOutput, required
      - `iban` string, nullable, required: International account identifier without display separators.
      - `bic` string, nullable, required: BIC or SWIFT identifier of the destination institution.
      - `accountNumber` string, nullable, required: Domestic account number.
      - `routingNumber` string, nullable, required: Domestic routing or clearing number.
      - `pixKey` string, nullable, required: Brazil PIX destination key.
      - `pixKeyType` 'phone' | 'email' | 'tax_id' | 'random', required
      - `paymentKey` string, nullable, required: Local payment key required by the selected method.
      - `financialInstitutionId` string, nullable, required: Institution identifier from the method directory.
      - `branchNumber` string, nullable, required: Destination institution branch identifier.
      - `accountKind` 'checking' | 'savings' | 'deposit' | 'salary' | 'other', required
      - `phoneNumber` string, nullable, required: Phone number required by the selected local method.
    - `holder` RequisiteHolderOutput, required
      - `type` 'individual' | 'business', required
      - `firstName` string, nullable, required: Legal given name of an individual holder.
      - `lastName` string, nullable, required: Legal family name of an individual holder.
      - `businessName` string, nullable, required: Registered legal name of a business holder.
      - `address` UserAddressOutput, required: Provider-neutral postal address used across domain and API schemas.
        - `streetAddress` string, nullable, required: Street name and building number.
        - `addressLine2` string, nullable, required: Optional apartment, suite or unit.
        - `city` string, nullable, required: City or locality.
        - `state` string, nullable, required: State, province or administrative area.
        - `country` 'AF' | 'AX' | 'AL' | 'DZ' | 'AS' | 'AD' | 'AO' | 'AI' | 'AQ' | 'AG' | 'AR' | 'AM' | 'AW' | 'AU' | 'AT' | 'AZ' | 'BS' | 'BH' | 'BD' | 'BB' | 'BY' | 'BE' | 'BZ' | 'BJ' | 'BM' | 'BT' | 'BO' | 'BQ' | 'BA' | 'BW' | 'BV' | 'BR' | 'IO' | 'BN' | 'BG' | 'BF' | 'BI' | 'CV' | 'KH' | 'CM' | 'CA' | 'KY' | 'CF' | 'TD' | 'CL' | 'CN' | 'CX' | 'CC' | 'CO' | 'KM' | 'CG' | 'CD' | 'CK' | 'CR' | 'CI' | 'HR' | 'CU' | 'CW' | 'CY' | 'CZ' | 'DK' | 'DJ' | 'DM' | 'DO' | 'EC' | 'EG' | 'SV' | 'GQ' | 'ER' | 'EE' | 'SZ' | 'ET' | 'FK' | 'FO' | 'FJ' | 'FI' | 'FR' | 'GF' | 'PF' | 'TF' | 'GA' | 'GM' | 'GE' | 'DE' | 'GH' | 'GI' | 'GR' | 'GL' | 'GD' | 'GP' | 'GU' | 'GT' | 'GG' | 'GN' | 'GW' | 'GY' | 'HT' | 'HM' | 'VA' | 'HN' | 'HK' | 'HU' | 'IS' | 'IN' | 'ID' | 'IR' | 'IQ' | 'IE' | 'IM' | 'IL' | 'IT' | 'JM' | 'JP' | 'JE' | 'JO' | 'KZ' | 'KE' | 'KI' | 'KP' | 'KR' | 'XK' | 'KW' | 'KG' | 'LA' | 'LV' | 'LB' | 'LS' | 'LR' | 'LY' | 'LI' | 'LT' | 'LU' | 'MO' | 'MG' | 'MW' | 'MY' | 'MV' | 'ML' | 'MT' | 'MH' | 'MQ' | 'MR' | 'MU' | 'YT' | 'MX' | 'FM' | 'MD' | 'MC' | 'MN' | 'ME' | 'MS' | 'MA' | 'MZ' | 'MM' | 'NA' | 'NR' | 'NP' | 'NL' | 'NC' | 'NZ' | 'NI' | 'NE' | 'NG' | 'NU' | 'NF' | 'MK' | 'MP' | 'NO' | 'OM' | 'PK' | 'PW' | 'PS' | 'PA' | 'PG' | 'PY' | 'PE' | 'PH' | 'PN' | 'PL' | 'PT' | 'PR' | 'QA' | 'RE' | 'RO' | 'RU' | 'RW' | 'BL' | 'SH' | 'KN' | 'LC' | 'MF' | 'PM' | 'VC' | 'WS' | 'SM' | 'ST' | 'SA' | 'SN' | 'RS' | 'SC' | 'SL' | 'SG' | 'SX' | 'SK' | 'SI' | 'SB' | 'SO' | 'ZA' | 'GS' | 'SS' | 'ES' | 'LK' | 'SD' | 'SR' | 'SJ' | 'SE' | 'CH' | 'SY' | 'TW' | 'TJ' | 'TZ' | 'TH' | 'TL' | 'TG' | 'TK' | 'TO' | 'TT' | 'TN' | 'TR' | 'TM' | 'TC' | 'TV' | 'UG' | 'UA' | 'AE' | 'GB' | 'US' | 'UM' | 'UY' | 'UZ' | 'VU' | 'VE' | 'VN' | 'VG' | 'VI' | 'WF' | 'EH' | 'YE' | 'ZM' | 'ZW', required: ISO 3166-1 alpha-2 country codes.
        - `zip` string, nullable, required: Postal or ZIP code.
      - `idType` 'passport' | 'national_id' | 'foreigner_id' | 'temporary_permit' | 'minor_id' | 'driving_license' | 'resident_card' | 'tax_id' | 'other', required
      - `idNumber` string, nullable, required: Government identifier number for the holder.
      - `taxId` string, nullable, required: Tax identifier of the holder.
      - `nationality` string, nullable, required: ISO country code of the holder's nationality.
    - `bankName` string, nullable: Name of the receiving financial institution.
    - `paymentReference` string, nullable: Reference or memo that must accompany the account transfer.
    - `state` 'active' | 'pending' | 'closed', required
  - `qrPayload` string, nullable: Raw payload suitable for rendering as a payment QR code.
  - `url` string, nullable: Hosted URL where the incoming transfer can be funded.
  - `address` string, nullable: On-chain destination address.
  - `memo` string, nullable: Memo or destination tag required by the on-chain transfer.
  - `chainId` string, nullable: Network on which the destination address exists.

## Other responses

- `422`: Request validation failed

## Changes

- **2026-11-12** `299a3aa6f521`: 3 breaking, 1 warning, 26 info
  - removed `#/components/schemas/BankAddress` from the `payer/anyOf[subschema #1: PlatformPayinPayerAccount]/requisites/bankAddress` request property `anyOf` list
  - removed `#/components/schemas/IntermediaryBank` from the `payer/anyOf[subschema #1: PlatformPayinPayerAccount]/requisites/intermediaryBank` request property `anyOf` list
  - removed `#/components/schemas/UserAddress` from the `payer/anyOf[subschema #1: PlatformPayinPayerAccount]/requisites/holder/address` request property `anyOf` list
  - added the new `verification_not_applicable` enum value to the `error/code` response property for the response status `422`
  - …26 more
- **2026-10-23** `a02795de2d2b`: 9 warning, 5 info
  - deleted the `header` request parameter `x-api-key`
  - added the new `client_already_linked` enum value to the `error/code` response property for the response status `422`
  - added the new `kyb_documents_processing` enum value to the `error/code` response property for the response status `422`
  - added the new `link_code_expired` enum value to the `error/code` response property for the response status `422`
  - …10 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/instructions/post.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)