Revenue Tracking API

This documentation is for tracking revenue from your backend only! For tracking revenue from your app please go through the Flutter or React Native documentation.

​

Base URL

https://api.linkrunner.io/api/v1

​

Authentication

Generate your server code from https://www.linkrunner.io/settings?s=data-apis

In the request header add the below attribute:

linkrunner-key: YOUR-SERVER-KEY

​

Capture payment

POST: /capture-payment

​

Request Body

{
    "user_id": "666",
    "payment_id": "ABC", // optional but recommended
    "amount": 25096, // Send amount in one currency only
    "type": "FIRST_PAYMENT", // optional
    "status": "PAYMENT_COMPLETED" // optional
}

NOTE: If you accept payments in multiple currencies convert them to one currency before calling the API.

​

Responses

1. 201 Payment captured
2. 401 Invalid server key

​

Remove captured payment

POST: /remove-payment

​

Request Body

{
    "user_id": "666",
    "payment_id": "ABC"
}

NOTE: user_id or payment_id is required in order to remove a payment entry. If you pass user_id, all the payments attributed to that user will be removed!

​

Responses

1. 200 Payment entry/entries deleted
2. 400 No payment found with the given payment id or user id
3. 401 Invalid server key