NAME

Business::GoCardless::OutboundPayment

DESCRIPTION

A class for a gocardless outbound payment, extends Business::GoCardless::Resource

ATTRIBUTES

amount
created_at
currency
description
execution_date
id
is_withdrawal
links
metadata
reference
scheme
status
verifications

Operations on an outbound payment

update

Update the outbound payment's metadata:

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

approve

Approve the outbound payment:

$OutboundPayment->approve;

cancel

Cancel the outbound payment (only possible before it is executing):

$OutboundPayment->cancel;

Status checks on an outbound payment

verifying
pending_approval
scheduled
executing
executed
cancelled
failed

if ( $OutboundPayment->verifying ) {
    ...
}

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