Settlement Defaults

Both sides of the transaction can have optional defaults specified for currency and amount. To fix these, define the settlement below.

Note that the user will still be able to change the currency/quantity. To lock the currency or quantity, define the settlements below.
Field
Type
Description
Required
currency
string
The default currency for the given side of the quote
false
quantity
string
The default quantity for the given side of the quote
(Note: cannot set defaults for both sides) 
(Note: must set currency for the given side)
false
currency_scheme
string
Either FIAT or CRYPTO . Filter the list of available currencies
false
currency_options
Array<string>
Manually filter the list of available currencies.
false
{
  "public_api_key": "pk_xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "config_version": "1.2",
  "funding_default": {
    "currency": "USDC"
  }
  "payout_default": {
    "currency": "ETH",
    "quantity": "0.5",
    "currency_scheme": "CRYPTO"
  }
}
{
  "public_api_key": "pk_xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "config_version": "1.2",
  "funding_default": {
    "currency_options": ["BTC", "BCH"]    
  }
  "payout_default": {
    "currency": "ETH",
    "quantity": "0.5"
  }
}

Config Version

Settlement Parameters

Last updated 2 months ago

Field	Type	Description	Required
`currency`	string	The default currency for the given side of the quote	false
`quantity`	string	The default quantity for the given side of the quote (Note: cannot set defaults for both sides) (Note: must set currency for the given side)	false
`currency_scheme`	string	Either `FIAT` or `CRYPTO` . Filter the list of available currencies	false
`currency_options`	Array<string>	Manually filter the list of available currencies.	false