1. class
  2. Bulldog
  3. \
  4. Strype
  5. \
  6. Resources
  7. \
  8. Payout

Payout

class Payout extends Resource implements PayoutInterface

A Payout object is created when you receive funds from Stripe, or when you initiate a payout to either a bank account or debit card of a connected Stripe account. You can retrieve individual payouts, as well as list all payouts. Payouts are made on varying schedules, depending on your country and industry.

Traits

Retrieve
Retrieve.
Update
Update.
ListAll
List All.

Properties

string $id A unique identifier for the resource. from Resource
protected mixed $response A response from Stripe. from Resource

Methods

string
getId()

Returns the unique identifier for this resource.

from Resource
mixed
getResponse()

Returns the raw Stripe response.

from Resource
void
setProperties()

Set the response data as properties on the class.

from Resource
Retrieve
retrieve(string $id)

Get a resource by the ID.

from Retrieve
Update
update(string $id, array $data)

Update a resource.

from Update
ListAll
listAll(array $arguments = [])

List all the resources.

from ListAll
PayoutInterface
create(int $amount, array $arguments = [], string $key = null, string $currency = 'usd')

To send funds to your own bank account, you create a new payout object.

PayoutInterface
cancel(string $id)

A previously created payout can be canceled if it has not yet been paid out. Funds will be refunded to your available balance. You may not cancel automatic Stripe payouts.

void
stripe(string $method, $arguments, $idempotencyKey = null)

No description

Details

in Resource at line 29
string getId()

Returns the unique identifier for this resource.

Return Value

string

in Resource at line 39
mixed getResponse()

Returns the raw Stripe response.

Return Value

mixed

in Resource at line 47
protected void setProperties()

Set the response data as properties on the class.

Return Value

void

in Retrieve at line 17
Retrieve retrieve(string $id)

Get a resource by the ID.

Parameters

string $id

Return Value

Retrieve

in Update at line 18
Update update(string $id, array $data)

Update a resource.

Parameters

string $id
array $data

Return Value

Update

in ListAll at line 21
ListAll listAll(array $arguments = [])

List all the resources.

This will list all of the resources from which this trait belongs to. It will then return itself, so you can method chain it, or reuse the same instantiation.

Parameters

array $arguments

Return Value

ListAll

at line 36
PayoutInterface create(int $amount, array $arguments = [], string $key = null, string $currency = 'usd')

To send funds to your own bank account, you create a new payout object.

Your Stripe balance must be able to cover the payout amount, or you’ll receive an “Insufficient Funds” error.

Parameters

int $amount
array $arguments
string $key
string $currency

Return Value

PayoutInterface

at line 54
PayoutInterface cancel(string $id)

A previously created payout can be canceled if it has not yet been paid out. Funds will be refunded to your available balance. You may not cancel automatic Stripe payouts.

Parameters

string $id

Return Value

PayoutInterface

at line 62
protected void stripe(string $method, $arguments, $idempotencyKey = null)

Parameters

string $method
$arguments
$idempotencyKey

Return Value

void