Demo docs: examples are illustrative.
Referral API

Track a payment

POST
/events/payment

Report a successful payment. Rewards are calculated from the net amount.

Authorization

apiKey
headerAuthorizationBearer <token>

Use a secret key such as sk_test_... in test mode or sk_live_... in production.

Header Parameters

Idempotency-Key?string

A unique key that makes retries safe. Keys expire after 24 hours.

Formatuuid

Request Body

application/json
  1. body
external_id*string

The customer who paid.

payment_id*string

Your payment or invoice ID. Used to match refunds later.

amount*integer

Net amount in the smallest currency unit, after tax and discounts.

currency*string

Response Body

The payment was accepted for processing.

Example Request
curl -X POST 'https://api.referralapi.example/v1/events/payment' \  -H 'Content-Type: application/json' \  -d '{  "external_id": "string",  "payment_id": "in_1PqR2s",  "amount": 4900,  "currency": "usd"}'
Example Response202
Empty

Track a signup POST

Call this when someone creates an account. If the visitor arrived through a share link, pass the referral code so the signup is attributed to the right referrer.

Track a refund POST

Reduces or reverses rewards that came from the original payment, according to your program rules.