@nowpaymentsio/nowpayments-mass-payments-api-js
Advanced tools
Readme
A library for interacting with the NOWPayments Mass Payments API.
Using npm:
$ npm install @nowpaymentsio/nowpayments-mass-payments-api-js
Using unpkg CDN:
<script src="https://unpkg.com/@nowpaymentsio/nowpayments-mass-payments-api-js/dist/nowpayments-mass-payments-api-js.min.js"></script>
const NowPaymentsMPApi = require('@nowpaymentsio/nowpayments-mass-payments-api-js');
const api = new NowPaymentsMPApi({ apiKey: 'your-api-key' }) // your api key
async function logBalance() {
const { token } = await api.auth({ email: 'your-email', password: 'your-password' })
const balance = await api.getBalance({ token })
console.log('Get balance: ', balance)
}
logBalance()
import React from 'react'
import NowPaymentsMPApi from '@nowpaymentsio/nowpayments-mass-payments-api-js'
const npApi = new NowPaymentsMPApi({ apiKey: 'your-api-key' }) // your api key
const App = () => {
const [balance, setBalance] = React.useState()
React.useEffect(() => {
async function fetchBalance() {
const { token } = await npApi.auth({ email: 'your-email', password: 'your-password' })
const balance = await npApi.getBalance({ token })
setBalance(balance)
}
fetchBalance()
}, [])
return (
<div>
<h2>Get balance</h2>
<br />
{balance && Object.entries(balance).map(([key, value]) => (
<p key={key}>{key}-{value.amount}</p>
))}
</div>
)
}
export default App
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>NOWPayments API - HTML Example</title>
<script src="https://unpkg.com/@nowpaymentsio/nowpayments-mass-payments-api-js/dist/nowpayments-mass-payments-api-js.min.js"></script>
</head>
<body>
<h4>Get balance</h4>
<script>
const myParent = document.body;
const api = new NOWPaymentsMPApiJS({ apiKey: 'your-api-key' })
async function main() {
const { token } = await api.auth({ email: 'your-email', password: 'your-password' })
const balance = await api.getBalance({ token })
if (Object.keys(balance).length) {
const span = document.createElement("span")
span.id = "mySelect"
myParent.appendChild(span)
for (const [key, value] of Object.entries(balance)) {
span.innerHTML = `${key} - ${value.amount}`
}
}
}
main()
</script>
</body>
</html>
Authentication
| params | default | required | description |
|---|---|---|---|
| null | true | Account email | |
| password | null | true | Account password |
This is the method to create a payout
| params | default | required | description |
|---|---|---|---|
| withdrawals | null | true | Array of objects |
| token | null | true | Auth token from NPApi.auth() |
withdrawals: [
{
address: '', // The address where you want to send funds
currency: '', // Payout currency
amount: 0 // Amount of the payout. Must not exceed 6 decimals (i.e. 0.123456)
}
]
Get estimated price
| params | default | required | description |
|---|---|---|---|
| payout_id | null | true | Payout in the request |
Get payment status
| params | default | required | description |
|---|---|---|---|
| token | null | true | Auth token from NPApi.auth() |
Get payout status
| params | default | required | description |
|---|---|---|---|
| price_amount | null | true | Fiat equivalent of the price to be paid in crypto |
| price_currency | null | true | Fiat currency in which the price_amount is specified (usd, eur, etc) |
| pay_amount | null | false | Amount that users have to pay for the order stated in crypto |
| pay_currency | null | true | Crypto currency in which the pay_amount is specified (btc, eth, etc) |
| ipn_callback_url | null | false | Url to receive callbacks, should contain "http" or "https", eg. "https://nowpayments.io" |
| order_id | null | false | Inner store order ID, e.g. "RGDBP-21314" |
| order_description | null | false | Inner store order description, e.g. "Apple Macbook Pro 2019 x 1" |
| purchase_id | null | false | Id of purchase for which you want to create aother |
| payout_address | null | false | Usually the funds will go to the address you specify in your Personal account. In case you want to receive funds on another address, you can specify it in this parameter |
| payout_currency | null | false | Currency of your external payout_address, required when payout_adress is specified |
| payout_extra_id | null | false | Extra id or memo or tag for external payout_address |
| fixed_rate | null | false | Boolean, can be true or false. Required for fixed-rate exchanges |
FAQs
A library for interacting with the NOWPayments Mass Payments API
The npm package @nowpaymentsio/nowpayments-mass-payments-api-js receives a total of 3 weekly downloads. As such, @nowpaymentsio/nowpayments-mass-payments-api-js popularity was classified as not popular.
We found that @nowpaymentsio/nowpayments-mass-payments-api-js demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
UnitedHealth Group disclosed that the ransomware attack on Change Healthcare compromised protected health information for millions in the U.S., with estimated costs to the company expected to reach $1 billion.
Security News
GitHub is susceptible to a CDN flaw that allows attackers to host malware on any public repository.
Security News
At Node Congress, Socket CEO Feross Aboukhadijeh uncovers the darker aspects of open source, where applications that rely heavily on third-party dependencies can be exploited in supply chain attacks.