Skip to main content
POST
/
api
/
v3
/
offramp
Offramp Request
curl --request POST \
  --url https://sandbox-api.kotanipay.io/api/v3/offramp \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "referenceId": "<string>",
  "cryptoAmount": 123,
  "currency": "<unknown>",
  "depositStatus": "<unknown>",
  "transactionHash": "<string>",
  "refund_config": {
    "bolt11": "lnbc1500n1p0xyz...",
    "payment_hash": "a1b2c3d4e5f6...",
    "amount_msat": 150000000,
    "expires_at": "2024-11-22T13:00:00Z",
    "generate_invoice_url": "https://api.yourapp.com/lightning/generate-refund-invoice",
    "address": "0x742d35Cc6634C0532925a3b844Bc9e7595f0bEb"
  }
}
'
{
  "success": true,
  "message": "Offramp has been successfully created",
  "data": {
    "referenceId": "<string>",
    "status": "<string>",
    "cryptoAmount": 123,
    "cryptoAmountReceived": 123,
    "feeInCrypto": 123,
    "feeType": "<string>",
    "cryptoWallet": "<string>",
    "chain": {},
    "token": {},
    "transactionHash": "<string>",
    "updated_at": "2023-11-07T05:31:56Z",
    "onchainError": {},
    "transactionError": {}
  }
}
This endpoint will create an offramp request for a customer to convert crypto to fiat.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
referenceId
string
required

Onramp reference ID

​
cryptoAmount
number
required

The crypto amount

​
currency
any
required

Fiat currency

​
depositStatus
any

Deposit status

​
lipaNaMpesaReceiver
object

Lipa na M-Pesa (Till/Buy Goods) receiver — Kenya only

​
paybillReceiver
object

Paybill receiver — Kenya only

​
transactionHash
string

Transaction hash

​
refund_config
object

Optional refund destination for this transaction. For Lightning: provide a bolt11 invoice so Kotani can refund immediately if fiat disbursement fails, without waiting for you to submit one manually. Include generate_invoice_url so Kotani can refresh the invoice if it expires. For on-chain chains: provide address as the fallback refund destination. If omitted, Kotani notifies you via webhook and email when a refund is needed and you submit via POST /offramp/submit-refund-invoice/:referenceId.

Response

Offramp Response

​
success
boolean
Example:

true

​
message
string
Example:

"Offramp has been successfully created"

​
data
object