Object

The transfer preview object

Result of a dry run that passed every check.

Fields

objectstringrequired

kindstringrequired

One of user_to_user, conversion, onramp, offramp.

sourceobjectrequired

A resolved source or destination, as returned on a transfer.

source.typestringrequired

One of wallet, fiat, payout_account.

source.wallet_idstring

Starts with wal_.

source.payout_account_idstring

Starts with pa_.

source.user_idstring

Owner of the wallet or payout account. Absent for a fiat source.

Starts with usr_.

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.

destinationobjectrequired

A resolved source or destination, as returned on a transfer.

destination.typestringrequired

One of wallet, fiat, payout_account.

destination.wallet_idstring

Starts with wal_.

destination.payout_account_idstring

Starts with pa_.

destination.user_idstring

Owner of the wallet or payout account. Absent for a fiat source.

Starts with usr_.

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.

amountstringrequired

Non-negative decimal string. Precision is limited per asset or currency (see Route).

estimatedobjectrequired

Indicative figures at the current rate; not a quote.

estimated.ratestring

estimated.feesarray of object

estimated.amount_creditedstring

Non-negative decimal string. Precision is limited per asset or currency (see Route).

estimated.amount_paid_outstring

Non-negative decimal string. Precision is limited per asset or currency (see Route).

estimated.settlement_time_secondsinteger

Example

{
  "object": "transfer_preview",
  "kind": "user_to_user",
  "source": {
    "type": "wallet",
    "wallet_id": "wal_01JA8Z4K2V9QW3H6Y7XKD2M0RS",
    "user_id": "usr_01JA8Z2F5G6H7J8K9M0N1P2Q3R",
    "asset": "ndeipi-points"
  },
  "destination": {
    "type": "wallet",
    "wallet_id": "wal_01JA8Z5B7C1DE2F3G4H5J6K7LM",
    "user_id": "usr_01JA8Z3H6J7K8M9N0P1Q2R3S4T",
    "asset": "ndeipi-points"
  },
  "amount": "25.00",
  "estimated": {
    "rate": "1",
    "fees": [],
    "amount_credited": "25.00",
    "settlement_time_seconds": 0
  }
}