Object

The route object

Fields

kindstringrequired: One of user_to_user, conversion, onramp, offramp.
sourceobjectrequired
source.typestringrequired: One of wallet, fiat, payout_account.
source.assetstring: A wallet asset code. The set is data on GET /routes. In 1.0 it holds two assets:

ndeipi-points: Ndeipi Points, bought with fiat on Absa or PayPal at a fixed price per currency and cashed out the same way. Every user's default asset.
ndeipi-coin: NdeipiCoin, opt-in. Its price moves. It is bought and sold only by converting points at a locked quote (POST /quotes), never directly with fiat. A wallet needs acknowledge_price_risk: true to create.
source.currencystring: Lower-case ISO 4217 fiat currency code.
source.railstring: A payment rail code, published by GET /routes. Not an enum by design.
source.countrystring: ISO 3166-1 alpha-2 country code.
source.decimalsinteger: Decimal places amounts in this unit may carry.
destinationobjectrequired
destination.typestringrequired: One of wallet, fiat, payout_account.
destination.assetstring: A wallet asset code. The set is data on GET /routes. In 1.0 it holds two assets:

ndeipi-points: Ndeipi Points, bought with fiat on Absa or PayPal at a fixed price per currency and cashed out the same way. Every user's default asset.
ndeipi-coin: NdeipiCoin, opt-in. Its price moves. It is bought and sold only by converting points at a locked quote (POST /quotes), never directly with fiat. A wallet needs acknowledge_price_risk: true to create.
destination.currencystring: Lower-case ISO 4217 fiat currency code.
destination.railstring: A payment rail code, published by GET /routes. Not an enum by design.
destination.countrystring: ISO 3166-1 alpha-2 country code.
destination.decimalsinteger: Decimal places amounts in this unit may carry.
min_amountstringrequired: In the source's unit.
max_amountstringrequired: Per transfer, in the source's unit. Per-user limits apply separately.
settlement_time_secondsinteger: Typical time from submission to completion.
availableboolean: False while the route's provider is down.

Example

{
  "kind": "onramp",
  "source": {
    "type": "fiat",
    "currency": "zar",
    "rail": "absa_eft",
    "country": "ZA",
    "decimals": 2
  },
  "destination": {
    "type": "wallet",
    "asset": "ndeipi-points",
    "decimals": 2
  },
  "min_amount": "10.00",
  "max_amount": "50000.00",
  "settlement_time_seconds": 86400,
  "available": true
}