NAME

PayProp::API::Public::Client::Request::Export::Beneficiaries - Beneficiary export module.

SYNOPSIS

my $Export = $Client->export;
my $beneficiaries_export = $Export->beneficiaries;

$beneficiaries_export
	->list_p({...})
	->then( sub {
		my ( $beneficiaries ) = @_;
		...;
	} )
	->wait
;

DESCRIPTION

Implementation for retrieving beneficiary export results via API.
This module is intended to be accessed via instance of C<PayProp::API::Public::Client>.

ATTRIBUTES

C<PayProp::API::Public::Client::Request::Export::Beneficiaries> implements the following attributes.

url

An abstraction of the API endpoint receiving the request(s). It is dependant on the API_DOMAIN.com given.

METHODS

list_p(\%query_params)

Issues a C<HTTP GET> request to PayProp API C</export/beneficiaries> endpoint. It takes an optional hashref of query parameters.
See L</"QUERY PARAMETERS"> for a list of available parameters.

$beneficiaries_export
	->list_p({...})
	->then( sub {
		my ( \@beneficiaries ) = @_;
		...;

		See L<PayProp::API::Public::Client::Response::Export::Beneficiary>.
	} )
	->wait
;

QUERY PARAMETERS

rows

B<integer>
Restrict rows returned.

$beneficiaries_export
	->list_p({ rows => 1 })
	->then( sub {
		my ( \@beneficiaries ) = @_;
		...;

		See L<PayProp::API::Public::Client::Response::Export::Beneficiary>.
	} )
	->wait
;

page

B<integer>
Return given page number.

$beneficiaries_export
	->list_p({ page => 1 })
	->then( sub {
		my ( \@beneficiaries ) = @_;
		...;

		See L<PayProp::API::Public::Client::Response::Export::Beneficiary>.
	} )
	->wait
;

owners

B<boolean>
Return only Beneficiaries that are owners.

$beneficiaries_export
	->list_p({ owners => true })
	->then( sub {
		my ( \@beneficiaries ) = @_;
		...;

		See L<PayProp::API::Public::Client::Response::Export::Beneficiary>.
	} )
	->wait
;

search_by

B<Array of string>
Items Enum: C<business_name>, C<first_name>, C<last_name>, C<email_address>

To be used with L</"search_value">.

$beneficiaries_export
	->list_p(
		{
			search_by => ['first_name', 'business_name'],
			search_value => 'Mike',
		}
	)
	->then( sub {
		my ( \@beneficiaries ) = @_;
		...;

		See L<PayProp::API::Public::Client::Response::Export::Beneficiary>.
	} )
	->wait
;

search_value

B<string> C<[3..50] characters>
To be used with L</"search_by">.

$beneficiaries_export
	->list_p(
		{
			search_by => [...],
			search_value => 'Mike',
		}
	)
	->then( sub {
		my ( \@beneficiaries ) = @_;
		...;

		See L<PayProp::API::Public::Client::Response::Export::Beneficiary>.
	} )
	->wait
;

external_id

B<string> C<<= 32 characters>
External ID of beneficiary.

$beneficiaries_export
	->list_p({ external_id => 'ABCD1234' })
	->then( sub {
		my ( \@beneficiaries ) = @_;
		...;

		See L<PayProp::API::Public::Client::Response::Export::Beneficiary>.
	} )
	->wait
;

bank_account_number

B<string> C<<= 32 characters /^[a-zA-Z0-9]+$/>
Filter beneficiaries by bank account number.

$beneficiaries_export
	->list_p({ bank_account_number => 'ab123' })
	->then( sub {
		my ( \@beneficiaries ) = @_;
		...;

		See L<PayProp::API::Public::Client::Response::Export::Beneficiary>.
	} )
	->wait
;

bank_branch_code

B<string> C<<= 32 characters /^[a-zA-Z0-9]+$/>
Filter beneficiaries by bank branch code.

$beneficiaries_export
	->list_p({ bank_branch_code => 'ab123' })
	->then( sub {
		my ( \@beneficiaries ) = @_;
		...;

		See L<PayProp::API::Public::Client::Response::Export::Beneficiary>.
	} )
	->wait
;

is_archived

B<boolean>
Return only beneficiaries that have been archived. Defaults to C<false>.

$beneficiaries_export
	->list_p({ is_archived => true })
	->then( sub {
		my ( \@beneficiaries ) = @_;
		...;

		See L<PayProp::API::Public::Client::Response::Export::Beneficiary>.
	} )
	->wait
;

customer_id

B<string> C<<= 50 characters>
Lookup entities based on C<customer_id>.

$beneficiaries_export
	->list_p({ customer_id => 'ABC123' })
	->then( sub {
		my ( \@beneficiaries ) = @_;
		...;

		See L<PayProp::API::Public::Client::Response::Export::Beneficiary>.
	} )
	->wait
;

customer_reference

B<string> C<<= 50 characters>
Customer reference of beneficiary.

$beneficiaries_export
	->list_p({ customer_reference => 'ABC123' })
	->then( sub {
		my ( \@beneficiaries ) = @_;
		...;

		See L<PayProp::API::Public::Client::Response::Export::Beneficiary>.
	} )
	->wait
;

AUTHOR

Yanga Kandeni E<lt>yangak@cpan.orgE<gt>

Valters Skrupskis E<lt>malishew@cpan.orgE<gt>

COPYRIGHT

Copyright 2023- PayProp

LICENSE

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
or file a bug report then please raise an issue / pull request:

L<https://github.com/Humanstate/api-client-public-module>

cpanm PayProp::API::Public::Client

perl -MCPAN -e shell
install PayProp::API::Public::Client