EUrouter

Referrals

Read your EUrouter referral profile and payout history, and manage payout details through the API with a management key.

OpenAPI JSON

Get referral dashboard

GET
/api/v1/referrals

Get referral code, balance, referred users count, and commission history.

Authentication: Requires an organization-wide management key for the creator's own personal organization. Read-only management keys are accepted.

Authorization

personalManagementKey
AuthorizationBearer <token>

Requires organization-wide access for the creator's own personal organization. Management key from Settings → Management keys. Format: eur_mgmt_<public-id>.<secret>. Read-only management keys support GET and HEAD only.

In: header

Response Body

application/json

curl -X GET "https://api.eurouter.ai/api/v1/referrals"
{
  "data": {
    "referralCode": "string",
    "totalReferredUsers": 0,
    "balance": "string",
    "lifetimeEarnings": "string",
    "lifetimePaidOut": "string",
    "commissions": [
      {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "amountEur": "string",
        "status": "pending",
        "createdAt": "2019-08-24T14:15:22Z"
      }
    ]
  }
}

Request referral payout

POST
/api/v1/referrals/payout

Request a withdrawal from referral balance. Minimum €25.

Authentication: Requires an organization-wide management key for the creator's own personal organization. Read-only management keys cannot use this endpoint.

Authorization

personalManagementKey
AuthorizationBearer <token>

Requires organization-wide access for the creator's own personal organization. Management key from Settings → Management keys. Format: eur_mgmt_<public-id>.<secret>. Read-only management keys support GET and HEAD only.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

amountEur*string

Payout amount in EUR (minimum €25)

Response Body

application/json

curl -X POST "https://api.eurouter.ai/api/v1/referrals/payout" \  -H "Content-Type: application/json" \  -d '{    "amountEur": "string"  }'
{
  "data": {
    "payoutId": "c3d65312-6575-43de-b8ae-728d8d0a9371",
    "amountEur": "string",
    "status": "string"
  }
}

Was this page helpful?

Still stuck? Contact support