actionDELETEv1.0.0
Delete recurring payment
Completely removes a particular payment from the recurring payment plan. You need to specify the payment plan id in the request.
actionGETv1.0.0
Get all transfers
Returns the entire list of transfers created by your sub-partners.
actionGETv1.0.0
Get estimated price
This is a method for calculating the approximate price in cryptocurrency for a given value in Fiat currency. You will need to provide the initial cost in the Fiat currency (amount, currency_from) and the necessary cryptocurrency (currency_to) Currently following fiat currencies are available: usd, eur, nzd, brl, gbp.
actionGETv1.0.0
Get list of payments
Returns the entire list of all transactions, created with certain API key. The list of optional parameters: - limit - number of records in one page. (possible values: from 1 to 500) - page - the page number you want to get (possible values: from 0 to **page count - 1**) - sortBy - sort the received list by a paramenter. Set to **created_at** by default (possible values: payment_id, payment_status, pay_address, price_amount, price_currency, pay_amount, actually_paid, pay_currency, order_id, order_description, purchase_id, outcome_amount, outcome_currency) - orderBy - display the list in ascending or descending order. Set to **asc** by default (possible values: asc, desc) - dateFrom - select the displayed period start date (date format: YYYY-MM-DD or yy-MM-ddTHH:mm:ss.SSSZ). - dateTo - select the displayed period end date (date format: YYYY-MM-DD or yy-MM-ddTHH:mm:ss.SSSZ).
actionGETv1.0.0
Get many plans
This method allows you to obtain information about all the payment plans you’ve created.
actionGETv1.0.0
Get many recurring payments
The method allows you to view the entire list of recurring payments filtered by payment status and/or payment plan id
actionGETv1.0.0
Get one plan
This method allows you to obtain information about your payment plan. (you need to specify your payment plan id in the request).
actionGETv1.0.0
Get one recurring payment
Get information about a particular recurring payment via its ID. Here’s the list of available statuses: \- WAITING_PAY \- PAID \- PARTIALLY_PAID \- EXPIRED
actionGETv1.0.0
Get payment status
Get the actual information about the payment. You need to provide the ID of the payment in the request. NOTE! You should make the get payment status request with the same API key that you used in the create payment request. Here is the list of avalable statuses: - waiting - waiting for the customer to send the payment. The initial status of each payment. - confirming - the transaction is being processed on the blockchain. Appears when NOWPayments detect the funds from the user on the blockchain. - confirmed - the process is confirmed by the blockchain. Customer’s funds have accumulated enough confirmations. - sending - the funds are being sent to your personal wallet. We are in the process of sending the funds to you. - partially_paid - it shows that the customer sent the less than the actual price. Appears when the funds have arrived in your wallet. - finished - the funds have reached your personal address and the payment is finished. - failed - the payment wasn't completed due to the error of some kind. - refunded - the funds were refunded back to the user. - expired - the user didn't send the funds to the specified address in the 24 hour time window. Additional info: - outcome_amount - this parameter shows the amount that will be (or is already) received on your Outcome Wallet once the transaction is settled. - outcome_currency - this parameter shows the currency in which the transaction will be settled. - invoice_id - this parameter shows invoice ID from which the payment was created
actionGETv1.0.0
Get sub-partner balance
This request can be made only from a whitelisted IP. If IP whitelisting is disabled, this request can be made by any user that has an API key.
actionGETv1.0.0
Get sub-partners
This method returns the entire list of your sub-partners.
actionGETv1.0.0
Get the minimum payment amount
Get the minimum payment amount for a specific pair. You can provide both currencies in the pair or just currency\_from, and we will calculate the minimum payment amount for currency\_from and currency which you have specified as the outcome in the Store Settings. You can also specify one of the fiat currencies in the currency\_from. In this case, the minimum payment will be calculated in this fiat currency. You can also add field fiat\_equivalent (optional field) to get the fiat equivalent of the minimum amount. In the case of several outcome wallets we will calculate the minimum amount in the same way we route your payment to a specific wallet.
actionGETv1.0.0
Get transfer
Get the actual information about the transfer. You need to provide the transfer ID in the request.
actionPOSTv1.0.0
Get/Update payment estimate
This endpoint is required to get the current estimate on the payment, and update the current estimate. Please note! Calling this estimate before `expiration_estimate_date` will return the current estimate, it won’t be updated. `:id` \- payment ID, for which you want to get the estimate Response: `id` \- payment ID `token_id` - id of api key used to create this payment (please discard this parameter) `pay_amount` - payment estimate, the exact amount the user will have to send to complete the payment `expiration_estimate_date` - expiration date of this estimate
actionPATCHv1.0.0
Update plan
This method allows you to add necessary changes to a created plan. They won’t affect users who have already paid; however, the changes will take effect when a new payment is to be made.
actionPOSTv1.0.0
Verify payout
This method is required to verify payouts by using your 2fa code. You’ll have 10 attempts to verify the payout. If it is not verified after 10 attempts, the payout will remain in ‘creating’ status. Payout will be processed only when it is verified. Make sure to have your 2fa authentication enabled in your NOWPayments Account (in Account Settings). When 2fa is disabled, the code automatically goes to your registration email. The code sent by email is valid for one hour. Next is a description of the required request fields: - :batch-withdrawal-id - payout id you received in `2. Create payout` method - verification_code - 2fa code you received with your Google Auth app or via email In order to establish an automatic verification of payouts, you should switch 2FA through the application. There are several libraries for different frameworks aimed on generating a 2FA codes based on a secret key from your account settings. e.g: Speakeasy for JavaScript. We do not recommend to change any default settings. ``` const 2faVerificationCode = speakeasy.totp({ your_2fa_secret_key, encoding: 'base32', }) ```
Beyond the catalog
Any provider, on request.
01
Request it
Tell us which provider you need, and we will ship it in the registry.
02
Generate it
Point swirls add at an OpenAPI or GraphQL spec. Typed actions for any API you hold credentials for, today.
acme · integrations
terminal
~/acme $swirls add linear
✓ 12 typed actions · scopes and schemas included
~/acme $swirls add https://api.acme.dev/openapi.json
◆ Fetched spec · 38 operations
✓ 6 typed actions · generated from spec