Claim WireGuard Configuration After Payment Settlement

POST

/api/public/v1/subscription/claim

Provisions or retrieves the WireGuard configuration file once the Lightning invoice payment has settled.

Request

Header Params

Body Params application/jsonRequired

Examples

Responses

🟢200OK

application/json

WireGuard configuration claimed successfully

Bodyapplication/json

🟠400Bad Request

🟠402

🟠404Record Not Found

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://tunnelsats.com/api/public/v1/subscription/claim' \
--header 'Accept;' \
--header 'Content-Type: application/json' \
--data '{
    "paymentHash": "a1b2c3d4e5f6...",
    "wgPublicKey": "pWyZTQx8C4gzzgMVJHiN1ptI46wDtyJSMRa+wxtkXOM=",
    "wgPresharedKey": "string",
    "referralCode": "string"
}'

Response Example

200 - Example 1

{
    "config": "[Interface]\nPrivateKey = ...\nAddress = 10.9.0.5/32\nDNS = 1.1.1.1\n\n[Peer]\nPublicKey = ...\nEndpoint = us3.tunnelsats.com:51820\nAllowedIPs = 0.0.0.0/0",
    "fullConfig": "string",
    "publicKey": "pWyZTQx8C4gzzgMVJHiN1ptI46wDtyJSMRa+wxtkXOM=",
    "vpnIp": "10.9.0.5"
}

Modified at 2026-08-31 19:53:35

Create a New WireGuard Subscription (Invoice Generation)

Check subscription status via payment hash