Links

List payouts

Returns a list of your payouts. Records are returned sorted by creation date, with the most recent items appearing first.

Request

GET
https://api.getrewardful.com/v1/payouts

Optional parameters

Parameter
Description
affiliate_id
Show payouts for the specified affiliate.
state
Show payouts that are currently in the specified states.
Valid values are pending, due, processing, and paid.
You can pass state[] to specify multiple states.

Expandable objects

Parameter
Description
affiliate
Include details about the affiliate this payout is associated with.
commissions
Include details about each of the commissions constituting this payout.

Examples

List all payouts

curl --request GET \
--url https://api.getrewardful.com/v1/payouts \
-u YOUR_API_SECRET:

List all payouts with data for the associated affiliate and commissions

curl --request GET \
--url https://api.getrewardful.com/v1/payouts?expand[]=affiliate&expand[]=commissions \
-u YOUR_API_SECRET:

List payouts for a specific affiliate

curl --request GET \
--url https://api.getrewardful.com/v1/payouts?affiliate_id=5768bd90-7953-493f-ae6c-6562eb4d7e72 \
-u YOUR_API_SECRET:

List payouts that have been marked as paid

curl --request GET \
--url https://api.getrewardful.com/v1/payouts?state= \
-u YOUR_API_SECRET:

List payouts that are either due or pending

curl --request GET \
--url https://api.getrewardful.com/v1/payouts?state[]=due&state[]=pending \
-u YOUR_API_SECRET: