BTCPay Server | Operate As Docs

Connect your client's BTCPay Server with a key they paste, and call its API through Operate As.

Website: btcpayserver.org
Connects by: Pasting a API key
Category: Payments
Services: 1
Tools: 195

Service	Key	Base URL
BTCPay Server	`btcpay-server`	`https://{site}/api/v1`

Your client also types their btcpay server address (Where your BTCPay Server is, such as mainnet.demo.btcpayserver.org, without https://).

Connecting

Your client makes a API key in their BTCPay Server settings and pastes it on their link. Operate As tries it with BTCPay Server before saving it, and stores it encrypted. See Services connected with an API key.

Check they're connected

curl https://api.operate.as/v1/me/clients \
  -H "Authorization: Bearer $OPERATE_AS_API_KEY"

curl https://api.operate.as/v1/me/clients \  -H "Authorization: Bearer $OPERATE_AS_API_KEY"

Response

[
  {
    "id": "6f1c2a7e-...",
    "name": "Miller Dental",
    "services": [
      "btcpay-server"
    ]
  }
]

[  {    "id": "6f1c2a7e-...",    "name": "Miller Dental",    "services": [      "btcpay-server"    ]  }]

Permissions

What the client reads	Permission it asks for
Use the BTCPay Server key you paste, with only the access you gave that key	Chosen on the provider's screen

Tools

Install BTCPay Server's typed package for your language:

pip install operate-as-btcpay-server

pip install operate-as-btcpay-server

Run btcpay-server.api_keys_create_api_key

curl -X POST https://api.operate.as/v1/actions/btcpay-server.api_keys_create_api_key \
  -H "Authorization: Bearer $OPERATE_AS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "clientId": "6f1c2a7e-...",
    "input": {}
  }'

curl -X POST https://api.operate.as/v1/actions/btcpay-server.api_keys_create_api_key \  -H "Authorization: Bearer $OPERATE_AS_API_KEY" \  -H "Content-Type: application/json" \  -d '{    "clientId": "6f1c2a7e-...",    "input": {}  }'

Every input, with its JSON Schema: GET /v1/actions/btcpay-server.api_keys_create_api_key

Response

{
  "status": 200,
  "data": {
    "…": "the service's own response"
  },
  "encoding": "json"
}

{  "status": 200,  "data": {    "…": "the service's own response"  },  "encoding": "json"}

Pass-through

Paths continue from https://{site}/api/v1, with the parts in braces filled in from your client's account. Your Operate As key goes in Authorization; the client's access is added for you.

See Pass-through requests for the full request and response format.

Call any endpoint

curl "https://api.operate.as/v1/clients/6f1c2a7e-.../btcpay-server/..." \
  -H "Authorization: Bearer $OPERATE_AS_API_KEY"

curl "https://api.operate.as/v1/clients/6f1c2a7e-.../btcpay-server/..." \  -H "Authorization: Bearer $OPERATE_AS_API_KEY"

Response

{
  "status": 200,
  "data": {
    "…": "the service's own response"
  },
  "encoding": "json"
}

{  "status": 200,  "data": {    "…": "the service's own response"  },  "encoding": "json"}

When access ends

A key works until your client deletes it in BTCPay Server. They can paste a new one on the same link at any time, and your workflows carry on without changes.

See Keeping access alive and Removing access.

Calls answer, once the key is deleted

{
  "status": 401,
  "data": {
    "…": "the service's own error"
  },
  "encoding": "json"
}

{  "status": 401,  "data": {    "…": "the service's own error"  },  "encoding": "json"}