Claim WireGuard Configuration After Payment Settlement

POST

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

Provisions or retrieves the WireGuard configuration once the Lightning invoice payment has settled. For orders created with a wgPublicKey, send the same wgPublicKey here; the response then contains only the tunnel parameters (server, peer, vpnPort) and never a config or private key. Rate limit: 10 requests/min per IP.

Request

Header Params

Body Params application/jsonRequired

Examples

Responses

🟢200OK

application/json

WireGuard configuration provisioned

Bodyapplication/json

🟢202

🟠402Record Not Found

🟠404

🟠409

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": "hnG/fWsNx7DiVbGUj3B/i0EtXvpIZdO5cuoQJCTWhRU="
}'

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",
    "status": "success",
    "subscriptionEnd": "2027-01-01T00:00:00.000Z",
    "server": {
        "endpoint": "de2.tunnelsats.com:51820",
        "publicKey": "string",
        "allowedIPs": "0.0.0.0/0, ::/0"
    },
    "peer": {
        "address": "10.9.0.7",
        "publicKey": "string",
        "presharedKey": "string"
    },
    "vpnPort": 24556
}

Modified at 2026-10-10 22:07:24

Check Invoice Status & Polling by Payment Hash

Autonomous Agent HTTP 402 Gateway (L402 Purchase + Claim)