> ## 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. # Create an outgoing transfer > Validate the contact, fix the transfer terms, reserve an idempotent outgoing transfer and return the approval payload to sign. Supplying `amount` fixes the debit side; `amountTo` fixes the contact side. ## OpenAPI ````yaml /openapi.json post /payouts 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: /payouts: post: tags: - transfers summary: Create an outgoing transfer description: >- Validate the contact, fix the transfer terms, reserve an idempotent outgoing transfer and return the approval payload to sign. Supplying `amount` fixes the debit side; `amountTo` fixes the contact side. operationId: create_payout_payouts_post parameters: - 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 - name: Idempotency-Key in: header required: false schema: anyOf: - type: string - type: 'null' description: >- 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. examples: - po-inv-2026-114 title: Idempotency-Key description: >- 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. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/PayoutCreateRequest' responses: '201': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/PayoutResponse' '422': description: Request validation failed content: application/json: schema: $ref: '#/components/schemas/PlatformErrorResponse' security: - HTTPBearer: [] components: schemas: PayoutCreateRequest: properties: contactId: type: string pattern: ^(?:ct_)?[A-Za-z0-9._:\-]{1,216}$ title: Contactid description: Saved contact to receive this transfer. examples: - ct_9f2c1ab84d7e4f1fa3c65b0e7d9a2c41 amount: anyOf: - anyOf: - type: number - type: string pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$ type: string example: '500.00' - type: 'null' title: Amount description: Exact amount to debit in the source currency. amountTo: anyOf: - anyOf: - type: number - type: string pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$ type: string example: '500.00' - type: 'null' title: Amountto description: Exact amount the contact should receive. publicKey: type: string maxLength: 512 minLength: 1 title: Publickey description: >- Base64 DER SubjectPublicKeyInfo for the registered P-256 developer key. paymentReference: anyOf: - type: string maxLength: 140 - type: 'null' title: Paymentreference description: Reference or memo delivered with the transfer. purpose: anyOf: - type: string maxLength: 64 - type: 'null' title: Purpose description: Business purpose or reason for the transfer. documentIds: items: type: string pattern: ^(?:doc_)?[A-Za-z0-9._:\-]{1,216}$ examples: - doc_9f2c1ab84d7e4f1fa3c65b0e7d9a2c41 type: array maxItems: 10 title: Documentids description: Supporting document identifiers returned by POST /dapi/v1/documents. bankId: anyOf: - type: string pattern: ^(?:bnk_)?[A-Za-z0-9._:\-]{1,216}$ examples: - bnk_9f2c1ab84d7e4f1fa3c65b0e7d9a2c41 - type: 'null' title: Bankid description: >- Optional receiving-account identifier used to select a specific funding route. sourceAccount: $ref: '#/components/schemas/BalanceAccount' description: >- Settlement token this payout is funded with. The contact and the rail decide whether it can be used. default: USDC additionalProperties: false type: object required: - contactId - publicKey title: PayoutCreateRequest PayoutResponse: properties: id: type: string title: Id description: Stable public identifier for this outgoing transfer. kind: $ref: '#/components/schemas/PayoutKind' description: Whether the contact is account-based or on-chain. status: $ref: '#/components/schemas/PayoutStatus' description: Current public lifecycle status of the transfer. idempotencyKey: type: string title: Idempotencykey description: >- Caller-supplied key that makes an identical retry return this result. quote: anyOf: - $ref: '#/components/schemas/PayoutQuoteView' - type: 'null' description: Price, fee and conversion terms fixed for this transfer. approval: anyOf: - $ref: '#/components/schemas/PayoutApprovalView' - type: 'null' description: Authorization to sign before execution. debit: anyOf: - $ref: '#/components/schemas/PayoutDebitView' - type: 'null' description: Exact on-chain debit used to fund this transfer. contact: anyOf: - $ref: '#/components/schemas/PayoutContactView' - type: 'null' description: Contact snapshot fixed at creation. type: object required: - id - kind - status - idempotencyKey title: PayoutResponse PlatformErrorResponse: properties: error: $ref: '#/components/schemas/PlatformErrorBody' description: Public error body. type: object required: - error title: PlatformErrorResponse BalanceAccount: type: string enum: - USDC - EURC title: BalanceAccount PayoutKind: type: string enum: - fiat - onchain title: PayoutKind PayoutStatus: type: string enum: - awaitingSignature - submitted - settled - failed - refunded title: PayoutStatus PayoutQuoteView: properties: fromAmount: type: string title: Fromamount description: Amount debited in the source currency. example: '500.00' fromCurrency: type: string title: Fromcurrency description: Currency debited by the quote. toAmount: type: string title: Toamount description: Amount delivered in the destination currency. example: '500.00' toCurrency: type: string title: Tocurrency description: Currency delivered by the quote. rate: anyOf: - type: string example: '500.00' - type: 'null' title: Rate description: Conversion rate from source to destination amount. 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. expiresAt: anyOf: - type: string format: date-time - type: 'null' title: Expiresat description: UTC timestamp after which the quote is no longer valid. fromChainId: anyOf: - type: string - type: 'null' title: Fromchainid description: Network from which the transfer is funded. toChainId: anyOf: - type: string - type: 'null' title: Tochainid description: Network on which the contact receives the transfer. type: object required: - fromAmount - fromCurrency - toAmount - toCurrency title: PayoutQuoteView PayoutApprovalView: properties: id: type: string title: Id description: Single-use approval identifier. payload: type: string title: Payload description: >- Base64 canonical authorization payload to sign with the developer key. expiresAt: type: string format: date-time title: Expiresat description: UTC timestamp after which this approval is refused. type: object required: - id - payload - expiresAt title: PayoutApprovalView PayoutDebitView: properties: address: type: string title: Address description: On-chain address receiving the funding debit. amount: type: string title: Amount description: Human-readable token amount debited. example: '500.00' amountAtomic: type: string title: Amountatomic description: Integer token amount in the asset's smallest unit. token: type: string title: Token description: Digital asset debited to fund the transfer. chainId: type: integer title: Chainid description: Numeric network identifier on which the debit executes. type: object required: - address - amount - amountAtomic - token - chainId title: PayoutDebitView PayoutContactView: properties: contactId: anyOf: - type: string pattern: ^(?:ct_)?[A-Za-z0-9._:\-]{1,216}$ examples: - ct_9f2c1ab84d7e4f1fa3c65b0e7d9a2c41 - type: 'null' title: Contactid description: Saved contact associated with the transfer. name: anyOf: - type: string - type: 'null' title: Name description: Human-readable contact name. address: anyOf: - type: string - type: 'null' title: Address description: On-chain destination address, when applicable. chainId: anyOf: - type: string - type: 'null' title: Chainid description: Network on which the contact receives funds. token: anyOf: - type: string - type: 'null' title: Token description: Digital asset the contact receives, when applicable. type: object title: PayoutContactView 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 ````