Create a conversion

POST

conversions

Create a conversion

curl --request POST \
  --url https://api.tapfiliate.com/1.6/conversions/ \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --data '
{
  "coupon": "JANE10OFF",
  "external_id": "ORD005",
  "amount": 100,
  "currency": "EUR",
  "meta_data": {
    "foo": "bar"
  },
  "program_group": "my-group",
  "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/75.0.3770.100 Safari/537.36",
  "ip": "111.11.11.111"
}
'

const options = {
  method: 'POST',
  headers: {'X-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    coupon: 'JANE10OFF',
    external_id: 'ORD005',
    amount: 100,
    currency: 'EUR',
    meta_data: {foo: 'bar'},
    program_group: 'my-group',
    user_agent: 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/75.0.3770.100 Safari/537.36',
    ip: '111.11.11.111'
  })
};

fetch('https://api.tapfiliate.com/1.6/conversions/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.tapfiliate.com/1.6/conversions/"

payload = {
    "coupon": "JANE10OFF",
    "external_id": "ORD005",
    "amount": 100,
    "currency": "EUR",
    "meta_data": { "foo": "bar" },
    "program_group": "my-group",
    "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/75.0.3770.100 Safari/537.36",
    "ip": "111.11.11.111"
}
headers = {
    "X-Api-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.tapfiliate.com/1.6/conversions/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'coupon' => 'JANE10OFF',
    'external_id' => 'ORD005',
    'amount' => 100,
    'currency' => 'EUR',
    'meta_data' => [
        'foo' => 'bar'
    ],
    'program_group' => 'my-group',
    'user_agent' => 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/75.0.3770.100 Safari/537.36',
    'ip' => '111.11.11.111'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-Api-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

require 'uri'
require 'net/http'

url = URI("https://api.tapfiliate.com/1.6/conversions/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"coupon\": \"JANE10OFF\",\n  \"external_id\": \"ORD005\",\n  \"amount\": 100,\n  \"currency\": \"EUR\",\n  \"meta_data\": {\n    \"foo\": \"bar\"\n  },\n  \"program_group\": \"my-group\",\n  \"user_agent\": \"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/75.0.3770.100 Safari/537.36\",\n  \"ip\": \"111.11.11.111\"\n}"

response = http.request(request)
puts response.read_body

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.tapfiliate.com/1.6/conversions/"

	payload := strings.NewReader("{\n  \"coupon\": \"JANE10OFF\",\n  \"external_id\": \"ORD005\",\n  \"amount\": 100,\n  \"currency\": \"EUR\",\n  \"meta_data\": {\n    \"foo\": \"bar\"\n  },\n  \"program_group\": \"my-group\",\n  \"user_agent\": \"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/75.0.3770.100 Safari/537.36\",\n  \"ip\": \"111.11.11.111\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-Api-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.tapfiliate.com/1.6/conversions/")
  .header("X-Api-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"coupon\": \"JANE10OFF\",\n  \"external_id\": \"ORD005\",\n  \"amount\": 100,\n  \"currency\": \"EUR\",\n  \"meta_data\": {\n    \"foo\": \"bar\"\n  },\n  \"program_group\": \"my-group\",\n  \"user_agent\": \"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/75.0.3770.100 Safari/537.36\",\n  \"ip\": \"111.11.11.111\"\n}")
  .asString();

{
  "id": 2,
  "external_id": "ORD005",
  "amount": 100,
  "click": null,
  "commissions": [
    {
      "id": 2,
      "conversion_sub_amount": 100,
      "amount": 10,
      "commission_type": "standard",
      "approved": null,
      "affiliate": {
        "id": "janejameson",
        "firstname": "Jane",
        "lastname": "Jameson"
      },
      "kind": "regular",
      "currency": "EUR",
      "created_at": "2021-03-03T12:39:19+0000",
      "payout": null,
      "comment": null,
      "final": null,
      "commission_name": "standard"
    },
    {
      "id": 3,
      "conversion_sub_amount": 100,
      "amount": 5,
      "commission_type": "level-2",
      "approved": null,
      "kind": "level",
      "affiliate": {
        "id": "sandrasanderson",
        "firstname": "Sandra",
        "lastname": "Sanderson"
      },
      "currency": "EUR",
      "created_at": "2021-03-03T12:39:19+0000",
      "payout": null,
      "comment": null,
      "final": null,
      "commission_name": "Level 2"
    }
  ],
  "program": {
    "id": "johns-affiliate-program",
    "title": "John's affiliate program",
    "currency": "USD"
  },
  "affiliate": {
    "id": "janejameson",
    "firstname": "Jane",
    "lastname": "Jameson"
  },
  "customer": null,
  "meta_data": {
    "foo": "bar"
  },
  "created_at": "2021-03-03T12:39:19+0000",
  "warnings": null,
  "affiliate_meta_data": null
}

{
  "errors": [
    {
      "message": "Missing mandatory parameter(s)"
    }
  ]
}

{
  "message": "Authentication Failed.",
  "code": 401
}

{
  "message": "Forbidden",
  "code": 403,
  "traceId": "04ed655728a22bc0d39f"
}

Authorizations

X-Api-Key

string

header

required

Your API key, from your Tapfiliate account settings.

Query Parameters

Body

application/json

referral_code

string

An affiliate's referral code. This corresponds to the value of ref= in their referral link.

Example:

"janejameson"

tracking_id

string

XXX-XXXX-XXXX-XXXXX (string) - The tracking id, to be retrieved from our javascript library. Please refer to our REST API integration guide for more info.

Example:

"XXXXX"

click_id

string

The click id. Used to add additional reporting information.

Example:

"1-abc"

coupon

string

A coupon code to track the conversion by

Example:

"JANE10OFF"

currency

string

The three letter ISO currency code. Override the program's default currency for this conversion by explicitely passing a currency code.

Example:

"USD"

asset_id

string

The asset id

Example:

"1-aaaaaa"

source_id

string

The source id

Example:

"1-ssssss"

external_id

string

A unique id for this conversion. It can be anything that is meaningful to you, like an order number, user id, email adres etc.. After a conversion has taken place, you can find this id alongside the conversion on our platform. This makes it very easy to cross-reference data on our platform with your own administration. This id has to be unique for every conversion.

Example:

"foobar1"

amount

number

The conversion amount

Example:

30.55

customer_id

string

The id for the current customer in your system. Depending on your program settings, this can be used for recurring / lifetime commissions. You can read more about this here

Example:

"USER123"

commission_type

string

If no commission type is supplied, the programs default commission type is used

Example:

"mycommissiontype"

commissions

any[]

Will override "amount" and "commission_type" if set

program_group

string

The program group id

Example:

"myprogramgroup"

user_agent

string

The client's user agent string. Used for statistics and fraud detection.

Example:

"ua string"

string

The client's ip. Used for fraud detection.

Example:

"111.11.11.111"

Response

number

external_id

string

amount

number

click

unknown

commissions

object[]

Show child attributes

program

object

Show child attributes

affiliate

object

Show child attributes

customer

unknown

meta_data

object

Show child attributes

created_at

string

warnings

unknown

affiliate_meta_data

unknown

Create a conversion

curl --request POST \
  --url https://api.tapfiliate.com/1.6/conversions/ \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --data '
{
  "coupon": "JANE10OFF",
  "external_id": "ORD005",
  "amount": 100,
  "currency": "EUR",
  "meta_data": {
    "foo": "bar"
  },
  "program_group": "my-group",
  "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/75.0.3770.100 Safari/537.36",
  "ip": "111.11.11.111"
}
'

const options = {
  method: 'POST',
  headers: {'X-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    coupon: 'JANE10OFF',
    external_id: 'ORD005',
    amount: 100,
    currency: 'EUR',
    meta_data: {foo: 'bar'},
    program_group: 'my-group',
    user_agent: 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/75.0.3770.100 Safari/537.36',
    ip: '111.11.11.111'
  })
};

fetch('https://api.tapfiliate.com/1.6/conversions/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.tapfiliate.com/1.6/conversions/"

payload = {
    "coupon": "JANE10OFF",
    "external_id": "ORD005",
    "amount": 100,
    "currency": "EUR",
    "meta_data": { "foo": "bar" },
    "program_group": "my-group",
    "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/75.0.3770.100 Safari/537.36",
    "ip": "111.11.11.111"
}
headers = {
    "X-Api-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.tapfiliate.com/1.6/conversions/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'coupon' => 'JANE10OFF',
    'external_id' => 'ORD005',
    'amount' => 100,
    'currency' => 'EUR',
    'meta_data' => [
        'foo' => 'bar'
    ],
    'program_group' => 'my-group',
    'user_agent' => 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/75.0.3770.100 Safari/537.36',
    'ip' => '111.11.11.111'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-Api-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

require 'uri'
require 'net/http'

url = URI("https://api.tapfiliate.com/1.6/conversions/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"coupon\": \"JANE10OFF\",\n  \"external_id\": \"ORD005\",\n  \"amount\": 100,\n  \"currency\": \"EUR\",\n  \"meta_data\": {\n    \"foo\": \"bar\"\n  },\n  \"program_group\": \"my-group\",\n  \"user_agent\": \"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/75.0.3770.100 Safari/537.36\",\n  \"ip\": \"111.11.11.111\"\n}"

response = http.request(request)
puts response.read_body

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.tapfiliate.com/1.6/conversions/"

	payload := strings.NewReader("{\n  \"coupon\": \"JANE10OFF\",\n  \"external_id\": \"ORD005\",\n  \"amount\": 100,\n  \"currency\": \"EUR\",\n  \"meta_data\": {\n    \"foo\": \"bar\"\n  },\n  \"program_group\": \"my-group\",\n  \"user_agent\": \"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/75.0.3770.100 Safari/537.36\",\n  \"ip\": \"111.11.11.111\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-Api-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.tapfiliate.com/1.6/conversions/")
  .header("X-Api-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"coupon\": \"JANE10OFF\",\n  \"external_id\": \"ORD005\",\n  \"amount\": 100,\n  \"currency\": \"EUR\",\n  \"meta_data\": {\n    \"foo\": \"bar\"\n  },\n  \"program_group\": \"my-group\",\n  \"user_agent\": \"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/75.0.3770.100 Safari/537.36\",\n  \"ip\": \"111.11.11.111\"\n}")
  .asString();

{
  "id": 2,
  "external_id": "ORD005",
  "amount": 100,
  "click": null,
  "commissions": [
    {
      "id": 2,
      "conversion_sub_amount": 100,
      "amount": 10,
      "commission_type": "standard",
      "approved": null,
      "affiliate": {
        "id": "janejameson",
        "firstname": "Jane",
        "lastname": "Jameson"
      },
      "kind": "regular",
      "currency": "EUR",
      "created_at": "2021-03-03T12:39:19+0000",
      "payout": null,
      "comment": null,
      "final": null,
      "commission_name": "standard"
    },
    {
      "id": 3,
      "conversion_sub_amount": 100,
      "amount": 5,
      "commission_type": "level-2",
      "approved": null,
      "kind": "level",
      "affiliate": {
        "id": "sandrasanderson",
        "firstname": "Sandra",
        "lastname": "Sanderson"
      },
      "currency": "EUR",
      "created_at": "2021-03-03T12:39:19+0000",
      "payout": null,
      "comment": null,
      "final": null,
      "commission_name": "Level 2"
    }
  ],
  "program": {
    "id": "johns-affiliate-program",
    "title": "John's affiliate program",
    "currency": "USD"
  },
  "affiliate": {
    "id": "janejameson",
    "firstname": "Jane",
    "lastname": "Jameson"
  },
  "customer": null,
  "meta_data": {
    "foo": "bar"
  },
  "created_at": "2021-03-03T12:39:19+0000",
  "warnings": null,
  "affiliate_meta_data": null
}

{
  "errors": [
    {
      "message": "Missing mandatory parameter(s)"
    }
  ]
}

{
  "message": "Authentication Failed.",
  "code": 401
}

{
  "message": "Forbidden",
  "code": 403,
  "traceId": "04ed655728a22bc0d39f"
}

Overview

Customers

Conversions

Commissions

Affiliates

Affiliate Groups

Affiliate Prospects

Programs

Payments

Clicks

Authorizations

Query Parameters

Body

Response