Skip to main content
Retrieve the list of payouts for a account. 
GET https://services.leadconnectorhq.com/affiliate-manager/{locationId}/payouts

​
Autorización

​
Authorization
string
required
Bearer token generado desde el portal Leadway. Ver Autenticación.
​
Version
string
default:"2021-07-28"
required
Versión de la API.

​
Path parameters

​
locationId
string
default:"ve9EPM428h8vShlRW1KT"
required
Account Id

​
Query parameters

​
status
string
default:"pending"
Payout status
​
query
string
default:"john"
query
​
affiliateId
string
default:"65df04201e428a0c5ebb6572"
Affiliate Id
​
campaignId
string
default:"65df04201e428a0c5ebb6573"
Campaign Id
​
skip
number
default:"1"
​
limit
number
default:"10"
​
start
string
default:"2022-12-01T00:00:00.000Z"
​
end
string
default:"2022-12-31T23:59:59.999Z"

​
Respuestas

​
payouts
object[]
required
Payout list
​
meta
object
Pagination metadata
{
  "payouts": [
    {
      "_id": "65df04201e428a0c5ebb6571",
      "locationId": "ve9EPM428h8vShlRW1KT",
      "affiliateId": "65df04201e428a0c5ebb6572",
      "campaignId": "65df04201e428a0c5ebb6573",
      "currency": "USD",
      "amount": 150,
      "status": "pending",
      "payoutMonth": "2024-06-01T00:00:00.000Z",
      "dueAt": "2024-06-30T00:00:00.000Z",
      "paidAt": "2024-06-30T00:00:00.000Z",
      "paidMeta": {},
      "paidMethod": "manual",
      "altId": "alt_123",
      "deleted": false,
      "isMigrated": false,
      "createdAt": "2024-06-16T00:00:00.000Z",
      "updatedAt": "2024-06-17T00:00:00.000Z",
      "campaign": "Summer Promo",
      "affiliateName": "John Doe",
      "affiliateEmail": "john.doe@example.com",
      "payoutMethod": "paypal"
    }
  ]
}

{}

{}

{}

​
Ejemplo

curl -X GET 'https://services.leadconnectorhq.com/affiliate-manager/YOUR_locationId/payouts' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Version: 2021-07-28'

const response = await fetch('https://services.leadconnectorhq.com/affiliate-manager/YOUR_locationId/payouts', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
    Version: '2021-07-28',
  },
});
const data = await response.json();

import os, requests
response = requests.request(
    'GET',
    'https://services.leadconnectorhq.com/affiliate-manager/YOUR_locationId/payouts',
    headers={
        'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
        'Version': '2021-07-28',
    },
)
data = response.json()

<?php
$ch = curl_init('https://services.leadconnectorhq.com/affiliate-manager/YOUR_locationId/payouts');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
        'Version: 2021-07-28',
    ],
]);
$data = json_decode(curl_exec($ch), true);