Create a new FX spread rule

POST/v2/fx/spreads

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Request payload for creating or updating a spread rule

fx_tariff_id?string

Optional FX tariff ID for tariff-specific spreads

provider?string

Optional provider name (e.g., SNB, EB, CRP, OER)

base_currency?string

Optional base currency code

target_currency?string

Optional target currency code

rate_type?string

Rate type this spread applies to: BUY (applies to ASK spreads only), SELL (applies to BID spreads only), BOTH (applies to both BID and ASK spreads, but only if no BUY/SELL-specific rule exists)

bid_spread_bps*number

BID spread in basis points (e.g., 50 = 0.5%)

ask_spread_bps*number

ASK spread in basis points (e.g., 50 = 0.5%)

effective_from?string

When this spread rule becomes effective

effective_to?string

When this spread rule expires (optional)

reason?string

Reason for creating/updating this rule

Response Body

`application/json`

curl -X POST "https://example.com/v2/fx/spreads" \  -H "Content-Type: application/json" \  -d '{    "bid_spread_bps": 50,    "ask_spread_bps": 50  }'

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "fx_tariff_id": "f12d958c-c80c-4752-862c-9e0c09506488",
  "provider": "string",
  "base_currency": "string",
  "target_currency": "string",
  "rate_type": "BUY",
  "bid_spread_bps": 0,
  "ask_spread_bps": 0,
  "effective_from": "2019-08-24T14:15:22Z",
  "effective_to": "2019-08-24T14:15:22Z",
  "reason": "string",
  "active": true,
  "created_at": "2019-08-24T14:15:22Z",
  "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
  "modified_at": "2019-08-24T14:15:22Z",
  "modified_by": "e8d4374d-93a1-4e98-a6c6-fdcf00c5059f"
}

Empty

Request Body

Response Body

201application/json

400

401

403

409

`application/json`