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": "",
  "rampExpTime": 0,
  "rampReference": "",
  "rateKey": "",
  "toAmount": 0,
  "toCurrency": "",
  "toNetwork": "",
  "type": ""
}'
{
  "data": {
    "accountName": "JANE DOE",
    "accountNumber": "9003001002",
    "bankName": "Paystack-Titan",
    "currentRate": 0.000597221725,
    "expiryDate": 1750165040,
    "fromAmount": 1000,
    "fromCurrency": "NGN",
    "fromNetwork": "naira",
    "rampReference": "f32c3925063447a54905d31305a14da5",
    "toAmount": 0.597221724537,
    "toCurrency": "USDT",
    "toNetwork": "tron"
  },
  "message": "request completed"
}

Authorizations

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

Body

application/json
​
rateKey
string
required
​
accountName
string
​
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
​
fromCurrency
enum<string>
Available options:
BTC,
ETH,
USDC,
USDT,
CUSD,
BNB,
NGN
​
fromNetwork
enum<string>
Available options:
avalanche,
binance,
bitcoin,
celo,
ethereum,
polygon,
tron,
solana,
naira,
mobileMoney,
mpesa
​
rampExpTime
number

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

​
rampReference
string
​
toAmount
number
​
toCurrency
enum<string>
Available options:
BTC,
ETH,
USDC,
USDT,
CUSD,
BNB,
NGN
​
toNetwork
enum<string>
Available options:
avalanche,
binance,
bitcoin,
celo,
ethereum,
polygon,
tron,
solana,
naira,
mobileMoney,
mpesa
​
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