> ## Documentation Index > Fetch the complete documentation index at: https://hevninc.mintlify.site/llms.txt > Use this file to discover all available pages before exploring further. > ## Agent Instructions > HEVN has two products and they authorize money differently. Self-serve (the General tab): the person who owns the email holds the only key and signs for themselves. Whitelabel (the Whitelabel and REST API tabs): the integrator's backend holds a developer key, signs on behalf of client accounts it created, and HEVN co-signs. Never mix the two models in an answer. > Use HEVN's terms exactly. A rail is a bank route a client can request. A virtual account (bnk_) is an opened rail. Account details are what a payer needs in order to wire money, and arrive in a field named requisites. A client is an account the integrator created; the business behind it is the integrator's customer. A contact is a saved destination; a beneficiary is the party at the far end of a fiat payout. Every departure of money is a payout, to a bank account or to a wallet alike. > Never name a banking partner. Say 'a licensed banking partner'. > There are no published fee rates, spreads or minimums. Prices come from a quote on a specific payment; direct pricing questions to HEVN rather than inventing numbers. > The whitelabel API is at /dapi/v1 and takes a developer-key session plus an X-Hevn-Account header. The CLI uses an app API key in X-Api-Key. They are different credentials and neither works on the other surface. # Retrieve an incoming transfer > Retrieve an incoming-transfer quote and its current funding lifecycle. Use the instructions operation when payment details are still required. ## OpenAPI ````yaml /openapi.json get /payins/{payinId} openapi: 3.1.0 info: title: HEVN Platform API description: >- HEVN's account, verification and money-movement API. Verification follows a submission workflow: save applicant info and documents, inspect outstanding requirements, then explicitly complete the submission to send an immutable snapshot for review. Completing a submission is separate from editing it. version: 1.0.0 servers: [] security: [] tags: - name: auth description: Authenticate an integration and issue short-lived account sessions. - name: accounts description: Create and manage business or individual customer accounts. - name: verification description: >- Collect business-applicant and related-individual information, inspect requirements, and complete a verification submission for review. - name: documents description: Upload verification and payment evidence for later reference by id. - name: virtual accounts description: Discover payment methods and create persistent receiving account details. - name: transfers description: Quote, create, authorize and track incoming or outgoing transfers. - name: contacts description: Create saved contacts and inspect their available payment channels. - name: transactions description: Read and export the account ledger. - name: escrow description: Create, authorize and reconcile on-chain escrow agreements. - name: sandbox description: Emulate funding and lifecycle events in the sandbox environment. paths: /payins/{payinId}: get: tags: - transfers summary: Retrieve an incoming transfer description: >- Retrieve an incoming-transfer quote and its current funding lifecycle. Use the instructions operation when payment details are still required. operationId: read_payin_payins__payinId__get parameters: - name: payinId in: path required: true schema: type: string description: Prefixed pay-in id title: Payinid description: Prefixed pay-in id - name: X-Hevn-Account in: header required: false schema: anyOf: - type: string - type: 'null' description: >- The client account to act for, as a `cl_…` id. Omit it to act as yourself. examples: - cl_9f2c1ab84d7e4f1fa3c65b0e7d9a2c41 title: X-Hevn-Account description: >- The client account to act for, as a `cl_…` id. Omit it to act as yourself. - name: x-api-key in: header required: false schema: anyOf: - type: string - type: 'null' title: X-Api-Key responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/PayinView' '422': description: Request validation failed content: application/json: schema: $ref: '#/components/schemas/PlatformErrorResponse' security: - HTTPBearer: [] components: schemas: PayinView: properties: id: type: string pattern: ^(?:pi_)?[A-Za-z0-9._:\-]{1,216}$ title: Id description: Stable public identifier for this incoming transfer. examples: - pi_9f2c1ab84d7e4f1fa3c65b0e7d9a2c41 status: $ref: '#/components/schemas/PayinState' description: Current public lifecycle status of the incoming transfer. rail: anyOf: - $ref: '#/components/schemas/FiatPaymentType' - type: 'null' description: Local payment method, when account-funded. quote: $ref: '#/components/schemas/PayinQuoteView' description: Price, fee and conversion terms fixed for this incoming transfer. paymentReference: anyOf: - type: string - type: 'null' title: Paymentreference description: Reference that must accompany the account transfer. originChainId: anyOf: - type: string - type: 'null' title: Originchainid description: Network from which an on-chain transfer is funded. destinationChainId: anyOf: - type: string - type: 'null' title: Destinationchainid description: Network on which the transfer settles. expiresAt: anyOf: - type: string format: date-time - type: 'null' title: Expiresat description: UTC timestamp after which the quote is no longer valid. createdAt: type: string format: date-time title: Createdat description: UTC timestamp when the incoming transfer was created. type: object required: - id - status - quote - createdAt title: PayinView PlatformErrorResponse: properties: error: $ref: '#/components/schemas/PlatformErrorBody' description: Public error body. type: object required: - error title: PlatformErrorResponse PayinState: type: string enum: - pending - awaitingFunds - processing - inReview - completed - failed - refunded - canceled title: PayinState FiatPaymentType: type: string enum: - 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 title: FiatPaymentType PayinQuoteView: properties: amount: type: string title: Amount description: Amount funded in the source currency. example: '500.00' currency: type: string title: Currency description: Source currency or digital asset. settlementAmount: type: string title: Settlementamount description: Amount delivered in the settlement asset. example: '500.00' destinationAccount: type: string title: Destinationaccount description: Digital asset used to settle the incoming transfer. feeAmount: anyOf: - type: string example: '500.00' - type: 'null' title: Feeamount description: Fee charged in feeCurrency. feeCurrency: anyOf: - type: string - type: 'null' title: Feecurrency description: Currency in which the fee is charged. rate: anyOf: - type: string example: '500.00' - type: 'null' title: Rate description: Conversion rate from source amount to settlement amount. type: object required: - amount - currency - settlementAmount - destinationAccount title: PayinQuoteView PlatformErrorBody: properties: code: $ref: '#/components/schemas/PlatformErrorCode' description: Stable machine-readable error code. message: type: string title: Message description: Human-readable explanation safe to show to an end user. details: anyOf: - additionalProperties: true type: object - type: 'null' title: Details description: Structured context for this error, when available. type: object required: - code - message title: PlatformErrorBody PlatformErrorCode: type: string enum: - invalid_request - validation_failed - invalid_cursor - invalid_id - idempotency_key_invalid - idempotency_key_reused - unauthenticated - token_expired - forbidden - not_found - method_not_allowed - conflict - gone - payload_too_large - rate_limited - provider_unavailable - database_unavailable - internal_error - invalid_credentials - request_expired - challenge_not_found - challenge_consumed - challenge_expired - signature_invalid - key_not_registered - signer_not_attached - wallet_not_linked - approval_consumed - approval_expired - approval_mismatch - signing_policy_refused - login_unavailable - login_mode_unavailable - developer_key_not_found - developer_key_already_exists - account_header_invalid - account_scope_conflict - account_not_found - account_forbidden - account_read_only - account_not_controlled - contact_not_found - quote_not_submitted - quote_not_fundable - funding_mode_unsupported - funding_token_unsupported - insufficient_funds - smart_wallet_not_deployed - wallet_owner_unverified - already_funded - payment_slot_consumed - funding_in_progress - funding_attempt_expired - contact_changed - user_operation_rejected - user_operation_unavailable - integrator_inactive - client_creation_not_enabled - email_in_use - name_in_use - client_request_conflict - client_not_found - profile_locked - contact_not_payable - contact_chain_unsupported - contact_token_unsupported - contact_payment_details_invalid - amount_below_minimum - amount_above_maximum - amount_precision_unsupported - payout_not_found - payout_not_fundable - quote_expired - bundler_rejected - bundler_unavailable - contact_details_invalid - contact_in_use - kyb_incomplete - kyb_roster_conflict - kyb_subject_conflict - document_fields_missing - document_not_found - document_type_unsupported - invalid_enum_value - entity_not_found - escrow_not_found - escrow_action_not_found - escrow_not_operated_by_you - escrow_state_changed - action_in_flight - simulation_failed - stale_nonce - amount_out_of_range - amount_not_allowed - window_closed - token_not_supported - receiver_not_a_client - rail_not_found - rail_not_available - rail_requirements_unmet - phone_required - payin_not_available - payin_expired - payin_not_found - transaction_not_found title: PlatformErrorCode securitySchemes: HTTPBearer: type: http scheme: bearer ````