Payouts

Payouts can not be created through our API. Please visit the Dashboard to initiate a payout. You can use this endpoint to retrieve a list of past Payouts.

The Payout Object

Attribute

Description

id

The ID of the payout.

campaign_id

The campaign ID this payout belongs to.

method

The method this payout was made. Possible values: check, bank

status

The status of this payout. Possible values: pending, processing, completed, cancelled, failed.

amount

The amount reqeusted to be withdrawn.

fee

The fee charged to withdraw this payout.

tip

The tip left for the Givebutter team.

payout

The final amount to be payed out.

currency

The currency this payout was made in (currently only USD is supported)

address

An object representing the address a check was mailed to, if applicable.

memo

The memo written on a check, if applicable.

completed_at

A UTC datetime string indicating when the payout completed to process.

created_at

A UTC datetime string indicating when the payout was created.

get
Get Payouts

https://api.givebutter.com/v1/payouts/:id
Retrieve a list of your payouts. Include an id to retrieve a specific payout.
Request
Response
Request
Path Parameters
id
optional
string
ID of the payout.
Response
200: OK
Payout successfully retrieved.
{
"id": "UAJDNQ",
"campaign_id": 123,
"method": "bank",
"status": "pending",
"amount": 312,
"fee": 0,
"tip": 0,
"payout": 312,
"currency": "USD",
"address": {
"address_1": null,
"address_2": null,
"city": null,
"state": null,
"zipcode": null,
"country": null
},
"memo": null,
"completed_at": null,
"created_at": "2020-05-15 20:17:06"
}

‚Äč