Join the network
join_networkKeyed. A business, a rail or an agent joins. A rail may attach a quote feed as an API key or an OAuth-style connection and one published rate. No placement is sold. SwapEazi does not hold or move money.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| to | No | Rails only, with rate: ISO 4217 destination currency, e.g. 'ZAR'. | |
| from | No | Rails only, with rate: ISO 4217 source currency of the published rate, e.g. 'USD'. | |
| name | Yes | The joining organisation's or agent's name. | |
| rate | No | Rails only: one published rate, destination units per source unit, e.g. 18.25. | |
| party | Yes | Who is joining: business, rail or agent. | |
| contact | Yes | A work email address to reach the joining party. | |
| rail_kind | No | Rails only: bank, otc, ramp, psp or amm. | |
| access_key | No | A router key (rk_...), if not sent as a Bearer header. | |
| quote_feed | No | Rails only, optional: how the quote feed connects: api_key or oauth. |