Affiliates API
Affiliates
List All Affiliate Payouts
this endpoint ( get get ) retrieves all your affiliate payouts the response is paginated; therefore, you should use the 'page' parameter for navigating through the results in subsequent requests on successful completion, it returns an array of affiliate payout objects permissions affiliates view query parameters page fetch the results from a specific page it defaults to 1 per page the number of results to fetch per page the maximum is 50 and if it defaults to 10 from appendix docid\ kfbmx4q3dxjtduqf75yx1 start date used for filtering to appendix docid\ kfbmx4q3dxjtduqf75yx1 end date used for filtering filter optional text used for filtering results by name , email and country affiliate partner id filter the results for a specific affiliate partner affiliate program id filter the results for a specific affiliate program require "uri" require "net/http" url = uri("https //api tamio com/v2/affiliates/payouts/list?page=1\&per page=10") https = net http new(url host, url port) https use ssl = true request = net http get new(url) request\["accept"] = "application/json" request\["authorization"] = "bearer your token here" response = https request(request) puts response read body var myheaders = new headers(); myheaders append("accept", "application/json"); myheaders append("authorization", "bearer your token here"); var requestoptions = { method 'get', headers myheaders, redirect 'follow' }; fetch("https //api tamio com/v2/affiliates/payouts/list?page=1\&per page=10", requestoptions) then(response => response text()) then(result => console log(result)) catch(error => console log('error', error));curl location request get 'https //api tamio com/v2/affiliates/payouts/list?page=1\&per page=10' \\ \ header 'accept application/json' \\ \ header 'authorization bearer your token here'{ "payouts" \[ { "id" "29bb3ca1 3247 4277 98d7 6fd048ba0e4e", "currency" "eur", "paid" false, "prefix" null, "number" 173, "total" 12000, "payment" "bankaccount", "date" 1709684304, "object" "payout", "status" "new", "affiliate program" { "label" "old affiliate program", "id" "1b14bd47 3bca 469c 8b24 e7170e8ffba2" }, "affiliate partner" { "object" "affiliate", "email" "test\@example com", "name" "james", "surname" "dean", "address" "asdsada", "city" "sdasa", "state" null, "country" "ro", "postcode" "adsdasdd", "vat" "gb123456", "telephone" null, "id" "7cbfc37a 55cc 447d 8c5b ebf5e17cd5cd", "affiliate program id" "1b14bd47 3bca 469c 8b24 e7170e8ffba2", "affiliate program label" "old affiliate program", "currency" "eur", "sales" 0, "referrals" 0, "balance" 0, "bonus" 0, "approved" true, "date joined" 1709682069, "language" "en", "payments" \[ "bankaccount" ] }, "invoice" { "id" "29bb3ca1 3247 4277 98d7 6fd048ba0e4e", "currency" "eur", "paid" false, "object" "invoice", "type" "payout", "prefix" "", "number" 173, "total" 12000, "payment" "bankaccount", "date" 1709684304, "status" "new", "subscription" null, "is instalment" false, "merchant" { "address" "test street 1", "city" "bucharest", "country" "ro", "email" "test\@example com", "name" "amazon europe core s a r l ", "postcode" "123456", "state" null, "telephone" null, "vat" "ro123456" }, "locale" "en", "customer information" { "billing information" { "address" null, "city" null, "country" "de", "custom billing fields" null, "email" "customer\@example com", "id" "5e5a2b2b 4ed7 4308 80ee 4db1b1660268", "ip" null, "is company" null, "last name" null, "locale" null, "name" "awesome ltd", "object" "address", "phone" null, "postcode" null, "representative" null, "shipping address" null, "state" null, "vat" null, "verified vat" false }, "country" "de", "email" "customer\@example com", "id" "b0a6e9dc 5994 4c00 87e1 85b3caa2be1b", "last name" null, "locale" "en", "name" "superstaff ltd", "stripe customer id" "cus nrvirrasjrajws" }, "products" \[ { "cancelled" false, "classification" "invoice item", "currency" "eur", "delivered" false, "discount allowed" false, "discounts" \[], "has shipping" false, "id" null, "invoice item id" "762a3a6b 8573 4be2 9b94 0c926990c862", "is moss product" null, "is variant" false, "name" "payout for affiliate program old affiliate program", "pack" null, "quantity" 1, "reservations" \[], "tax" { "shipping tax rates" \[], "tax rates" \[] }, "taxes" { "inclusive" false, "shipping tax rates" \[], "tax rates" \[] }, "totals" { "amount cancelled" 0, "amount paid" 0, "amount refunded" 0, "discount" 0, "exchange rate" null, "full price" 0, "item total" 12000, "item total with tax" 12000, "moss tax total" 0, "moss taxable amount" 0, "price conversion" false, "shipping" 0, "shipping discount" 0, "shipping subtotal" 0, "shipping tax" 0, "shipping total" 0, "subtotal" 12000, "tax" 0, "total" 12000, "unit price" 12000 }, "type" "invoice item", "variation id" null, "variation label" null } ], "discounts" \[], "licenses" \[], "start date" null, "end date" null, "totals" { "discount" 0, "item count" 1, "item total" 12000, "item total with tax" 12000, "moss tax total" 0, "moss taxable amount" 0, "price conversion" false, "shipping" 0, "shipping discount" 0, "shipping subtotal" 0, "shipping tax" 0, "shipping total" 0, "subtotal" 12000, "tax" 0, "total" 12000, "trial deductions" 0, "gateway fees" 0, "affiliate revenue" 0, "refunded total" 0, "amount paid" 0, "amount cancelled" 0, "amount due" 12000 }, "payment retried" null, "late failure" null, "taxes" { "has vat" false, "no tax" true, "shipping tax rates" \[], "tax rates" \[] }, "payment charge date" null, "authorization expiry" null, "shipping" null, "affiliate program" "1b14bd47 3bca 469c 8b24 e7170e8ffba2", "affiliate" null, "due date" null, "bank account" { "accountnumber" "12312321312", "bankaddress" "bank street 1", "bankname" "awesome bank ltd", "beneficiary" "superstaff ltd", "currency" "eur", "custom fields" \[], "iban" "cr123123123213", "swift" "cypn1", "type" "eur" }, "reviews" null, "appendix" null, "instalment plan" null, "consents" null } } ], "total results" 1, "status" 200, "page" 1, "per page" 10 }