Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

NOWPayments Payouts API

Mass payouts and balance management

NOWPayments Payouts API is one of 10 APIs that NOWPayments publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Payouts. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 3 operations across 3 paths, and defines 8 schemas. It is described by OpenAPI 3.0.3, at version 1.0.0.

Requests are made against 2 base URLs: https://api.nowpayments.io/v1, https://api.sandbox.nowpayments.io/v1.

3 operations 3 paths 8 schemas 2 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0.0
Base URL
https://api.nowpayments.io/v1
Authentication
API Key, HTTP Bearer
Terms of Service
Resource Areas
1

Authentication & Security 2

NOWPayments Payouts API declares 2 security schemes for authenticating requests. An API key is passed in the header as x-api-key (ApiKeyAuth). It accepts HTTP bearer tokens (JWT) (BearerAuth). By default, every request must be authenticated.

  • ApiKeyAuth — NOWPayments API key obtained from your merchant dashboard
  • BearerAuth — JWT token obtained from the /auth endpoint (required for mass payout operations)

Paths & Operations 3

Across 3 paths, the API surfaces 3 operations — 2 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Payouts 3

Mass payouts and balance management

POST
/payout
Create a mass payout
createPayout body → 201400401
GET
/payout/{payout_id}
Get payout status
getPayoutStatus 1 param → 200404401
GET
/balance
Get account balance
getBalance → 200401

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are PayoutItemStatus (6 properties), PayoutStatusResponse (4 properties), WithdrawalItem (3 properties), PayoutResponse (2 properties). Each schema is shown below with its type and property counts.

PayoutStatusResponse
object
4 properties
WithdrawalItem
object
3 properties 3 required
PayoutItemStatus
object
6 properties
CreatePayoutRequest
object
1 property 1 required
ErrorResponse
object
2 properties
PayoutResponse
object
2 properties
BalanceCurrency
object
1 property
BalanceResponse
object
Map of currency code to balance details

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

now-payments-payouts-api-openapi.yml Raw ↑

Other APIs NOWPayments publishes across the network.

NOWPayments Mass Payouts API
NOWPayments Recurring Payments API
NOWPayments Custody API
NOWPayments Authentication API
NOWPayments Currencies API
NOWPayments Estimates API
NOWPayments Invoices API
NOWPayments Payments API
NOWPayments Status API