Links

Retrieve a payout

Retrieves the details of an existing payout. You need only supply the unique identifier (UUID) associated with the payout.

Request

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

Example

curl https://api.getrewardful.com/v1/payouts/3b03791a-3fb5-4bd6-8ec3-614c9fd978ca \
-u YOUR_API_SECRET:

Response

Success
Failure
Response code
Body
200
JSON object describing the payout
{
"id": "3b03791a-3fb5-4bd6-8ec3-614c9fd978ca",
"currency": "USD",
"paid_at": "2022-10-12T14:55:11.242Z",
"state": "paid",
"paid_by_id": "3e5c04ae-af80-4964-b280-23df034690d4",
"created_at": "2022-10-12T14:54:52.148Z",
"updated_at": "2022-10-12T14:55:11.276Z",
"amount": 1470,
"affiliate": {
"id": "5768bd90-7953-493f-ae6c-6562eb4d7e72",
"created_at": "2022-10-12T14:25:09.323Z",
"updated_at": "2022-11-08T09:13:05.954Z",
"state": "active",
"first_name": "Joe",
"last_name": "Example",
"email": "[email protected]",
"confirmed_at": "2022-10-12T14:25:09.323Z",
"paypal_email": null,
"paypal_email_confirmed_at": null,
"wise_email": null,
"wise_email_confirmed_at": null,
"receive_new_commission_notifications": false,
"sign_in_count": 0,
"unconfirmed_email": null,
"stripe_customer_id": null,
"stripe_account_id": null,
"visitors": 376,
"leads": 142,
"conversions": 56
},
"commissions": [
{
"id": "3a4a775c-b660-4d7f-a733-6f259a2646a7",
"currency": "USD",
"stripe_account_id": "acct_1GWIyRDLlKlZvFB2",
"due_at": "2022-07-31T15:55:19.000Z",
"paid_at": "2022-08-08T09:07:11.242Z",
"created_at": "2022-07-01T15:57:18.742Z",
"updated_at": "2022-07-01T15:57:18.742Z",
"amount": 1470
}
]
}

Not found

Response code
Body
404
JSON object describing the error.
{ "error": "Payout not found: 3b03791a-3fb5-4bd6-8ec3-614c9fd978c" }

Authentication failure

Response code
Body
401
Description of the authentication failure.
{ "error": "Invalid API Secret." }