Skip to main content
POST
/
ramp
Onramp and Offramp
curl --request POST \
  --url https://staging-api.getpartna.com/v4/ramp \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --header 'x-api-user: <api-key>' \
  --data '
{
  "accountName": "",
  "accountNumber": "",
  "bankCode": "",
  "cancelPendingRampRequest": false,
  "cryptoAddress": "",
  "expireAction": "",
  "fromAmount": 0,
  "fromCurrency": "",
  "fromNetwork": "",
  "mobileNetwork": "",
  "paymentNetwork": "",
  "phoneID": "",
  "rampExpTime": 0,
  "rampReference": "",
  "rateKey": "",
  "sendingAddress": "",
  "shortcode": "",
  "toAmount": 0,
  "toCurrency": "",
  "toNetwork": "",
  "type": ""
}
'
{
  "data": {
    "accountName": "JANE DOE",
    "accountNumber": "9003001002",
    "bankName": "Paystack-Titan",
    "currentRate": 0.000597221725,
    "discountApplied": "0",
    "expiryDate": 1755873600,
    "feeInFromCurrency": 16.74,
    "feeInToCurrency": 0.01,
    "fromAmount": 1000,
    "fromCurrency": "NGN",
    "fromNetwork": "naira",
    "rampReference": "f32c3925063447a54905d31305a14da5",
    "toAmount": 0.5872,
    "toCurrency": "USDT",
    "toNetwork": "tron",
    "totalFeesInFromCurrency": 16.74,
    "totalFeesInToCurrency": 0.01
  },
  "message": "request completed"
}

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,
base,
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
​
cancelPendingRampRequest
boolean

users can only have one pending RampRequest at a time; if you have a pending RampRequest, set CancelPendingRampRequest as true; defaults to false

​
cryptoAddress
string
​
expireAction
enum<string>

allows you to choose what should happen to your ramp request if the current rate is no longer applicable; default is useCurrentRate

Available options:
useCurrentRate,
deposit
​
fromAmount
number
​
mobileNetwork
enum<string>

mobileNetwork, required if ToNetwork is kenyanshilling

Available options:
Safaricom,
Airtel
​
paymentNetwork
enum<string>

paymentNetwork, required if ToNetwork is kenyanshilling

Available options:
MOBILE,
BUY_GOODS,
PAYBILL
​
phoneID
string
​
rampExpTime
number

allows you to set when you need the ramp to expire or cancel; default is 1 hour

​
rampReference
string
​
sendingAddress
string

Address from which the user will be sending or receiving funds

​
shortcode
string

shortcode, required if ToNetwork is kenyanshilling

​
toAmount
number
​
type
enum<string>

initiate offramp with cryptoToFiat type and onramp with fiatToCrypto type

Available options:
fiatToCrypto,
cryptoToFiat

Response

post ramp ok

​
data
object
​
message
string