Skip to main content
POST
/
ramp
/
breakdown
Calculate ramp fees from toAmount or fromAmount
curl --request POST \
  --url https://staging-api.getpartna.com/v4/ramp/breakdown \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --header 'x-api-user: <api-key>' \
  --data '
{
  "accountName": "",
  "accountNumber": "",
  "bankCode": "",
  "cryptoAddress": "",
  "fromAmount": 0,
  "fromCurrency": "",
  "fromNetwork": "",
  "rateKey": "",
  "toAmount": 0,
  "toCurrency": "",
  "toNetwork": "",
  "type": ""
}
'
{
  "data": {
    "DepositFeeCapped": false,
    "DepositFeeInFromCurrency": 1000,
    "DepositFeeInToCurrency": 0.597221725,
    "DepositPercentageApplied": 0,
    "MerchantFeeCapped": false,
    "MerchantFeeInFromCurrency": 200,
    "MerchantFeeInToCurrency": 0.11944434500000001,
    "MerchantFeeUSD": 0.11944434500000001,
    "MerchantPercentageApplied": 0.02,
    "NetAmountInToCurrency": 5.2455,
    "Rate": 0.000597221725,
    "TotalAmountInFromCurrency": 10000,
    "TotalAmountInToCurrency": 5.97221725,
    "TotalFeesInFromCurrency": 1216.7441999870316,
    "TotalFeesInToCurrency": 0.72666607,
    "WithdrawalFeeInFromCurrency": 16.744199987031617,
    "WithdrawalFeeInToCurrency": 0.01
  },
  "message": "success"
}

Documentation Index

Fetch the complete documentation index at: https://docs.getpartna.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
x-api-key
string
header
required
​
x-api-user
string
header
required

Body

application/json
​
fromCurrency
enum<string>
required
Available options:
BTC,
ETH,
USDC,
USDT,
CUSD,
BNB,
NGN,
KES
​
fromNetwork
enum<string>
required
Available options:
avalanche,
binance,
bitcoin,
celo,
ethereum,
polygon,
tron,
solana,
naira,
mobileMoney,
mpesa,
kenyanshilling
​
rateKey
string
required
​
toCurrency
enum<string>
required
Available options:
BTC,
ETH,
USDC,
USDT,
CUSD,
BNB,
NGN,
KES
​
toNetwork
enum<string>
required
Available options:
avalanche,
base,
binance,
bitcoin,
celo,
ethereum,
polygon,
tron,
solana,
naira,
mobileMoney,
mpesa,
kenyanshilling
​
accountName
string

accountname of the user (not bank account name)

​
accountNumber
string
​
bankCode
string
​
cryptoAddress
string
​
fromAmount
number
​
toAmount
number
​
type
enum<string>

initiate offramp with cryptoToFiat type and onramp with fiatToCrypto type

Available options:
fiatToCrypto,
cryptoToFiat

Response

200 - application/json

post ramp breakdown ok

​
data
object
​
message
string