Skip to main content
GET
/
payouts
/
{payout}
Retrieve a payout
curl --request GET \
  --url https://api.givebutter.com/v1/payouts/{payout} \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "campaign_id": "<string>",
  "method": "<string>",
  "status": "<string>",
  "amount": 123,
  "fee": 123,
  "tip": 123,
  "payout": 123,
  "currency": "<string>",
  "memo": "<string>",
  "expected_at": "<string>",
  "paid_at": "<string>",
  "completed_at": "<string>",
  "created_at": "<string>",
  "updated_at": "<string>",
  "address": "<string>"
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

payout
string
required

The payout number

Query Parameters

name
string
required
Maximum string length: 40
address_1
string | null
required
Maximum string length: 64
address_2
string | null
Maximum string length: 64
city
string | null
required
Maximum string length: 200
state
string | null
required
Required string length: 2
zipcode
string | null
required
Required string length: 5
country
string | null
Required string length: 3
memo
string | null
Maximum string length: 40

Response

PayoutResource

id
string
required
campaign_id
string
required
method
string
required

TODO: Deprecate this

status
string
required
amount
number
required
fee
number
required
tip
number
required
payout
number
required
currency
string
required
memo
string
required
expected_at
string
required
paid_at
string
required
completed_at
string
required
created_at
string
required

TODO: Deprecate this, backwards compatibility

updated_at
string
required
address
string