How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
BTCPay Server

BTCPay Server Stores (Payouts) API

Store pull payment payout operations

Documentation Provider Profile APIs.io OpenAPI GitHub

BTCPay Server Stores (Payouts) API is one of 31 APIs that BTCPay Server publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Stores (Payouts). The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, a GitHub repository, authentication docs, and rate-limit docs.

This API exposes 7 operations across 4 paths, and defines 10 schemas. It is described by OpenAPI 3.0.0, at version v1.

Requests are made against a single base URL, https://{btcpay-host}.

7 operations 4 paths 10 schemas 1 DELETE2 GET4 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
v1
Base URL
https://{btcpay-host}/api/v1
Authentication
API Key, HTTP Basic
Contact
BTCPay Server
License
MIT
Resource Areas
1

Authentication & Security 2

BTCPay Server Stores (Payouts) API declares 2 security schemes for authenticating requests. An API key is passed in the header as Authorization (API_Key). It accepts HTTP basic authentication (Basic). By default, every request must be authenticated.

  • API_Key — BTCPay Server API key. Format: 'token {apiKey}'
  • Basic — HTTP Basic Authentication with email and password

Paths & Operations 7

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

Stores (Payouts) 7

Store pull payment payout operations

POST
/api/v1/stores/{storeId}/payouts
Create Payout
Payouts_CreatePayoutThroughStore 1 param body → 200404422400
GET
/api/v1/stores/{storeId}/payouts
Get Store Payouts
PullPayments_GetStorePayouts 2 params → 200404
GET
/api/v1/stores/{storeId}/payouts/{payoutId}
Get Payout
GetStorePayout 2 params → 200404
POST
/api/v1/stores/{storeId}/payouts/{payoutId}
Approve Payout
PullPayments_ApprovePayout 2 params body → 200422400404
DELETE
/api/v1/stores/{storeId}/payouts/{payoutId}
Cancel Payout
PullPayments_CancelPayout 2 params → 200404
POST
/api/v1/stores/{storeId}/payouts/{payoutId}/mark-paid
Mark Payout as Paid
PullPayments_MarkPayoutPaid 2 params → 200422400404
POST
/api/v1/stores/{storeId}/payouts/{payoutId}/mark
Mark Payout
PullPayments_MarkPayout 2 params body → 200422400404

Schemas 10

The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are PayoutData (13 properties), CreatePayoutRequest (3 properties), ProblemDetails (2 properties), PayoutPaymentProof (1 property). Each schema is shown below with its type and property counts.

PayoutMethodId
string
Payout method IDs. Available payment method IDs for Bitcoin are: - "BTC-CHAIN": Onchain -"BTC-LN": Lightning
PayoutDataList
array
ProblemDetails
object
Description of an error happening during processing of the request
2 properties
PayoutData
object
13 properties
PayoutPaymentProof
object
Additional information around how the payout is being or has been paid out. The mentioned properties are all optional (except proofType) and you can introduce…
1 property
PayoutState
string
The state of the payout (AwaitingApproval, AwaitingPayment, InProgress, Completed, Cancelled)
CreatePayoutRequest
object
3 properties
StoreId
string
Store ID of the item
CreatePayoutThroughStoreRequest
ValidationProblemDetails
array
An array of validation errors of the request

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

btcpay-stores-payouts-api-openapi.yml Raw ↑

Other APIs BTCPay Server publishes across the network.

BTCPay Server API Keys API
AE Profile APIs.io
BTCPay Server Apps API
AE Profile APIs.io
BTCPay Server Authorization API
AE Profile APIs.io
BTCPay Server Crowdfund API
AE Profile APIs.io
BTCPay Server Files API
AE Profile APIs.io
BTCPay Server Health API
AE Profile APIs.io
BTCPay Server Invoices API
AE Profile APIs.io
BTCPay Server Lightning address API
AE Profile APIs.io
BTCPay Server Lightning (Internal Node) API
AE Profile APIs.io
BTCPay Server Lightning (Store) API
AE Profile APIs.io
BTCPay Server Miscelleneous API
AE Profile APIs.io
BTCPay Server Notifications (Current User) API
AE Profile APIs.io
#Stores (Payouts)
← Back to B APIs
API Details
ID
btcpay:btcpay-stores-payouts-api
Base URL
https://{btcpay-host}/api/v1
Docs
https://docs.btcpayserver.org/API/Greenfield/v1/
Provider
BTCPay Server
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=btcpay-stores-payouts-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/btcpay-stores-payouts-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of BTCPay Server Stores (Payouts) API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.