Claim WireGuard Configuration After Payment Settlement

POST

https://tunnelsats.com/api/public/v1/subscription/claim

Provisions or retrieves the WireGuard configuration file once the Lightning invoice payment has settled. Rate limit: 10 requests/min per IP.

Request

Header Params

Body Params application/jsonRequired

Examples

Responses

🟢200OK

application/json

WireGuard configuration provisioned

Bodyapplication/json

🟠402

🟠404Record Not Found

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://tunnelsats.com/api/public/v1/subscription/claim' \
--header 'Accept;' \
--header 'Authorization;' \
--header 'Content-Type: application/json' \
--data '{
    "paymentHash": "0b9af6ab9d3c7d6146e3f28ca11bf4b830f4cab95330c5a5c9b25b7827afc44c",
    "wgPublicKey": null
}'

Response Example

200 - Example 1

{
    "config": "[Interface]\nPrivateKey = ...\nAddress = 10.9.0.2/32\nDNS = 1.1.1.1\n\n[Peer]\nPublicKey = ...\nEndpoint = de2.tunnelsats.com:51820\nAllowedIPs = 0.0.0.0/0",
    "fullConfig": "string"
}

Modified at 2026-09-02 16:31:22

Check Invoice Status & Polling by Payment Hash

Get Subscription & Bandwidth Status by WireGuard Public Key