generated: '2026-08-08' method: derived source: openapi/bvnk-api-endpoints-openapi-original.yml, openapi/bvnk-layer1-digital-asset-openapi-original.yml note: 'Entity graph derived from components.schemas in the two published BVNK OpenAPI documents: $ref links become has_one/has_many edges and *Id/*Uuid/*Reference fields are recorded as identifier fields. Only the two published specs are covered — the ~200 endpoints documented on docs.bvnk.com but not published as machine-readable spec are NOT represented here.' domains: - name: Payments entities_prefix: - Payment - Payout - Payin - Quote - Refund - name: Channels entities_prefix: - Channel - name: Wallets & Ledger entities_prefix: - Wallet - Balance - Transaction - name: Digital Assets (Layer1) entities_prefix: - AssetPool - Address - KeyPair - Screening - Export - Network - name: Merchants entities_prefix: - Merchant identifier_conventions: uuid: Most BVNK resources are addressed by UUID path parameters (channel/{uuid}, quote/{uuid}, pay/{uuid}). wallet_id: Wallet identifiers use a compound form, e.g. acc:23090539331497:bVsk6:0. source: https://docs.bvnk.com/bvnk/get-started/payment-sim entity_count: 80 relationship_count: 79 entities: - name: Quote spec: openapi/bvnk-api-endpoints-openapi-original.yml field_count: 31 - name: MerchantChannelPayment spec: openapi/bvnk-api-endpoints-openapi-original.yml field_count: 24 id_fields: - channelId - merchantId - name: SummaryPaymentDto spec: openapi/bvnk-api-endpoints-openapi-original.yml field_count: 24 id_fields: - merchantId - name: Wallet spec: openapi/bvnk-api-endpoints-openapi-original.yml field_count: 19 - name: MerchantChannel spec: openapi/bvnk-api-endpoints-openapi-original.yml field_count: 16 id_fields: - merchantId - name: ScreeningView spec: openapi/bvnk-layer1-digital-asset-openapi-original.yml field_count: 16 id_fields: - transactionId - addressId - name: Currency spec: openapi/bvnk-api-endpoints-openapi-original.yml field_count: 14 - name: CurrencyFiat spec: openapi/bvnk-api-endpoints-openapi-original.yml field_count: 14 - name: Transaction spec: openapi/bvnk-layer1-digital-asset-openapi-original.yml field_count: 14 - name: Address spec: openapi/bvnk-layer1-digital-asset-openapi-original.yml field_count: 13 id_fields: - assetPoolId - keyPairId - customerId - name: TransactionReportRequestData spec: openapi/bvnk-api-endpoints-openapi-original.yml field_count: 12 id_fields: - walletId - name: TransactionRequest spec: openapi/bvnk-layer1-digital-asset-openapi-original.yml field_count: 12 id_fields: - requestId - assetPoolId - name: GatewayTransactionDto spec: openapi/bvnk-api-endpoints-openapi-original.yml field_count: 10 - name: Merchant spec: openapi/bvnk-api-endpoints-openapi-original.yml field_count: 10 id_fields: - merchantId - name: PayRequestDto spec: openapi/bvnk-api-endpoints-openapi-original.yml field_count: 9 id_fields: - merchantId - name: QuoteRequest spec: openapi/bvnk-api-endpoints-openapi-original.yml field_count: 9 - name: CreateStakingTransactionRequest spec: openapi/bvnk-layer1-digital-asset-openapi-original.yml field_count: 8 id_fields: - assetPoolId - name: Export spec: openapi/bvnk-layer1-digital-asset-openapi-original.yml field_count: 8 - name: TransactionReport spec: openapi/bvnk-api-endpoints-openapi-original.yml field_count: 8 - name: Balance spec: openapi/bvnk-api-endpoints-openapi-original.yml field_count: 7 id_fields: - walletId - name: CreateTransactionRequest spec: openapi/bvnk-layer1-digital-asset-openapi-original.yml field_count: 6 id_fields: - assetPoolId - name: PayInMethod spec: openapi/bvnk-api-endpoints-openapi-original.yml field_count: 6 - name: Balance spec: openapi/bvnk-layer1-digital-asset-openapi-original.yml field_count: 5 - name: CreateAddressRequest spec: openapi/bvnk-layer1-digital-asset-openapi-original.yml field_count: 5 id_fields: - assetPoolId - customerId - name: CreateBalanceExportRequest spec: openapi/bvnk-layer1-digital-asset-openapi-original.yml field_count: 5 id_fields: - assetPoolId - name: CryptoAddressDto spec: openapi/bvnk-api-endpoints-openapi-original.yml field_count: 5 - name: ExternalCurrencyWithdrawalParameter spec: openapi/bvnk-api-endpoints-openapi-original.yml field_count: 5 - name: ManualActionRequest spec: openapi/bvnk-layer1-digital-asset-openapi-original.yml field_count: 5 id_fields: - transferId - addressId - name: PayOutDetailDto spec: openapi/bvnk-api-endpoints-openapi-original.yml field_count: 5 - name: PaymentLeg spec: openapi/bvnk-api-endpoints-openapi-original.yml field_count: 5 - name: AlternativeAddress spec: openapi/bvnk-api-endpoints-openapi-original.yml field_count: 4 - name: ApiError spec: openapi/bvnk-layer1-digital-asset-openapi-original.yml field_count: 4 - name: CurrencyOptions spec: openapi/bvnk-api-endpoints-openapi-original.yml field_count: 4 - name: EstimateTransactionFeeRequest spec: openapi/bvnk-layer1-digital-asset-openapi-original.yml field_count: 4 - name: KeyPair spec: openapi/bvnk-layer1-digital-asset-openapi-original.yml field_count: 4 id_fields: - assetPoolId - name: MerchantChannelRequest spec: openapi/bvnk-api-endpoints-openapi-original.yml field_count: 4 id_fields: - merchantId - name: Network spec: openapi/bvnk-layer1-digital-asset-openapi-original.yml field_count: 4 - name: NetworkFee spec: openapi/bvnk-api-endpoints-openapi-original.yml field_count: 4 - name: Participant spec: openapi/bvnk-layer1-digital-asset-openapi-original.yml field_count: 4 - name: PayInInstruction spec: openapi/bvnk-api-endpoints-openapi-original.yml field_count: 4 - name: PayOutMethod spec: openapi/bvnk-api-endpoints-openapi-original.yml field_count: 4 - name: Asset spec: openapi/bvnk-layer1-digital-asset-openapi-original.yml field_count: 3 - name: CreateKeyPairRequest spec: openapi/bvnk-layer1-digital-asset-openapi-original.yml field_count: 3 id_fields: - assetPoolId - name: ExchangeRateDto spec: openapi/bvnk-api-endpoints-openapi-original.yml field_count: 3 - name: PaginatedExports spec: openapi/bvnk-layer1-digital-asset-openapi-original.yml field_count: 3 - name: PaginatedResultAddress spec: openapi/bvnk-layer1-digital-asset-openapi-original.yml field_count: 3 - name: PaginatedResultKeyPair spec: openapi/bvnk-layer1-digital-asset-openapi-original.yml field_count: 3 - name: PaginatedResultTransaction spec: openapi/bvnk-layer1-digital-asset-openapi-original.yml field_count: 3 - name: PaginatedResultTransactionRequest spec: openapi/bvnk-layer1-digital-asset-openapi-original.yml field_count: 3 - name: PaginatedScreenings spec: openapi/bvnk-layer1-digital-asset-openapi-original.yml field_count: 3 - name: PayAmountsDto spec: openapi/bvnk-api-endpoints-openapi-original.yml field_count: 3 - name: ValidateAddressRequest spec: openapi/bvnk-layer1-digital-asset-openapi-original.yml field_count: 3 - name: ValidationErrorDto spec: openapi/bvnk-api-endpoints-openapi-original.yml field_count: 3 - name: merchantIdCreate_request spec: openapi/bvnk-api-endpoints-openapi-original.yml field_count: 3 - name: AcceptedQuote spec: openapi/bvnk-api-endpoints-openapi-original.yml field_count: 2 - name: AccountMethod spec: openapi/bvnk-api-endpoints-openapi-original.yml field_count: 2 - name: AssetValue spec: openapi/bvnk-layer1-digital-asset-openapi-original.yml field_count: 2 - name: BlockDetail spec: openapi/bvnk-layer1-digital-asset-openapi-original.yml field_count: 2 - name: CreateAssetPoolRequest spec: openapi/bvnk-layer1-digital-asset-openapi-original.yml field_count: 2 - name: CurrencyProtocol spec: openapi/bvnk-api-endpoints-openapi-original.yml field_count: 2 - name: Detail spec: openapi/bvnk-layer1-digital-asset-openapi-original.yml field_count: 2 - name: Failure spec: openapi/bvnk-layer1-digital-asset-openapi-original.yml field_count: 2 - name: Fee spec: openapi/bvnk-api-endpoints-openapi-original.yml field_count: 2 - name: Fees spec: openapi/bvnk-api-endpoints-openapi-original.yml field_count: 2 - name: Form spec: openapi/bvnk-api-endpoints-openapi-original.yml field_count: 2 - name: NetworkDetail spec: openapi/bvnk-layer1-digital-asset-openapi-original.yml field_count: 2 - name: Pageable spec: openapi/bvnk-layer1-digital-asset-openapi-original.yml field_count: 2 - name: PayOutInstruction spec: openapi/bvnk-api-endpoints-openapi-original.yml field_count: 2 - name: ReturnRequest spec: openapi/bvnk-layer1-digital-asset-openapi-original.yml field_count: 2 id_fields: - transactionId - name: ScreeningMetadata spec: openapi/bvnk-layer1-digital-asset-openapi-original.yml field_count: 2 - name: ServerErrorDto spec: openapi/bvnk-api-endpoints-openapi-original.yml field_count: 2 - name: TransactionClaimRequest spec: openapi/bvnk-layer1-digital-asset-openapi-original.yml field_count: 2 - name: UpdateAssetPoolRequest spec: openapi/bvnk-layer1-digital-asset-openapi-original.yml field_count: 2 - name: ValidateAddressResponse spec: openapi/bvnk-layer1-digital-asset-openapi-original.yml field_count: 2 - name: WalletRequest spec: openapi/bvnk-api-endpoints-openapi-original.yml field_count: 2 - name: AssetPoolSummary spec: openapi/bvnk-layer1-digital-asset-openapi-original.yml field_count: 1 - name: ClientValidationErrorDto spec: openapi/bvnk-api-endpoints-openapi-original.yml field_count: 1 - name: PayInDetailDto spec: openapi/bvnk-api-endpoints-openapi-original.yml field_count: 1 - name: TransactionMetadata spec: openapi/bvnk-layer1-digital-asset-openapi-original.yml field_count: 1 - name: merchantIdCreate_request_wallet spec: openapi/bvnk-api-endpoints-openapi-original.yml field_count: 1 relationships: - from: Currency to: CurrencyOptions type: has_one via: options spec: openapi/bvnk-api-endpoints-openapi-original.yml - from: Currency to: CurrencyProtocol type: has_many via: protocols spec: openapi/bvnk-api-endpoints-openapi-original.yml - from: Currency to: ExternalCurrencyWithdrawalParameter type: has_many via: withdrawalParameters spec: openapi/bvnk-api-endpoints-openapi-original.yml - from: Merchant to: Wallet type: has_one via: wallet spec: openapi/bvnk-api-endpoints-openapi-original.yml - from: Wallet to: Currency type: has_one via: currency spec: openapi/bvnk-api-endpoints-openapi-original.yml - from: PayRequestDto to: DirectionDto type: has_one via: type spec: openapi/bvnk-api-endpoints-openapi-original.yml - from: PayRequestDto to: PayInDetailDto type: has_one via: payInDetails spec: openapi/bvnk-api-endpoints-openapi-original.yml - from: PayRequestDto to: PayOutDetailDto type: has_one via: payOutDetails spec: openapi/bvnk-api-endpoints-openapi-original.yml - from: SummaryPaymentDto to: DirectionDto type: has_one via: type spec: openapi/bvnk-api-endpoints-openapi-original.yml - from: SummaryPaymentDto to: PaymentStatusDto type: has_one via: status spec: openapi/bvnk-api-endpoints-openapi-original.yml - from: SummaryPaymentDto to: PayAmountsDto type: has_one via: displayCurrency spec: openapi/bvnk-api-endpoints-openapi-original.yml - from: SummaryPaymentDto to: PayAmountsDto type: has_one via: walletCurrency spec: openapi/bvnk-api-endpoints-openapi-original.yml - from: SummaryPaymentDto to: PayAmountsDto type: has_one via: paidCurrency spec: openapi/bvnk-api-endpoints-openapi-original.yml - from: SummaryPaymentDto to: PayAmountsDto type: has_one via: feeCurrency spec: openapi/bvnk-api-endpoints-openapi-original.yml - from: SummaryPaymentDto to: ExchangeRateDto type: has_one via: displayRate spec: openapi/bvnk-api-endpoints-openapi-original.yml - from: SummaryPaymentDto to: ExchangeRateDto type: has_one via: exchangeRate spec: openapi/bvnk-api-endpoints-openapi-original.yml - from: SummaryPaymentDto to: CryptoAddressDto type: has_one via: address spec: openapi/bvnk-api-endpoints-openapi-original.yml - from: SummaryPaymentDto to: GatewayTransactionDto type: has_many via: transactions spec: openapi/bvnk-api-endpoints-openapi-original.yml - from: CryptoAddressDto to: AlternativeAddress type: has_many via: alternatives spec: openapi/bvnk-api-endpoints-openapi-original.yml - from: GatewayTransactionDto to: ExchangeRateDto type: has_one via: displayRate spec: openapi/bvnk-api-endpoints-openapi-original.yml - from: GatewayTransactionDto to: ExchangeRateDto type: has_one via: exchangeRate spec: openapi/bvnk-api-endpoints-openapi-original.yml - from: ClientValidationErrorDto to: ValidationErrorDto type: has_many via: errorList spec: openapi/bvnk-api-endpoints-openapi-original.yml - from: MerchantChannel to: AlternativeAddress type: has_many via: alternatives spec: openapi/bvnk-api-endpoints-openapi-original.yml - from: MerchantChannelPayment to: ExchangeRateDto type: has_one via: exchangeRate spec: openapi/bvnk-api-endpoints-openapi-original.yml - from: MerchantChannelPayment to: ExchangeRateDto type: has_one via: displayRate spec: openapi/bvnk-api-endpoints-openapi-original.yml - from: MerchantChannelPayment to: ExchangeRateDto type: has_one via: risk spec: openapi/bvnk-api-endpoints-openapi-original.yml - from: MerchantChannelPayment to: NetworkFee type: has_one via: networkFee spec: openapi/bvnk-api-endpoints-openapi-original.yml - from: Balance to: Currency type: has_one via: currency spec: openapi/bvnk-api-endpoints-openapi-original.yml - from: TransactionReport to: TransactionReportRequestData type: has_one via: requestData spec: openapi/bvnk-api-endpoints-openapi-original.yml - from: Quote to: PaymentLeg type: has_many via: payInLegs spec: openapi/bvnk-api-endpoints-openapi-original.yml - from: Quote to: PayInMethod type: has_one via: payInMethod spec: openapi/bvnk-api-endpoints-openapi-original.yml - from: Quote to: PayOutMethod type: has_one via: payOutMethod spec: openapi/bvnk-api-endpoints-openapi-original.yml - from: Quote to: PayOutInstruction type: has_one via: payOutInstruction spec: openapi/bvnk-api-endpoints-openapi-original.yml - from: Quote to: PayInInstruction type: has_one via: payInInstruction spec: openapi/bvnk-api-endpoints-openapi-original.yml - from: Quote to: AccountMethod type: has_one via: usePayInMethod spec: openapi/bvnk-api-endpoints-openapi-original.yml - from: Quote to: AccountMethod type: has_one via: usePayOutMethod spec: openapi/bvnk-api-endpoints-openapi-original.yml - from: Quote to: Fees type: has_one via: fees spec: openapi/bvnk-api-endpoints-openapi-original.yml - from: PayInMethod to: AccountMethod type: has_many via: accountMethods spec: openapi/bvnk-api-endpoints-openapi-original.yml - from: PayOutMethod to: AccountMethod type: has_many via: accountMethods spec: openapi/bvnk-api-endpoints-openapi-original.yml - from: PayInInstruction to: Form type: has_one via: form spec: openapi/bvnk-api-endpoints-openapi-original.yml - from: AcceptedQuote to: Quote type: has_one via: quote spec: openapi/bvnk-api-endpoints-openapi-original.yml - from: AcceptedQuote to: PayInInstruction type: has_one via: payInInstruction spec: openapi/bvnk-api-endpoints-openapi-original.yml - from: Fees to: Fee type: has_one via: percentage spec: openapi/bvnk-api-endpoints-openapi-original.yml - from: Fees to: Fee type: has_one via: value spec: openapi/bvnk-api-endpoints-openapi-original.yml - from: merchantIdCreate_request to: merchantIdCreate_request_wallet type: has_one via: wallet spec: openapi/bvnk-api-endpoints-openapi-original.yml - from: ApiError to: Detail type: has_one via: details spec: openapi/bvnk-layer1-digital-asset-openapi-original.yml - from: TransactionRequest to: Participant type: has_many via: sources spec: openapi/bvnk-layer1-digital-asset-openapi-original.yml - from: TransactionRequest to: Participant type: has_many via: destinations spec: openapi/bvnk-layer1-digital-asset-openapi-original.yml - from: TransactionRequest to: Failure type: has_one via: failure spec: openapi/bvnk-layer1-digital-asset-openapi-original.yml - from: CreateTransactionRequest to: Participant type: has_many via: sources spec: openapi/bvnk-layer1-digital-asset-openapi-original.yml - from: CreateTransactionRequest to: Participant type: has_many via: destinations spec: openapi/bvnk-layer1-digital-asset-openapi-original.yml - from: EstimateTransactionFeeRequest to: Participant type: has_many via: sources spec: openapi/bvnk-layer1-digital-asset-openapi-original.yml - from: EstimateTransactionFeeRequest to: Participant type: has_many via: destinations spec: openapi/bvnk-layer1-digital-asset-openapi-original.yml - from: Address to: Balance type: has_many via: balances spec: openapi/bvnk-layer1-digital-asset-openapi-original.yml - from: NetworkDetail to: BlockDetail type: has_one via: block spec: openapi/bvnk-layer1-digital-asset-openapi-original.yml - from: NetworkDetail to: AssetValue type: has_one via: fee spec: openapi/bvnk-layer1-digital-asset-openapi-original.yml - from: PaginatedResultTransaction to: Transaction type: has_many via: content spec: openapi/bvnk-layer1-digital-asset-openapi-original.yml - from: PaginatedResultTransaction to: Pageable type: has_one via: pageable spec: openapi/bvnk-layer1-digital-asset-openapi-original.yml - from: Transaction to: Address type: has_one via: address spec: openapi/bvnk-layer1-digital-asset-openapi-original.yml - from: Transaction to: Participant type: has_many via: sources spec: openapi/bvnk-layer1-digital-asset-openapi-original.yml - from: Transaction to: Participant type: has_many via: destinations spec: openapi/bvnk-layer1-digital-asset-openapi-original.yml - from: Transaction to: NetworkDetail type: has_one via: networkDetail spec: openapi/bvnk-layer1-digital-asset-openapi-original.yml - from: Transaction to: TransactionMetadata type: has_one via: metadata spec: openapi/bvnk-layer1-digital-asset-openapi-original.yml - from: TransactionMetadata to: Failure type: has_one via: failure spec: openapi/bvnk-layer1-digital-asset-openapi-original.yml - from: PaginatedResultTransactionRequest to: TransactionRequest type: has_many via: content spec: openapi/bvnk-layer1-digital-asset-openapi-original.yml - from: PaginatedResultTransactionRequest to: Pageable type: has_one via: pageable spec: openapi/bvnk-layer1-digital-asset-openapi-original.yml - from: PaginatedScreenings to: ScreeningView type: has_many via: content spec: openapi/bvnk-layer1-digital-asset-openapi-original.yml - from: PaginatedScreenings to: Pageable type: has_one via: pageable spec: openapi/bvnk-layer1-digital-asset-openapi-original.yml - from: ScreeningView to: TransactionMetadata type: has_one via: transactionMetadata spec: openapi/bvnk-layer1-digital-asset-openapi-original.yml - from: ScreeningView to: ScreeningMetadata type: has_one via: screeningMetadata spec: openapi/bvnk-layer1-digital-asset-openapi-original.yml - from: ScreeningView to: Participant type: has_many via: participants spec: openapi/bvnk-layer1-digital-asset-openapi-original.yml - from: Network to: Asset type: has_many via: supportedAssets spec: openapi/bvnk-layer1-digital-asset-openapi-original.yml - from: PaginatedResultKeyPair to: KeyPair type: has_many via: content spec: openapi/bvnk-layer1-digital-asset-openapi-original.yml - from: PaginatedResultKeyPair to: Pageable type: has_one via: pageable spec: openapi/bvnk-layer1-digital-asset-openapi-original.yml - from: PaginatedExports to: Export type: has_many via: content spec: openapi/bvnk-layer1-digital-asset-openapi-original.yml - from: PaginatedExports to: Pageable type: has_one via: pageable spec: openapi/bvnk-layer1-digital-asset-openapi-original.yml - from: AssetPoolSummary to: Balance type: has_many via: balances spec: openapi/bvnk-layer1-digital-asset-openapi-original.yml - from: PaginatedResultAddress to: Address type: has_many via: content spec: openapi/bvnk-layer1-digital-asset-openapi-original.yml - from: PaginatedResultAddress to: Pageable type: has_one via: pageable spec: openapi/bvnk-layer1-digital-asset-openapi-original.yml