Skip to main content
GET
/
affiliate
/
v1
/
payouts
Get all payouts
curl --request GET \
  --url https://api.firstpromoter.com/api/v2/affiliate/affiliate/v1/payouts \
  --header 'Account-ID: <account-id>' \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": 123,
      "status": "pending",
      "amount": 123,
      "payments_batch_id": 123,
      "tax_rate": 123,
      "unit": "<string>",
      "period_start": "2023-12-25",
      "period_end": "2023-12-25",
      "paid_at": "2023-11-07T05:31:56Z",
      "processing_started_at": "2023-11-07T05:31:56Z",
      "failed_at": "2023-11-07T05:31:56Z",
      "error": "<string>",
      "total_incl_tax": 123,
      "created_at": "2023-11-07T05:31:56Z",
      "payout_method": {},
      "promoter": {
        "id": 123,
        "email": "<string>",
        "name": "<string>"
      },
      "campaign": {
        "id": 123,
        "name": "<string>",
        "color": "<string>"
      }
    }
  ],
  "meta": {
    "net_payout_days": 123,
    "payout_cycle": "<string>",
    "min_payment": 123,
    "min_paying_customers": 123,
    "terms_description": "<string>",
    "selected_payout_methods": [
      "<string>"
    ],
    "payout_method_options": {},
    "managed_payouts": true
  }
}

Authorizations

​
Authorization
string
header
required

Access token passed as a Bearer token in the Authorization header

Headers

​
Account-ID
string
required

Account identifier that specifies which account is making the request

Example:

"acc_123456"

Query Parameters

​
q
string

Search params. Searches by 'promoter.profile.first_name,promoter.profile.last_name,promoter.user.email`

​
filters[status]
enum<string>

Status filter

Available options:
pending,
completed,
failed,
processing,
cancelled
​
filters[campaign_id]

Campaign ids filter

​
filters[payments_batch_id]

Payment batches ids filter

​
filters[due_period]
enum<string>

Due period filter

Available options:
next,
overdue,
custom
​
filters[period_start]
string<date>

Period start filter. Send "not_set" for returning the ones with period_start == null

​
filters[period_end]
string<date>

Period end filter. Send "not_set" for returning the ones with period_end == null

​
filters[payout_method]
enum<string>

Payout method filter

Available options:
paypal,
bank,
wise,
crypto,
custom,
dots,
not_set
​
filters[group_ref]
string

Group ref filter

Response

List of payouts

​
data
object[]
​
meta
object