Send Payment

This endpoint sends a payment on the Bitcoin Lightning Network.

Request to sends a payment from a wallet. The application needs to provide an lightning invoice or Ninjapay username(@ninjatag) or on-chain address . We recommend using ninjatag(Ninjapay username) for sending rewards to users, since it's zero fee and instant.

Method


POST https://prod.ninjapay.me/sapi/v1/send

Parameters

Body (application/json)
 {
  wallet: string; // lbtc, btc and usdt supported currently
  payment_mode: string; // ninjatag, onchain, lightning
  ninjatag?: string; // Add this username if you want to send to other ninjapay users
  lightning_invoice?: string; // Add this if you want to send payment via lightning
  lightning_invoice_type?: string; // "invoice"(default) and "lnurl" currently supported(lnurl not supported for "btc" wallet)
  chain_address?: string; // Add this if you want to send payment onchain
  chain_network?: string; // Add network for onchain payment (BTC, ERC20, BEP20...)
  amount?: int; // For both "btc" & "lbtc" wallets, amount should be entered in BTC, not SAT. (Amount is not required for "lbtc" unless lightning_invoice_type is "lnurl")
  fiat_value?: int;
  fiat_currency?: string; // INR, USD, EUR...
  description?: string;
  customer_name?: string;
  order_id?: string;
  extra?: {}
}

Other info

Parameters

Input options

wallet

lbtc,btc,usdt

payment_mode

ninjatag , onchain, lightning, email

chain_network

BTC , ERC20, BEP20, MATIC

Response

{"tid": <int>}

Example


const options = {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    Authorization: 'API_KEY'
  },
  body: '{"wallet":"lbtc","payment_mode":"ninjatag","amount":0.0018,"description":"sample_description","ninjatag":"nakamoto","order_id":"21"}'
};

fetch('https://prod.ninjapay.me/sapi/v1/send', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

Note: You need to use Admin key for this request!

PreviousWallet Info NextRequest Payment

Last updated 1 year ago

Body (application/json) { wallet: string; // lbtc, btc and usdt supported currently payment_mode: string; // ninjatag, onchain, lightning ninjatag?: string; // Add this username if you want to send to other ninjapay users lightning_invoice?: string; // Add this if you want to send payment via lightning lightning_invoice_type?: string; // "invoice"(default) and "lnurl" currently supported(lnurl not supported for "btc" wallet) chain_address?: string; // Add this if you want to send payment onchain chain_network?: string; // Add network for onchain payment (BTC, ERC20, BEP20...) amount?: int; // For both "btc" & "lbtc" wallets, amount should be entered in BTC, not SAT. (Amount is not required for "lbtc" unless lightning_invoice_type is "lnurl") fiat_value?: int; fiat_currency?: string; // INR, USD, EUR... description?: string; customer_name?: string; order_id?: string; extra?: {} }

const options = { method: 'POST', headers: { 'Content-Type': 'application/json', Authorization: 'API_KEY' }, body: '{"wallet":"lbtc","payment_mode":"ninjatag","amount":0.0018,"description":"sample_description","ninjatag":"nakamoto","order_id":"21"}' }; fetch('https://prod.ninjapay.me/sapi/v1/send', options) .then(response => response.json()) .then(response => console.log(response)) .catch(err => console.error(err));