NAME

Business::GoCardless::Mandate

DESCRIPTION

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

ATTRIBUTES

    created_at
    consent_parameters
    funds_settlement
    id
    links
    metadata
    next_possible_charge_date
    payments_require_approval
    reference
    scheme
    status
    verified_at
    

Operations on a mandate

cancel

    $Mandate->cancel;

update

    $Mandate->update( %params );

note that you can only update the metadata on a mandate, so you must pass the params hash as something that looks like:

    %params = ( metadata => { ... } );

Status checks on a mandate

    pending_customer_approval
    pending_submission
    submitted
    active
    failed
    cancelled
    expired

    if ( $Mandate->failed ) {
        ...
    }

Funds settlement checks on a mandate

    is_managed
    is_direct

AUTHOR

Lee Johnson - leejo@cpan.org

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/Humanstate/business-gocardless