Sign in

v1

latestOpenAPI 3.0.02026-07-14866188.2 KB
Info

Estimate fees for a transaction before executing it.

Returns estimated fees for a given amount and optional rail. When rail is omitted, assumes a standard chimoney payout and currency must be USD.

post/v0.2.4/info/fee-estimate

Request body

amountnumber required

The transaction amount.

currencystring

Three-letter currency code (defaults to USD). Must be USD when rail is not specified.

rail'bank' | 'airtime' | 'mobile-money' | 'interac' | 'spei' | 'wallet' | 'gift-card' | 'chimoney' | 'interledger'

The payment rail. Optional — when omitted, assumes a standard chimoney payout.

direction'payout' | 'funding'

Transaction direction (defaults to payout).

Example request

{
  "amount": 100,
  "currency": "CAD",
  "rail": "interac",
  "direction": "payout"
}

Response

Fee estimate retrieved successfully.

statusstring
messagestring

Example response

{
  "status": "success",
  "message": "Fee estimate retrieved successfully",
  "data": {
    "amount": 100,
    "currency": "CAD",
    "rail": "interac",
    "direction": "payout",
    "platformFee": 2,
    "railFee": 2.5,
    "totalFee": 4.5,
    "netAmount": 95.5
  }
}