Payouts
List payouts
Changed onReturns the payouts Adfin has made to the bank account.
get/payouts
Request
- Base URLhttps://api.adfin.com/api
- URLhttps://api.adfin.com/api/payouts
- Auth
- OAuth 2Client credentialsToken URL: https://api.staging.adfin.com/api/oauth2/token
- or OAuth 2Client credentialsToken URL: https://api.adfin.com/api/oauth2/token
Query parameters
statusstring[]
Only return payouts in these states. Repeat the parameter to name more than one, combined with OR. Omit it to return every state.
[ "SENT" ]
minPayoutDatestring date
Only return payouts paid out on or after this date. Inclusive.
Example:2026-08-01
maxPayoutDatestring date
Only return payouts paid out on or before this date. Inclusive.
Example:2026-08-31
pageinteger
Which page to return, counting from one.
Example:1
sizeinteger
How many payouts to return per page. A request for more than the maximum is refused.
Example:50
sort'payoutDate,desc' | 'payoutDate,asc'
How to order the page.
Response
The requested page of payouts.
Example response
{
"payouts": [
{
"payoutDate": "2026-08-24"
}
]
}Changes
- info
the endpoint scheme security
Biller Access Token (Production)was added to the API - info
the endpoint scheme security
Biller Access Token (Staging)was added to the API
- info
- info
endpoint added
- info