> ## Documentation Index
> Fetch the complete documentation index at: https://developer.fin.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Create a crypto payment quote
> Generate a fee estimation quote for a transit payment
The quote has a limited validity period indicated by `expire_at`. Request a new quote if it has expired.
## Quote Request by Integration
* `settlement_via`: `MARKET_ORDER` or `ONE_TO_ONE`
* `rebalance_fee`: `true` or `false`
* `developer_fee`: not applicable
Check out the supported rails, chains, fee rebalancing, and settlement configuration combinations for Bybit [here](https://developer.fin.com/crypto-orchestration/integration-types/bybit#chains-rails-and-constraints).
* `settlement_via`: `ONE_TO_ONE`
* `rebalance_fee`: `true` or `false`
* `developer_fee`: optional, supports `fixed` and `percentage` fields
Check out the supported rails, chains, fee rebalancing, and settlement configuration combinations for Kraken [here](https://developer.fin.com/crypto-orchestration/integration-types/kraken#chains-rails-and-constraints).
* `settlement_via`: `FEE_RETENTION`
* `rebalance_fee`: `false`
* `developer_fee`: optional, supports `fixed` and `percentage` fields
Check out the supported rails, chains, fee rebalancing, and settlement configuration combinations for Pass Through [here](https://developer.fin.com/crypto-orchestration/integration-types/pass-through#chains-rails-and-constraints).
* `settlement_via`: `ONE_TO_ONE`
* `rebalance_fee`: `true` or `false`
* `developer_fee`: optional, supports `fixed` and `percentage` fields
## Rebalance Fee Behavior
| Value | Effect |
| :------ | :------------------------------------------------------------------------------ |
| `true` | Fees absorbed into order amount. `total_order_amount` equals `order_amount`. |
| `false` | Fees added on top. `total_order_amount` equals `order_amount` plus `total_fee`. |
## OpenAPI
````yaml POST /v1/transit/quote
openapi: 3.1.0
info:
title: Fin.com API
version: 1.0.0
description: A simple API specificationFo
servers:
- url: https://sandbox.api.fin.com
description: Sandbox server
- url: https://api.fin.com
description: Production server
security: []
tags:
- name: Authentication
description: A modified OAuth 2.0 Client Credential Flow
- name: Customers
description: Customer management and document upload operations
- name: Balances
description: Retrieve wallet balance information
- name: Catalogue
description: |
A set of endpoints to retrieve contextual data to assemble requests
to fin.com's API
- name: Beneficiaries
description: Manage beneficiary accounts for payments and transfers
- name: Transactions
description: Transaction history and management for beneficiaries
- name: Virtual Accounts
description: Create and manage virtual accounts for USD to USDC conversions
- name: Fees & FX Rates
description: Retrieve fees and foreign exchange rates
paths:
/v1/transit/quote:
post:
tags:
- Crypto Orchestration
summary: Create a crypto payment quote
description: Generate a fee estimation quote for a transit payment
requestBody:
required: true
content:
application/json:
schema:
oneOf:
- title: Bybit
type: object
required:
- order_amount
- integration_type
- settlement_config
properties:
order_amount:
type: string
description: Order amount in USD.
example: '100.00'
integration_type:
type: string
enum:
- BYBIT
example: BYBIT
settlement_config:
type: object
required:
- settlement_via
- rebalance_fee
- destination_details
properties:
settlement_via:
type: string
enum:
- MARKET_ORDER
- ONE_TO_ONE
example: MARKET_ORDER
rebalance_fee:
type: boolean
description: >-
When true, fees are absorbed and total_order_amount
equals order_amount. When false, settlement_amount
equals order_amount minus total_fee.
example: true
destination_details:
type: object
required:
- wallet_address
- currency
- rail
properties:
wallet_address:
type: string
description: Destination wallet address.
example: 7xKXtg2CW87d97TXJSDpbD5jBkheTqA83TZRuJosgAsU
currency:
type: string
enum:
- USDC
- PYUSD
description: >-
Destination currency. See [supported chains and
currencies](https://developer.fin.com/crypto-orchestration/integration-types/bybit#chains-rails-and-constraints)
for valid currency and rail combinations.
example: USDC
rail:
type: string
enum:
- SOLANA
- ETHEREUM
- BASE
example: SOLANA
- title: Kraken
type: object
required:
- order_amount
- integration_type
- settlement_config
properties:
order_amount:
type: string
description: Order amount in USD.
example: '100.00'
integration_type:
type: string
enum:
- KRAKEN
example: KRAKEN
settlement_config:
type: object
required:
- settlement_via
- rebalance_fee
- destination_details
properties:
settlement_via:
type: string
enum:
- ONE_TO_ONE
example: ONE_TO_ONE
rebalance_fee:
type: boolean
description: >-
When true, fees are absorbed and total_order_amount
equals order_amount. When false, settlement_amount
equals order_amount minus total_fee.
example: false
destination_details:
type: object
required:
- wallet_address
- currency
- rail
properties:
wallet_address:
type: string
description: Destination wallet address.
example: 7xKXtg2CW87d97TXJSDpbD5jBkheTqA83TZRuJosgAsU
currency:
type: string
enum:
- USDC
- PYUSD
example: PYUSD
rail:
type: string
enum:
- SOLANA
example: SOLANA
developer_fee:
type: object
nullable: true
description: >-
Developer fee configuration. Nullable. Both fields
default to 0.
properties:
fixed:
type: string
description: Fixed fee in USD per transaction. Defaults to 0.
example: '0.15'
percentage:
type: string
description: >-
Percentage fee applied to order_amount. Defaults to
0.
example: '2.5'
- title: Pass Through
type: object
required:
- order_amount
- integration_type
- settlement_config
properties:
order_amount:
type: string
description: Order amount in USD.
example: '100.00'
integration_type:
type: string
enum:
- PASS_THROUGH
example: PASS_THROUGH
settlement_config:
type: object
required:
- settlement_via
- rebalance_fee
- destination_details
properties:
settlement_via:
type: string
enum:
- FEE_RETENTION
example: FEE_RETENTION
rebalance_fee:
type: boolean
description: >-
Only false is supported for PASS_THROUGH. Passing
true returns an error.
example: false
destination_details:
type: object
required:
- wallet_address
- currency
- rail
properties:
wallet_address:
type: string
description: Destination wallet address.
example: bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh
currency:
type: string
enum:
- BTC
- ETH
- USDT
- USDC
example: BTC
rail:
type: string
enum:
- BITCOIN
- ETHEREUM
- TRON
- SOLANA
example: BITCOIN
developer_fee:
type: object
nullable: true
description: >-
Developer fee configuration. Nullable. Both fields
default to 0.
properties:
fixed:
type: string
description: Fixed fee in USD per transaction. Defaults to 0.
example: '0.15'
percentage:
type: string
description: >-
Percentage fee applied to order_amount. Defaults to
0.
example: '2.5'
- title: OKX
type: object
required:
- order_amount
- integration_type
- settlement_config
properties:
order_amount:
type: string
description: Order amount in USD.
example: '100.00'
integration_type:
type: string
enum:
- OKX
example: OKX
settlement_config:
type: object
required:
- settlement_via
- rebalance_fee
- destination_details
properties:
settlement_via:
type: string
enum:
- ONE_TO_ONE
example: ONE_TO_ONE
rebalance_fee:
type: boolean
description: >-
When true, fees are absorbed and total_order_amount
equals order_amount. When false, settlement_amount
equals order_amount minus total_fee.
example: false
destination_details:
type: object
required:
- wallet_address
- currency
- rail
properties:
wallet_address:
type: string
description: Destination wallet address.
example: 7xKXtg2CW87d97TXJSDpbD5jBkheTqA83TZRuJosgAsU
currency:
type: string
enum:
- USDC
description: USDC only for OKX (milestone-1).
example: USDC
rail:
type: string
enum:
- SOLANA
description: SOLANA only for OKX (milestone-1).
example: SOLANA
developer_fee:
type: object
nullable: true
description: >-
Developer fee configuration. Nullable. Both fields
default to 0.
properties:
fixed:
type: string
description: Fixed fee in USD per transaction. Defaults to 0.
example: '0.15'
percentage:
type: string
description: >-
Percentage fee applied to order_amount. Defaults to
0.
example: '2.5'
examples:
Bybit:
summary: Bybit
value:
order_amount: '100.00'
integration_type: BYBIT
settlement_config:
settlement_via: MARKET_ORDER
rebalance_fee: true
destination_details:
wallet_address: 7xKXtg2CW87d97TXJSDpbD5jBkheTqA83TZRuJosgAsU
currency: USDC
rail: SOLANA
Kraken:
summary: Kraken
value:
order_amount: '100.00'
integration_type: KRAKEN
settlement_config:
settlement_via: ONE_TO_ONE
rebalance_fee: false
destination_details:
wallet_address: 7xKXtg2CW87d97TXJSDpbD5jBkheTqA83TZRuJosgAsU
currency: PYUSD
rail: SOLANA
developer_fee:
fixed: '0.15'
percentage: '2.5'
Pass Through:
summary: Pass Through
value:
order_amount: '100.00'
integration_type: PASS_THROUGH
settlement_config:
settlement_via: FEE_RETENTION
rebalance_fee: false
destination_details:
wallet_address: bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh
currency: BTC
rail: BITCOIN
developer_fee:
fixed: '0.15'
percentage: '2.5'
OKX:
summary: OKX
value:
order_amount: '100.00'
integration_type: OKX
settlement_config:
settlement_via: ONE_TO_ONE
rebalance_fee: false
destination_details:
wallet_address: 7xKXtg2CW87d97TXJSDpbD5jBkheTqA83TZRuJosgAsU
currency: USDC
rail: SOLANA
developer_fee:
fixed: '0.15'
percentage: '2.5'
responses:
'200':
description: Quote created successfully
content:
application/json:
schema:
oneOf:
- title: Bybit
type: object
properties:
data:
type: object
properties:
quote_id:
type: string
format: uuid
description: >-
Unique quote identifier. Pass as quote_id when
creating a payment to lock in the quoted fees.
example: 4081fa09-7761-42b6-8f66-24beae1a2ca5
expire_at:
type: integer
description: >-
Unix timestamp when this quote expires. Request a
new quote after expiry.
example: 1770916749
order_amount:
type: string
description: Order amount provided in the request, in USD.
example: '100.00'
integration_type:
type: string
example: BYBIT
settlement_config:
type: object
properties:
settlement_via:
type: string
example: MARKET_ORDER
rebalance_fee:
type: boolean
example: true
destination_details:
type: object
properties:
wallet_address:
type: string
example: >-
7xKXtg2CW87d97TXJSDpbD5jBkheTqA83TZRuJosgAsU
currency:
type: string
example: USDC
rail:
type: string
example: SOLANA
quote_estimation:
type: object
properties:
payment_fee:
type: string
description: >-
Fee charged by the exchange for processing the
payment.
example: '0.00'
conversion_fee:
type: string
description: >-
Fee charged for currency conversion where
applicable.
example: '0.00'
withdrawal_fee:
type: string
description: >-
Fee charged for withdrawing funds from the
exchange.
example: '0.00'
gas_fee:
type: string
description: >-
Blockchain network gas fee for the on-chain
settlement transaction.
example: '0.50'
total_fee:
type: string
description: >-
Total of all fees: gas_fee + payment_fee +
conversion_fee + withdrawal_fee.
example: '0.50'
total_order_amount:
type: string
description: >-
Gross amount charged to the payer. When
rebalance_fee is true, equals order_amount
(fees absorbed into the order).
example: '100.00'
ata_fee_applied:
type: boolean
description: >-
Whether a Solana Associated Token Account
creation fee was applied to gas_fee.
example: false
- title: Kraken
type: object
properties:
data:
type: object
properties:
quote_id:
type: string
format: uuid
description: >-
Unique quote identifier. Pass as quote_id when
creating a payment to lock in the quoted fees.
example: 76e8bcc0-a6b4-41f7-b3d2-76cfbe910fe3
expire_at:
type: integer
description: >-
Unix timestamp when this quote expires. Request a
new quote after expiry.
example: 1770916749
order_amount:
type: string
description: Order amount provided in the request, in USD.
example: '100.00'
integration_type:
type: string
example: KRAKEN
settlement_config:
type: object
properties:
settlement_via:
type: string
example: ONE_TO_ONE
rebalance_fee:
type: boolean
example: false
destination_details:
type: object
properties:
wallet_address:
type: string
example: >-
7xKXtg2CW87d97TXJSDpbD5jBkheTqA83TZRuJosgAsU
currency:
type: string
example: PYUSD
rail:
type: string
example: SOLANA
quote_estimation:
type: object
properties:
payment_fee:
type: string
description: >-
Fee charged by the exchange for processing the
payment.
example: '0.00'
conversion_fee:
type: string
description: >-
Fee charged for currency conversion where
applicable.
example: '0.00'
withdrawal_fee:
type: string
description: >-
Fee charged for withdrawing funds from the
exchange.
example: '0.00'
gas_fee:
type: string
description: >-
Blockchain network gas fee for the on-chain
settlement transaction.
example: '0.50'
total_developer_fee:
type: string
description: >-
Sum of developer-configured fees: fixed fee
plus percentage of order_amount.
example: '2.65'
total_fee:
type: string
description: >-
Total of all fees: gas_fee + payment_fee +
conversion_fee + withdrawal_fee +
total_developer_fee.
example: '3.15'
total_order_amount:
type: string
description: >-
Gross amount charged to the payer. When
rebalance_fee is false, settlement_amount
equals order_amount minus total_fee.
example: '100.00'
ata_fee_applied:
type: boolean
description: >-
Whether a Solana Associated Token Account
creation fee was applied to gas_fee.
example: false
- title: Pass Through
type: object
properties:
data:
type: object
properties:
quote_id:
type: string
format: uuid
description: >-
Unique quote identifier. Pass as quote_id when
creating a payment to lock in the quoted fees.
example: 5831ce86-cd88-4aba-b1fd-32dcf6e1a030
expire_at:
type: integer
description: >-
Unix timestamp when this quote expires. Request a
new quote after expiry.
example: 1770916749
order_amount:
type: string
description: Order amount provided in the request, in USD.
example: '100.00'
integration_type:
type: string
example: PASS_THROUGH
settlement_config:
type: object
properties:
settlement_via:
type: string
example: FEE_RETENTION
rebalance_fee:
type: boolean
example: false
destination_details:
type: object
properties:
wallet_address:
type: string
example: bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh
currency:
type: string
example: BTC
rail:
type: string
example: BITCOIN
quote_estimation:
type: object
properties:
payment_fee:
type: string
description: >-
Fee charged by the exchange for processing the
payment.
example: '0.00'
conversion_fee:
type: string
description: >-
Fee charged for currency conversion where
applicable.
example: '0.00'
withdrawal_fee:
type: string
description: >-
Fee charged for withdrawing funds from the
exchange.
example: '0.00'
gas_fee:
type: string
description: >-
Blockchain network gas fee for the on-chain
settlement transaction.
example: '0.50'
total_developer_fee:
type: string
description: >-
Sum of developer-configured fees: fixed fee
plus percentage of order_amount.
example: '2.65'
total_fee:
type: string
description: >-
Total of all fees: gas_fee + payment_fee +
conversion_fee + withdrawal_fee +
total_developer_fee.
example: '3.15'
total_order_amount:
type: string
description: >-
Gross amount charged to the payer. When
rebalance_fee is false, settlement_amount
equals order_amount minus total_fee.
example: '100.00'
ata_fee_applied:
type: boolean
description: >-
Whether a Solana Associated Token Account
creation fee was applied to gas_fee.
example: false
- title: OKX
type: object
properties:
data:
type: object
properties:
quote_id:
type: string
format: uuid
description: >-
Unique quote identifier. Pass as quote_id when
creating a payment to lock in the quoted fees.
example: e9d4c7b2-1a3f-4e85-90f2-c6d8a1b3e4f7
expire_at:
type: integer
description: >-
Unix timestamp when this quote expires. Request a
new quote after expiry.
example: 1770916749
order_amount:
type: string
description: Order amount provided in the request, in USD.
example: '100.00'
integration_type:
type: string
example: OKX
settlement_config:
type: object
properties:
settlement_via:
type: string
example: ONE_TO_ONE
rebalance_fee:
type: boolean
example: false
destination_details:
type: object
properties:
wallet_address:
type: string
example: >-
7xKXtg2CW87d97TXJSDpbD5jBkheTqA83TZRuJosgAsU
currency:
type: string
example: USDC
rail:
type: string
example: SOLANA
quote_estimation:
type: object
properties:
payment_fee:
type: string
description: >-
Fee charged by the exchange for processing the
payment.
example: '0.00'
conversion_fee:
type: string
description: >-
Fee charged for currency conversion where
applicable.
example: '0.00'
withdrawal_fee:
type: string
description: >-
Fee charged for withdrawing funds from the
exchange.
example: '0.00'
gas_fee:
type: string
description: >-
Blockchain network gas fee for the on-chain
settlement transaction.
example: '0.50'
total_developer_fee:
type: string
description: >-
Sum of developer-configured fees: fixed fee
plus percentage of order_amount.
example: '2.65'
total_fee:
type: string
description: >-
Total of all fees: gas_fee + payment_fee +
conversion_fee + withdrawal_fee +
total_developer_fee.
example: '3.15'
total_order_amount:
type: string
description: >-
Gross amount charged to the payer. When
rebalance_fee is false, settlement_amount
equals order_amount minus total_fee.
example: '106.30'
ata_fee_applied:
type: boolean
description: >-
Whether a Solana Associated Token Account
creation fee was applied to gas_fee.
example: false
examples:
Bybit:
summary: Bybit
value:
data:
quote_id: 4081fa09-7761-42b6-8f66-24beae1a2ca5
expire_at: 1770916749
order_amount: '100.00'
integration_type: BYBIT
settlement_config:
settlement_via: MARKET_ORDER
rebalance_fee: true
destination_details:
wallet_address: 7xKXtg2CW87d97TXJSDpbD5jBkheTqA83TZRuJosgAsU
currency: USDC
rail: SOLANA
quote_estimation:
payment_fee: '0.00'
conversion_fee: '0.00'
withdrawal_fee: '0.00'
gas_fee: '0.50'
total_fee: '0.50'
total_order_amount: '100.00'
ata_fee_applied: false
Pass Through:
summary: Pass Through
value:
data:
quote_id: 5831ce86-cd88-4aba-b1fd-32dcf6e1a030
expire_at: 1770916749
order_amount: '100.00'
integration_type: PASS_THROUGH
settlement_config:
settlement_via: FEE_RETENTION
rebalance_fee: false
destination_details:
wallet_address: bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh
currency: BTC
rail: BITCOIN
quote_estimation:
payment_fee: '0.00'
conversion_fee: '0.00'
withdrawal_fee: '0.00'
gas_fee: '0.50'
total_developer_fee: '2.65'
total_fee: '3.15'
total_order_amount: '100.00'
ata_fee_applied: false
Kraken:
summary: Kraken
value:
data:
quote_id: 76e8bcc0-a6b4-41f7-b3d2-76cfbe910fe3
expire_at: 1770916749
order_amount: '100.00'
integration_type: KRAKEN
settlement_config:
settlement_via: ONE_TO_ONE
rebalance_fee: false
destination_details:
wallet_address: 7xKXtg2CW87d97TXJSDpbD5jBkheTqA83TZRuJosgAsU
currency: PYUSD
rail: SOLANA
quote_estimation:
payment_fee: '0.00'
conversion_fee: '0.00'
withdrawal_fee: '0.00'
gas_fee: '0.50'
total_developer_fee: '2.65'
total_fee: '3.15'
total_order_amount: '100.00'
ata_fee_applied: false
OKX:
summary: OKX
value:
data:
quote_id: e9d4c7b2-1a3f-4e85-90f2-c6d8a1b3e4f7
expire_at: 1770916749
order_amount: '100.00'
integration_type: OKX
settlement_config:
settlement_via: ONE_TO_ONE
rebalance_fee: false
destination_details:
wallet_address: 7xKXtg2CW87d97TXJSDpbD5jBkheTqA83TZRuJosgAsU
currency: USDC
rail: SOLANA
quote_estimation:
payment_fee: '0.00'
conversion_fee: '0.00'
withdrawal_fee: '0.00'
gas_fee: '0.50'
total_developer_fee: '2.65'
total_fee: '3.15'
total_order_amount: '106.30'
ata_fee_applied: false
'401':
$ref: '#/components/responses/AuthenticationError'
security:
- bearerAuth: []
components:
responses:
AuthenticationError:
description: Authentication failed due to invalid credentials
content:
application/json:
schema:
type: object
properties:
message:
type: string
example: Authentication failed
securitySchemes:
bearerAuth:
type: http
scheme: bearer
bearerFormat: JWT
description: >-
Bearer token authentication. Obtain token from [Issue a
Token](https://developer.fin.com/api-reference/authentication/issue-a-token)
endpoint
````