NAME

Business::GoCardless::Payout

DESCRIPTION

A class for a gocardless payout, extends Business::GoCardless::Resource

ATTRIBUTES

amount
arrival_date
created_at
currency
deducted_fees
fx
id
links
metadata
payout_type
reference
status
tax_currency

Status checks on a payout

pending
paid
bounced

if ( $Payout->paid ) {
    ...
}

Operations on a payout

update

Update the payout's metadata (Pro API only), returns the updated Payout object:

$Payout->update( metadata => { ... } );

AUTHOR

Lee Johnson - lee@payprop.com

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself. If you would like to contribute documentation, features, bug fixes, or anything else then please raise an issue / pull request:

https://github.com/payprop/business-gocardless