> For the complete documentation index, see [llms.txt](https://docs.skylinebridge.tech/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.skylinebridge.tech/web-api/models.md).

# Models

## The NativeTokenDto object

```json
{"openapi":"3.0.0","info":{"title":"Web API","version":"1.0"},"components":{"schemas":{"NativeTokenDto":{"type":"object","properties":{"dstChainID":{"type":"string","description":"Destination chain ID"},"tokenName":{"type":"string","description":"Native token name"}},"required":["dstChainID","tokenName"]}}}}
```

## The BridgingSettingsDto object

```json
{"openapi":"3.0.0","info":{"title":"Web API","version":"1.0"},"components":{"schemas":{"BridgingSettingsDto":{"type":"object","properties":{"minChainFeeForBridging":{"type":"object","description":"For each chain, the minimum fee required to cover the submission of the transaction on the destination chain","additionalProperties":{"type":"number"}},"minOperationFee":{"type":"object","description":"For each chain, the minimum fee required to cover operational costs","additionalProperties":{"type":"number"}},"minUtxoChainValue":{"type":"object","description":"For each chain, the minimum allowed UTXO value","additionalProperties":{"type":"number"}},"minValueToBridge":{"type":"number","description":"Minimum value allowed to be bridged"},"maxAmountAllowedToBridge":{"type":"string","description":"Maximum amount of currency allowed to be bridged"},"maxTokenAmountAllowedToBridge":{"type":"string","description":"Maximum amount of native tokens allowed to be bridged"},"maxReceiversPerBridgingRequest":{"type":"number","description":"Maximum number of receivers allowed in a bridging request"}},"required":["minChainFeeForBridging","minOperationFee","minUtxoChainValue","minValueToBridge","maxAmountAllowedToBridge","maxTokenAmountAllowedToBridge","maxReceiversPerBridgingRequest"]}}}}
```

## The SettingsResponseDto object

```json
{"openapi":"3.0.0","info":{"title":"Web API","version":"1.0"},"components":{"schemas":{"SettingsResponseDto":{"type":"object","properties":{"runMode":{"type":"string","description":"Specifies the current operating mode of the application"},"cardanoChainsNativeTokens":{"type":"object","description":"For each source chain, defines the native token that will be received on the destination chain","additionalProperties":{"type":"array","items":{"$ref":"#/components/schemas/NativeTokenDto"}}},"bridgingSettings":{"description":"Settings for bridge","allOf":[{"$ref":"#/components/schemas/BridgingSettingsDto"}]},"enabledChains":{"description":"Participating chains in the bridge","type":"array","items":{"type":"string"}}},"required":["runMode","cardanoChainsNativeTokens","bridgingSettings","enabledChains"]},"NativeTokenDto":{"type":"object","properties":{"dstChainID":{"type":"string","description":"Destination chain ID"},"tokenName":{"type":"string","description":"Native token name"}},"required":["dstChainID","tokenName"]},"BridgingSettingsDto":{"type":"object","properties":{"minChainFeeForBridging":{"type":"object","description":"For each chain, the minimum fee required to cover the submission of the transaction on the destination chain","additionalProperties":{"type":"number"}},"minOperationFee":{"type":"object","description":"For each chain, the minimum fee required to cover operational costs","additionalProperties":{"type":"number"}},"minUtxoChainValue":{"type":"object","description":"For each chain, the minimum allowed UTXO value","additionalProperties":{"type":"number"}},"minValueToBridge":{"type":"number","description":"Minimum value allowed to be bridged"},"maxAmountAllowedToBridge":{"type":"string","description":"Maximum amount of currency allowed to be bridged"},"maxTokenAmountAllowedToBridge":{"type":"string","description":"Maximum amount of native tokens allowed to be bridged"},"maxReceiversPerBridgingRequest":{"type":"number","description":"Maximum number of receivers allowed in a bridging request"}},"required":["minChainFeeForBridging","minOperationFee","minUtxoChainValue","minValueToBridge","maxAmountAllowedToBridge","maxTokenAmountAllowedToBridge","maxReceiversPerBridgingRequest"]}}}}
```

## The CreateTransactionDto object

```json
{"openapi":"3.0.0","info":{"title":"Web API","version":"1.0"},"components":{"schemas":{"CreateTransactionDto":{"type":"object","properties":{"senderAddress":{"type":"string","description":"Address that initiates the bridging request on the source chain"},"originChain":{"type":"string","description":"Source chain ID","enum":["cardano","prime"]},"destinationChain":{"type":"string","description":"Destination chain ID","enum":["cardano","prime"]},"destinationAddress":{"type":"string","description":"Receiver address on destination chain"},"amount":{"type":"string","description":"Amount to be bridged"},"bridgingFee":{"type":"string","description":"Fee covering the submission of the transaction on the destination chain, expressed in Lovelace","nullable":true},"operationFee":{"type":"string","description":"Fee covering the operational cost of processing the bridging request, expressed in Lovelace","nullable":true},"utxoCacheKey":{"type":"string","description":"Key used to enable caching of spent UTXOs","nullable":true},"isNativeToken":{"type":"boolean","description":"True if the amount is specified in a native token; false if in a currency on source chain"}},"required":["senderAddress","originChain","destinationChain","destinationAddress","amount","isNativeToken"]}}}}
```

## The CreateCardanoTransactionResponseDto object

```json
{"openapi":"3.0.0","info":{"title":"Web API","version":"1.0"},"components":{"schemas":{"CreateCardanoTransactionResponseDto":{"type":"object","properties":{"txRaw":{"type":"string","description":"Raw transaction data, encoded as a hexadecimal string"},"txHash":{"type":"string","description":"Transaction hash"},"bridgingFee":{"type":"number","description":"Bridging fee for covering submission on the destination chain, expressed in Lovelace"},"isFallback":{"type":"boolean","description":"Indicates is fallback mechanism used"},"amount":{"type":"number","description":"Amount of currency to be bridged, expressed in Lovelace"},"nativeTokenAmount":{"type":"number","description":"Amount of native token to be bridged"}},"required":["txRaw","txHash","bridgingFee","isFallback","amount","nativeTokenAmount"]}}}}
```

## The CardanoTransactionFeeResponseDto object

```json
{"openapi":"3.0.0","info":{"title":"Web API","version":"1.0"},"components":{"schemas":{"CardanoTransactionFeeResponseDto":{"type":"object","properties":{"fee":{"type":"number","description":"Transaction fee on the source chain, expressed in Lovelace"},"bridgingFee":{"type":"number","description":"Bridging fee for covering submission on the destination chain, expressed in Lovelace"}},"required":["fee","bridgingFee"]}}}}
```

## The TransactionSubmittedDto object

```json
{"openapi":"3.0.0","info":{"title":"Web API","version":"1.0"},"components":{"schemas":{"TransactionSubmittedDto":{"type":"object","properties":{"originChain":{"type":"string","description":"Source chain ID","enum":["cardano","prime"]},"destinationChain":{"type":"string","description":"Destination chain ID","enum":["cardano","prime"]},"originTxHash":{"type":"string","description":"Transaction hash on source chain"},"senderAddress":{"type":"string","description":"Address that initiated the bridging request on the source chain"},"receiverAddrs":{"description":"Recipient addresses on the destination chain","type":"array","items":{"type":"string"}},"amount":{"type":"string","description":"Amount of currency to be bridged, including bridging fee"},"nativeTokenAmount":{"type":"string","description":"Amount of native token to be bridged"},"txRaw":{"type":"string","description":"Transaction raw data on source chain"},"isFallback":{"type":"boolean","description":"Indicates is fallback mechanism used"}},"required":["originChain","destinationChain","originTxHash","senderAddress","receiverAddrs","amount","nativeTokenAmount","txRaw","isFallback"]}}}}
```

## The BridgeTransactionDto object

```json
{"openapi":"3.0.0","info":{"title":"Web API","version":"1.0"},"components":{"schemas":{"BridgeTransactionDto":{"type":"object","properties":{"id":{"type":"number","description":"Bridging transaction ID"},"senderAddress":{"type":"string","description":"Address that initiated the bridging transaction on the source chain"},"receiverAddresses":{"type":"string","description":"Recipient addresses on the destination chain"},"amount":{"type":"string","description":"Bridged amount"},"nativeTokenAmount":{"type":"string","description":"Bridged native token amount"},"originChain":{"type":"string","description":"Source chain ID","enum":["cardano","prime"]},"destinationChain":{"type":"string","description":"Destination chain ID","enum":["cardano","prime"]},"sourceTxHash":{"type":"string","description":"Transaction hash on source chain"},"destinationTxHash":{"type":"string","description":"Transaction hash on destination chain","nullable":true},"status":{"type":"string","description":"Status of bridging request","enum":["Pending","DiscoveredOnSource","InvalidRequest","SubmittedToBridge","IncludedInBatch","SubmittedToDestination","FailedToExecuteOnDestination","ExecutedOnDestination"]},"createdAt":{"format":"date-time","type":"string","description":"Transaction creation date"},"finishedAt":{"format":"date-time","type":"string","description":"Transaction finalization date","nullable":true}},"required":["id","senderAddress","receiverAddresses","amount","nativeTokenAmount","originChain","destinationChain","sourceTxHash","status","createdAt"]}}}}
```

## The BridgeTransactionFilterDto object

```json
{"openapi":"3.0.0","info":{"title":"Web API","version":"1.0"},"components":{"schemas":{"BridgeTransactionFilterDto":{"type":"object","properties":{"page":{"type":"number","description":"Page number to retrieve","nullable":true},"perPage":{"type":"number","description":"Number of items per page","nullable":true},"senderAddress":{"type":"string","description":"Address that initiated the bridging transaction on the source chain"},"originChain":{"type":"string","description":"Source chain ID","enum":["cardano","prime"]},"destinationChain":{"type":"string","description":"Destination chain ID","nullable":true,"enum":["cardano","prime"]},"amountFrom":{"type":"string","description":"Minimum amount of currency","nullable":true},"amountTo":{"type":"string","description":"Maximum amount of currency","nullable":true},"nativeTokenAmountFrom":{"type":"string","description":"Minimum amount of native token","nullable":true},"nativeTokenAmountTo":{"type":"string","description":"Maximum amount of native token","nullable":true},"orderBy":{"type":"string","description":"Field by which the results should be sorted","nullable":true},"order":{"type":"string","description":"Sort direction","nullable":true},"receiverAddress":{"type":"string","description":"Receiver address on destination chain","nullable":true}},"required":["senderAddress","originChain"]}}}}
```

## The BridgeTransactionResponseDto object

```json
{"openapi":"3.0.0","info":{"title":"Web API","version":"1.0"},"components":{"schemas":{"BridgeTransactionResponseDto":{"type":"object","properties":{"items":{"description":"Array of bridging transactions","type":"array","items":{"$ref":"#/components/schemas/BridgeTransactionDto"}},"page":{"type":"number","description":"Current page number"},"perPage":{"type":"number","description":"Number of items returned per page"},"total":{"type":"number","description":"Total number of items"}},"required":["items","page","perPage","total"]},"BridgeTransactionDto":{"type":"object","properties":{"id":{"type":"number","description":"Bridging transaction ID"},"senderAddress":{"type":"string","description":"Address that initiated the bridging transaction on the source chain"},"receiverAddresses":{"type":"string","description":"Recipient addresses on the destination chain"},"amount":{"type":"string","description":"Bridged amount"},"nativeTokenAmount":{"type":"string","description":"Bridged native token amount"},"originChain":{"type":"string","description":"Source chain ID","enum":["cardano","prime"]},"destinationChain":{"type":"string","description":"Destination chain ID","enum":["cardano","prime"]},"sourceTxHash":{"type":"string","description":"Transaction hash on source chain"},"destinationTxHash":{"type":"string","description":"Transaction hash on destination chain","nullable":true},"status":{"type":"string","description":"Status of bridging request","enum":["Pending","DiscoveredOnSource","InvalidRequest","SubmittedToBridge","IncludedInBatch","SubmittedToDestination","FailedToExecuteOnDestination","ExecutedOnDestination"]},"createdAt":{"format":"date-time","type":"string","description":"Transaction creation date"},"finishedAt":{"format":"date-time","type":"string","description":"Transaction finalization date","nullable":true}},"required":["id","senderAddress","receiverAddresses","amount","nativeTokenAmount","originChain","destinationChain","sourceTxHash","status","createdAt"]}}}}
```

## The CreateContactDto object

```json
{"openapi":"3.0.0","info":{"title":"Web API","version":"1.0"},"components":{"schemas":{"CreateContactDto":{"type":"object","properties":{"name":{"type":"string","description":"Full name of the user submitting the message"},"email":{"type":"string","description":"Email address of the user submitting the message","format":"email"},"message":{"type":"string","description":"Message to be submitted"}},"required":["name","email","message"]}}}}
```