GET
/
payouts
Get all payouts
curl --request GET \
  --url https://v2.firstpromoter.com/api/v2/company/payouts \
  --header 'Account-ID: <account-id>' \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": 123,
    "status": "pending",
    "amount": 123,
    "payments_batch_id": 123,
    "tax_rate": 123,
    "unit": "<string>",
    "period_start": "2023-11-07T05:31:56Z",
    "period_end": "2023-11-07T05:31:56Z",
    "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": {
      "id": 123,
      "method": "<string>",
      "date_added": "2023-11-07T05:31:56Z",
      "is_disabled": true,
      "meta": {},
      "is_selected": true,
      "details": {},
      "managed_payouts": true
    },
    "promoter": {
      "id": 123,
      "email": "<string>",
      "name": "<string>"
    },
    "campaign": {
      "id": 123,
      "name": "<string>",
      "color": "<string>"
    },
    "invoice": {
      "id": 123,
      "number": "<string>"
    }
  }
]

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`

​
ids[]
integer[]

Array of payout ids to get

​
filters[status]
enum<string>

Filter by status

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

Campaign ids. Can be Integer or Array of Integers

​
filters[payments_batch_id]

Payment batches ids. Can be Integer or Array of Integers

​
filters[due_period]
enum<string>

Due period

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

period_start starting from date

​
filters[period_start][to]
string<date>

period_start end at date

​
filters[period_end][from]
string<date>

period_end starting from date

​
filters[period_end][to]
string<date>

period_end end at date

​
filters[payout_method]
enum<string>

Payout method

Available options:
paypal,
bank,
wise,
crypto,
custom,
dots,
not_set
​
filters[promoter_id]
integer

Promoter id

​
filters[only_payable]
boolean

Only payable payouts

​
filters[group_ref]
string

Group reference

​
filters[fraud_suspicions]
enum<string>[]

Fraud suspicions. Multiple values can be passed as an array. Send ['no_suspicion'] to filter promoters with no fraud suspicions

​
sorting[amount]
enum<string>

The sort by amount direction

Available options:
asc,
desc
​
sorting[period_start]
enum<string>

Period start

Available options:
asc,
desc
​
sorting[period_end]
enum<string>

Period end

Available options:
asc,
desc

Response

Successful response

​
id
integer

Unique identifier for the payout

​
status
enum<string>

Status of the payout

Available options:
pending,
completed,
failed,
processing,
cancelled
​
amount
number

Amount of the payout

​
payments_batch_id
integer

ID of the payments batch

​
tax_rate
number

Tax rate applied to the payout

​
unit
string

Unit of the payout (e.g., cash)

​
period_start
string<date-time>

Start date of the period

​
period_end
string<date-time>

End date of the period

​
paid_at
string<date-time>

Date when the payout was paid

​
processing_started_at
string<date-time>

Date when the payout processing started

​
failed_at
string<date-time>

Date when the payout failed

​
error
string

Error message if the payout failed

​
total_incl_tax
number

Total amount including tax

​
created_at
string<date-time>

Date when the payout was created

​
payout_method
object
​
promoter
object
​
campaign
object
​
invoice
object