Sign in

v1

latestOpenAPI 3.0.02026-07-264731126.7 KB

Get all payouts

With this endpoint you can list all payouts. <Tip>HTTP Request <br/>GET https://api.firstpromoter.com/api/v2/company/payouts</Tip>

get/payouts

Query parameters

qstring

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]'pending' | 'completed' | 'failed' | 'processing' | 'cancelled'

Filter by status

integer
OR
integer[]

Campaign ids. Can be Integer or Array of Integers

integer
OR
integer[]

Payment batches ids. Can be Integer or Array of Integers

filters[due_period]'next' | 'overdue' | 'custom'

Due period

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]'paypal' | 'bank' | 'wise' | 'crypto' | 'custom' | 'dots' | 'not_set'

Payout method

filters[promoter_id]integer

Promoter id

filters[only_payable]boolean

Only payable payouts

filters[group_ref]string

Group reference

filters[fraud_suspicions]string[]

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

sorting[amount]'asc' | 'desc'

The sort by amount direction

sorting[period_start]'asc' | 'desc'

Period start

sorting[period_end]'asc' | 'desc'

Period end

Headers

Account-IDstring required

Account id. You can find your Account ID on Your FirstPromoter Dashboard. Navigate to Settings → Integrations

Response

Successful response

idinteger

Unique identifier for the payout

status'pending' | 'completed' | 'failed' | 'processing' | 'cancelled'

Status of the payout

amountnumber float

Amount of the payout

payments_batch_idinteger

ID of the payments batch

tax_ratenumber float

Tax rate applied to the payout

unitstring

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

period_startstring date-time

Start date of the period

period_endstring date-time

End date of the period

paid_atstring date-time

Date when the payout was paid

processing_started_atstring date-time

Date when the payout processing started

failed_atstring date-time

Date when the payout failed

errorstring

Error message if the payout failed

total_incl_taxnumber float

Total amount including tax

created_atstring date-time

Date when the payout was created